performed javacscript:fix and worked on documentation

[taxeditor.git] / taxeditor-store / src / main / java / eu / etaxonomy / taxeditor / model / DescriptionHelper.java

diff --git a/taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/model/DescriptionHelper.java b/taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/model/DescriptionHelper.java
index 1f9312543d7b419681b345aba16d07cc44fbb4b6..4cbdd2abb8d5a7eec83a48c92b2954b56ee0a2db 100644 (file)
--- a/taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/model/DescriptionHelper.java
+++ b/taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/model/DescriptionHelper.java
@@ -47,6 +47,8 @@ import eu.etaxonomy.taxeditor.store.CdmStore;
 import eu.etaxonomy.taxeditor.store.StoreUtil;
 
 /**
+ * <p>DescriptionHelper class.</p>
+ *
  * @author p.ciardelli
  * @author n.hoffmann
  * @created 02.04.2009
@@ -57,10 +59,10 @@ public class DescriptionHelper {
        /**
         * Returns whatever the element's title cache equivalent is,
         * depending on its class.
-        * 
-        * @param element
-        * @param language
-        * @return 
+        *
+        * @param element a {@link eu.etaxonomy.cdm.model.description.DescriptionElementBase} object.
+        * @param language a {@link eu.etaxonomy.cdm.model.common.Language} object.
+        * @return a {@link java.lang.String} object.
         */
        public static String getCache(DescriptionElementBase element, 
                        Language language) {
@@ -101,9 +103,9 @@ public class DescriptionHelper {
        /**
         * Returns whatever the element's title cache equivalent is,
         * depending on its class, using the default language.
-        * 
-        * @param element
-        * @return 
+        *
+        * @param element a {@link eu.etaxonomy.cdm.model.description.DescriptionElementBase} object.
+        * @return a {@link java.lang.String} object.
         */
        public static String getCache(DescriptionElementBase element) {
                return getCache(element, CdmStore.getDefaultLanguage());
@@ -112,10 +114,10 @@ public class DescriptionHelper {
        /**
         * Set whatever the element's title cache equivalent is,
         * depending on its class.
-        * 
-        * @param element
-        * @param value
-        * @param language
+        *
+        * @param element a {@link eu.etaxonomy.cdm.model.description.DescriptionElementBase} object.
+        * @param value a {@link java.lang.String} object.
+        * @param language a {@link eu.etaxonomy.cdm.model.common.Language} object.
         */
        public static void setCache(DescriptionElementBase element,
                        String value, Language language) {
@@ -140,10 +142,10 @@ public class DescriptionHelper {
        /**
         * Set whatever the element's title cache equivalent is,
         * depending on its class, using the default language.
-        * 
-        * @param element
-        * @param value
-        */     
+        *
+        * @param element a {@link eu.etaxonomy.cdm.model.description.DescriptionElementBase} object.
+        * @param value a {@link java.lang.String} object.
+        */
        public static void setCache(DescriptionElementBase element,
                        String value) {
                setCache(element, value, CdmStore.getDefaultLanguage());
@@ -152,6 +154,12 @@ public class DescriptionHelper {
        /* (non-Javadoc)
         * @see eu.etaxonomy.taxeditor.bulkeditor.referencingobjects.IReferencingObjectsService#getObjectDescription(java.lang.Object)
         */
+       /**
+        * <p>getObjectDescription</p>
+        *
+        * @param element a {@link java.lang.Object} object.
+        * @return a {@link java.lang.String} object.
+        */
        public static String getObjectDescription(Object element) {
                if (element instanceof IdentifiableEntity) {
                        try{
@@ -196,20 +204,44 @@ public class DescriptionHelper {
                return element.toString();
        }
 
+       /**
+        * <p>getObjectClassname</p>
+        *
+        * @param element a {@link java.lang.Object} object.
+        * @return a {@link java.lang.String} object.
+        */
        public static String getObjectClassname(Object element) {
                return element.getClass().getSimpleName();
        }
        
+       /**
+        * <p>getFeatureNodeContainerText</p>
+        *
+        * @param element a {@link eu.etaxonomy.taxeditor.model.FeatureNodeContainer} object.
+        * @return a {@link java.lang.String} object.
+        */
        public static String getFeatureNodeContainerText(FeatureNodeContainer element) {
                return element.getFeatureNode().getFeature().getLabel(CdmStore.getDefaultLanguage());
        }
 
+       /**
+        * <p>getQuantitativeDataText</p>
+        *
+        * @param element a {@link eu.etaxonomy.cdm.model.description.QuantitativeData} object.
+        * @return a {@link java.lang.String} object.
+        */
        public static String getQuantitativeDataText(QuantitativeData element) {
                TextData textData = quantitativeDescriptionBuilder.build(element, getLanguageList());
                
                return textData.getText(CdmStore.getDefaultLanguage());
        }
 
+       /**
+        * <p>getCategoricalDataText</p>
+        *
+        * @param element a {@link eu.etaxonomy.cdm.model.description.CategoricalData} object.
+        * @return a {@link java.lang.String} object.
+        */
        public static String getCategoricalDataText(CategoricalData element) {
                TextData textData = categoricalDescriptionBuilder.build(element, getLanguageList());
                
@@ -225,8 +257,10 @@ public class DescriptionHelper {
        
 
        /**
-        * @param element
-        * @return
+        * <p>getDistributionText</p>
+        *
+        * @param element a {@link eu.etaxonomy.cdm.model.description.Distribution} object.
+        * @return a {@link java.lang.String} object.
         */
        public static String getDistributionText(Distribution element) {
                
@@ -259,8 +293,10 @@ public class DescriptionHelper {
        }
 
        /**
-        * @param entity
-        * @return
+        * <p>getImageText</p>
+        *
+        * @param media a {@link eu.etaxonomy.cdm.model.media.Media} object.
+        * @return a {@link java.lang.String} object.
         */
        public static  String getImageText(Media media) {
                 LanguageString title = media.getTitle(CdmStore.getDefaultLanguage());
@@ -273,8 +309,10 @@ public class DescriptionHelper {
        
        
        /**
-        * @param element
-        * @return
+        * <p>getElementText</p>
+        *
+        * @param element a {@link eu.etaxonomy.cdm.model.description.TextData} object.
+        * @return a {@link java.lang.String} object.
         */
        public static  String getElementText(TextData element) {        
                String text = null;
@@ -295,8 +333,10 @@ public class DescriptionHelper {
        }
        
        /**
-        * @param element
-        * @return
+        * <p>getTaxonInteractionText</p>
+        *
+        * @param element a {@link eu.etaxonomy.cdm.model.description.TaxonInteraction} object.
+        * @return a {@link java.lang.String} object.
         */
        public static  String getTaxonInteractionText(TaxonInteraction element) {
                String text = "";
@@ -311,8 +351,10 @@ public class DescriptionHelper {
        }
 
        /**
-        * @param entity
-        * @return
+        * <p>getCommonNameText</p>
+        *
+        * @param commonName a {@link eu.etaxonomy.cdm.model.description.CommonTaxonName} object.
+        * @return a {@link java.lang.String} object.
         */
        public static  String getCommonNameText(CommonTaxonName commonName) {
                String name = commonName.getName();
@@ -329,8 +371,10 @@ public class DescriptionHelper {
        }
 
        /**
-        * @param entity
-        * @return
+        * <p>getDescriptionText</p>
+        *
+        * @param element a {@link eu.etaxonomy.cdm.model.description.DescriptionBase} object.
+        * @return a {@link java.lang.String} object.
         */
        public static  String getDescriptionText(DescriptionBase element) {
                String text = element.getTitleCache();
@@ -341,9 +385,10 @@ public class DescriptionHelper {
        }
        
        /**
-        * 
-        * @param element
-        * @return
+        * <p>getIndividualsAssociationText</p>
+        *
+        * @param element a {@link eu.etaxonomy.cdm.model.description.IndividualsAssociation} object.
+        * @return a {@link java.lang.String} object.
         */
        public static  String getIndividualsAssociationText(IndividualsAssociation element) {
                SpecimenOrObservationBase derivedUnit = element.getAssociatedSpecimenOrObservation();
@@ -353,6 +398,12 @@ public class DescriptionHelper {
                return "No text provided";
        }
 
+       /**
+        * <p>getLabel</p>
+        *
+        * @param element a {@link java.lang.Object} object.
+        * @return a {@link java.lang.String} object.
+        */
        public static String getLabel(Object element){
                if (element instanceof FeatureNodeContainer){
                        return getFeatureNodeContainerText((FeatureNodeContainer) element);