StrictReferenceBase matchable

[cdmlib.git] / cdmlib-model / src / main / java / eu / etaxonomy / cdm / model / reference / PrintSeries.java

diff --git a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/reference/PrintSeries.java b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/reference/PrintSeries.java
index e38e5082c5e6122b0ed9f51b71917d3cc9d76fea..9a5a460ce5ed38abefa2169faabe5ef4cf4ee84c 100644 (file)
--- a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/reference/PrintSeries.java
+++ b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/reference/PrintSeries.java
@@ -11,10 +11,22 @@ package eu.etaxonomy.cdm.model.reference;
 
 
 import javax.persistence.Entity;
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+import javax.xml.bind.annotation.XmlType;
 
 import org.apache.log4j.Logger;
+import org.hibernate.envers.Audited;
+import org.hibernate.search.annotations.Field;
+import org.hibernate.search.annotations.Index;
+import org.hibernate.search.annotations.Indexed;
+import org.springframework.beans.factory.annotation.Configurable;
+
+import eu.etaxonomy.cdm.strategy.cache.reference.IReferenceBaseCacheStrategy;
+import eu.etaxonomy.cdm.strategy.cache.reference.StrictReferenceBaseDefaultCacheStrategy;
 
-/**
 /**
  * This class represents collections of {@link PrintedUnitBase printed published references} which
  * are grouped according to topic or any other feature. 
@@ -26,43 +38,70 @@ import org.apache.log4j.Logger;
  * @version 1.0
  * @created 08-Nov-2007 13:06:45
  */
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "PrintSeries", propOrder = {
+    "series"
+})
+@XmlRootElement(name = "PrintSeries")
 @Entity
-public class PrintSeries extends PublicationBase implements Cloneable {
+@Indexed(index = "eu.etaxonomy.cdm.model.reference.ReferenceBase")
+@Audited
+@Configurable
+public class PrintSeries extends PublicationBase<IReferenceBaseCacheStrategy<PrintSeries>> implements Cloneable {
        private static final Logger logger = Logger.getLogger(PrintSeries.class);
+       
+       @XmlElement(name = "Series")
+       @Field(index=Index.TOKENIZED)
        private String series;
 
+       protected PrintSeries() {
+               this.cacheStrategy = new StrictReferenceBaseDefaultCacheStrategy<PrintSeries>();
+       }
+       
+       /** 
+        * Creates a new empty print series instance.
+        */
        public static PrintSeries NewInstance(){
                PrintSeries result = new PrintSeries();
                return result;
        }
        
+       /** 
+        * Creates a new print series instance with a given title string.
+        */
        public static PrintSeries NewInstance(String series){
                PrintSeries result = NewInstance();
                result.setSeries(series);
                return result;
        }
        
+       /**
+        * Returns the string representing the title of <i>this</i> print series.
+        * 
+        * @return  the string representing the print series
+        */
        public String getSeries(){
                return this.series;
        }
 
        /**
-        * 
-        * @param series    series
+        * @see #getSeries()
         */
        public void setSeries(String series){
                this.series = series;
        }
-
-       @Override
-       public String generateTitle(){
-               return "";
-       }
        
 //*********** CLONE **********************************/        
        
-       /* (non-Javadoc)
-        * @see eu.etaxonomy.cdm.model.reference.PublicationBase#clone()
+       /** 
+        * Clones <i>this</i> print series instance. This is a shortcut that enables to
+        * create a new instance that differs only slightly from <i>this</i>
+        * print series instance by modifying only some of the attributes.<BR>
+        * This method overrides the clone method from {@link PublicationBase PublicationBase}.
+        * 
+        * @see PublicationBase#clone()
+        * @see eu.etaxonomy.cdm.model.media.IdentifiableMediaEntity#clone()
+        * @see java.lang.Object#clone()
         */
        @Override
        public PrintSeries clone(){