updated java doc for reference interfaces

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

diff --git a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/reference/SectionBase.java b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/reference/SectionBase.java
index 5594eab67938c869c8a7e3e8f11f6b479740a90c..ed0c03003bb63fbb631f8487fe279425fe6d3099 100644 (file)
--- a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/reference/SectionBase.java
+++ b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/reference/SectionBase.java
@@ -11,9 +11,16 @@ package eu.etaxonomy.cdm.model.reference;
 
 
 import javax.persistence.Entity;
-import javax.persistence.Transient;
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+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.Indexed;
+
+import eu.etaxonomy.cdm.strategy.cache.reference.IReferenceBaseCacheStrategy;
 
 /**
  * This (abstract) class represents isolated sections (parts, chapters or
@@ -26,10 +33,23 @@ import org.apache.log4j.Logger;
  * @version 1.0
  * @created 08-Nov-2007 13:06:51
  */
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "SectionBase", propOrder = {
+//    "pages"
+})
+@XmlRootElement(name = "SectionBase")
 @Entity
-public abstract class SectionBase extends StrictReferenceBase {
-       static Logger logger = Logger.getLogger(SectionBase.class);
-       private String pages;
+@Indexed(index = "eu.etaxonomy.cdm.model.reference.ReferenceBase")
+@Audited
+@Deprecated
+public abstract class SectionBase<S extends IReferenceBaseCacheStrategy> extends ReferenceBase<S> {
+       private static final long serialVersionUID = -2430228069266443975L;
+       @SuppressWarnings("unused")
+       private static final Logger logger = Logger.getLogger(SectionBase.class);
+       
+//     @XmlElement(name = "Pages")
+//     @Field(index=Index.TOKENIZED)
+//     private String pages;
 
        /**
         * Returns the string representing the page(s) where the content of
@@ -48,21 +68,10 @@ public abstract class SectionBase extends StrictReferenceBase {
                this.pages = pages;
        }
 
-       /**
-        * Returns the {@link PrintedUnitBase printed unit} to which <i>this</i> section
-        * belongs.
-        * 
-        * @return  the printed unit containing <i>this</i> section
-        */
-       @Transient
-       public PrintedUnitBase getPrintedUnit(){
-               logger.warn("Not yet implemented");
-               return null;
-       }
 
-//*********** CLONE **********************************/        
        
 
+
        /** 
         * Clones <i>this</i> section. This is a shortcut that enables to
         * create a new instance that differs only slightly from <i>this</i> section
@@ -70,7 +79,7 @@ public abstract class SectionBase extends StrictReferenceBase {
         * This method overrides the clone method from {@link StrictReferenceBase StrictReferenceBase}.
         * 
         * @see StrictReferenceBase#clone()
-        * @see eu.etaxonomy.cdm.model.media.IdentifyableMediaEntity#clone()
+        * @see eu.etaxonomy.cdm.model.media.IdentifiableMediaEntity#clone()
         * @see java.lang.Object#clone()
         */
        @Override