(no commit message)

diff --git a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/name/NonViralName.java b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/name/NonViralName.java
index d7e542d647328d6ce2daa7eae41f7b3b5d3619e3..0060071e920702b287e50072020e87b4be30887f 100644 (file)
--- a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/name/NonViralName.java
+++ b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/name/NonViralName.java
@@ -31,9 +31,10 @@ import eu.etaxonomy.cdm.strategy.cache.name.INonViralNameCacheStrategy;
 import eu.etaxonomy.cdm.strategy.cache.name.NonViralNameDefaultCacheStrategy;
 
 /**
- * The taxon name class for all non viral taxa. Parentetical authorship is derived
+ * The taxon name class for all non viral taxa. Parenthetical authorship is derived
  * from basionym relationship. The scientific name including author strings and
  * maybe year can be stored as a string in the inherited {@link common.IdentifiableEntity#getTitleCache() titleCache} attribute.
+ * The year itself is an information obtained from the {@link reference.INomenclaturalReference#getYear() nomenclatural reference}.
  * The scientific name string without author strings and year can be stored in the {@link #getNameCache() nameCache} attribute.
  * 
  * @author m.doering

diff --git a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/name/ZoologicalName.java b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/name/ZoologicalName.java
index c1f1b14604bc8ce631679bc6b38f3d2893d73d14..8fd8ebf290398503a04bd7886427009c59190edc 100644 (file)
--- a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/name/ZoologicalName.java
+++ b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/name/ZoologicalName.java
@@ -196,11 +196,11 @@ public class ZoologicalName extends NonViralName {
        
        
        /**
-        * Returns a zoological taxon name based on parsing a string composed of
-        * just one word (uninomial) and supposing that it is compliant to the ICZN.
+        * Returns a zoological taxon name based on parsing a string representing
+        * all elements (according to the ICZN) of a zoological taxon name in which
+        * the scientific name is an uninomial.
         * 
-        * @param       fullNameString  string representing the scientific name of a
-        *                                                      uninomial zoological taxon name 
+        * @param       fullNameString  the string to be parsed 
         * @return                                      the new zoological taxon name
         */
        public static ZoologicalName PARSED_NAME(String fullNameString){
@@ -208,9 +208,14 @@ public class ZoologicalName extends NonViralName {
        }
        
        /**
-        * Returns a parsed Name
-        * @param fullName
-        * @return
+        * Returns a zoological taxon name based on parsing a string representing
+        * all elements (according to the ICZN) of a zoological taxon name. The
+        * parsing result depends on the given rank of the zoological taxon name
+        * to be created.
+        * 
+        * @param       fullNameString  the string to be parsed 
+        * @param   rank                        the rank of the taxon name
+        * @return                                      the new zoological taxon name
         */
        public static ZoologicalName PARSED_NAME(String fullNameString, Rank rank){
                if (nameParser == null){
@@ -219,6 +224,16 @@ public class ZoologicalName extends NonViralName {
                return (ZoologicalName)nameParser.parseFullName(fullNameString, NomenclaturalCode.ICZN(), rank);
        }
        
+       /**
+        * Returns the {@link NomenclaturalCode nomenclatural code} that governs
+        * the construction of this zoological taxon name, that is the
+        * International Code of Zoological Nomenclature. This method overrides
+        * the getNomeclaturalCode method from {@link TaxonNameBase#getNomeclaturalCode() TaxonNameBase}.
+        *
+        * @return  the nomenclatural code for animals
+        * @see         NonViralName#isCodeCompliant()
+        * @see         TaxonNameBase#getHasProblem()
+        */
        @Transient
        @Override
        public NomenclaturalCode getNomenclaturalCode(){
@@ -227,23 +242,57 @@ public class ZoologicalName extends NonViralName {
        
 /* ***************** GETTER / SETTER ***************************/
        
+       /**
+        * Returns the breed name string for this animal (zoological taxon name).
+        * 
+        * @return  the string containing the breed name for this zoological taxon name
+        */
        public String getBreed(){
                return this.breed;
        }
+       /**
+        * @see  #getBreed()
+        */
        public void setBreed(String breed){
                this.breed = breed;
        }
 
+       /**
+        * Returns the publication year (as an integer) for this zoological taxon
+        * name. If this attribute is null and a nomenclatural reference exists
+        * the year might be computed from the {@link reference.INomenclaturalReference#getYear() nomenclatural reference}.
+        * 
+        * @return  the integer representing the publication year for this zoological taxon name
+        * @see         #getOriginalPublicationYear()
+        */
        public Integer getPublicationYear() {
                return publicationYear;
        }
+       /**
+        * @see  #getPublicationYear()
+        */
        public void setPublicationYear(Integer publicationYear) {
                this.publicationYear = publicationYear;
        }
 
+       /**
+        * Returns the publication year (as an integer) of the original validly
+        * published species epithet for this zoological taxon name. This only
+        * applies for zoological taxon names that are no {@link TaxonNameBase#isOriginalCombination() original combinations}.
+        * If the originalPublicationYear attribute is null the year might be taken
+        * from the publication year of the corresponding original name (basionym)
+        * or from the {@link reference.INomenclaturalReference#getYear() nomenclatural reference} of the basionym
+        * if it exists.
+        * 
+        * @return  the integer representing the publication year for this zoological taxon name
+        * @see         #getPublicationYear()
+        */
        public Integer getOriginalPublicationYear() {
                return originalPublicationYear;
        }
+       /**
+        * @see  #getOriginalPublicationYear()
+        */
        public void setOriginalPublicationYear(Integer originalPublicationYear) {
                this.originalPublicationYear = originalPublicationYear;
        }