PresenceAbsenceTerms added

[cdmlib.git] / cdmlib-model / src / main / java / eu / etaxonomy / cdm / model / description / State.java

diff --git a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/State.java b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/State.java
index 58867da42995de016b4abcc9c5900afae8130bd8..8688ba78ea25957b8652855d7743d358f2bd57c9 100644 (file)
--- a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/State.java
+++ b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/State.java
@@ -10,15 +10,20 @@
 package eu.etaxonomy.cdm.model.description;
 
 
+import eu.etaxonomy.cdm.model.common.Language;
 import eu.etaxonomy.cdm.model.common.OrderedTermBase;
-import eu.etaxonomy.cdm.model.common.TermVocabulary;
+import eu.etaxonomy.cdm.model.location.NamedArea;
+import eu.etaxonomy.cdm.model.taxon.Taxon;
 
 import org.apache.log4j.Logger;
 
-import java.util.*;
 import javax.persistence.*;
 
 /**
+ * This class represents terms describing different states (like "oval" or
+ * "triangular") for {@link Feature features} that can be described with
+ * categorical values (like for instance shapes).
+ * 
  * @author m.doering
  * @version 1.0
  * @created 08-Nov-2007 13:06:53
@@ -27,29 +32,55 @@ import javax.persistence.*;
 public class State extends OrderedTermBase<State> {
        static Logger logger = Logger.getLogger(State.class);
 
-       /**
-        * Factory method
-        * @return
+       // ************* CONSTRUCTORS *************/    
+       /** 
+        * Class constructor: creates a new empty state.
+        * 
+        * @see #State(String, String, String)
+        */
+       public State() {
+               super();
+       }
+
+       /** 
+        * Class constructor: creates a new state with a description (in the {@link Language#DEFAULT() default language}),
+        * a label and a label abbreviation.
+        * 
+        * @param       term             the string (in the default language) describing the
+        *                                               new state to be created 
+        * @param       label            the string identifying the new state to be created
+        * @param       labelAbbrev  the string identifying (in abbreviated form) the
+        *                                               new state to be created
+        * @see                                  #State()
+        */
+       public State(String term, String label, String labelAbbrev) {
+               super(term, label, labelAbbrev);
+       }
+       
+       //********* METHODS **************************************/
+       /** 
+        * Creates a new empty state.
+        * 
+        * @see #NewInstance(String, String, String)
         */
        public static State NewInstance(){
                return new State();
        }
        
-       /**
-        * Factory method
-        * @return
+       /** 
+        * Creates a new state with a description (in the {@link Language#DEFAULT() default language}),
+        * a label and a label abbreviation.
+        * 
+        * @param       term             the string (in the default language) describing the
+        *                                               new state to be created 
+        * @param       label            the string identifying the new state to be created
+        * @param       labelAbbrev  the string identifying (in abbreviated form) the
+        *                                               new state to be created
+        * @see                                  #NewInstance()
         */
        public static State NewInstance(String term, String label, String labelAbbrev){
                return new State(term, label, labelAbbrev);
        }
        
-       public State() {
-               super();
-       }
-
-       public State(String term, String label, String labelAbbrev) {
-               super(term, label, labelAbbrev);
-       }
-       
 
 }
\ No newline at end of file