AT: committing changes to the TaxEditor Post third round of code review

[taxeditor.git] / eu.etaxonomy.taxeditor.store / src / main / java / eu / etaxonomy / taxeditor / ui / section / userecords / UseRecordDetailElement.java

diff --git a/eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/section/userecords/UseRecordDetailElement.java b/eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/section/userecords/UseRecordDetailElement.java
index 8743932584237b34a6c4b925dd1de2d0ad881f55..bd90ae37165d8a5a80b503753223d7dee54aef13 100644 (file)
--- a/eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/section/userecords/UseRecordDetailElement.java
+++ b/eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/section/userecords/UseRecordDetailElement.java
@@ -1,5 +1,5 @@
 /**\r
-* Copyright (C) 2007 EDIT\r
+* Copyright (C) 2011 EDIT\r
 * European Distributed Institute of Taxonomy \r
 * http://www.e-taxonomy.eu\r
 * \r
@@ -32,7 +32,7 @@ import eu.etaxonomy.taxeditor.ui.element.CdmFormFactory;
 import eu.etaxonomy.taxeditor.ui.element.ICdmFormElement;\r
 import eu.etaxonomy.taxeditor.ui.section.AbstractCdmDetailElement;\r
 \r
-\r
+ \r
 /**\r
  * The context manager mediates context start/stop and workbench shutdowns to all registered listeners.\r
  *\r
@@ -111,6 +111,11 @@ public class UseRecordDetailElement extends
 \r
        }\r
 \r
+       /**\r
+        * Returns the select modifier\r
+        * @param comboCategory\r
+        * @return\r
+        */\r
        private Modifier modifierSelection(String comboCategory) {\r
                if(!getEntity().getModifiers().isEmpty()) {\r
                        for (Modifier modifier : getEntity().getModifiers()) {\r
@@ -125,6 +130,11 @@ public class UseRecordDetailElement extends
                \r
        }\r
        \r
+       /**\r
+        * Returns the selected state\r
+        * @param comboCategory\r
+        * @return\r
+        */\r
        private State stateSelection(String comboCategory) {\r
                if (!getEntity().getStates().isEmpty()) {\r
                        for (StateData statedata : getEntity().getStates()) {\r
@@ -145,6 +155,12 @@ public class UseRecordDetailElement extends
                \r
        }\r
        \r
+       /**\r
+        * This function sets the combo terms (Besides EthnicGroup\r
+        * @param listOfTerms\r
+        * @param modType\r
+        * @return\r
+        */\r
        private List<Modifier> setModifierComboTerms(List<Modifier> listOfTerms, String modType) {\r
                List<Modifier> termsToAdd = new ArrayList<Modifier>();\r
                for (Modifier term : listOfTerms) {\r
@@ -161,7 +177,11 @@ public class UseRecordDetailElement extends
        }\r
        \r
 \r
-\r
+       /**\r
+        * This function sets the Use Category combo term\r
+        * @param listOfTerms\r
+        * @return\r
+        */\r
        private List<State> setUseCategoryComboTerms(List<State> listOfTerms) {\r
                List<State> termsToAdd = new ArrayList<State>();\r
                for (State term : listOfTerms) {\r
@@ -177,6 +197,12 @@ public class UseRecordDetailElement extends
 \r
        }\r
 \r
+       /**\r
+        * This function sets the Use SubCategory combo term\r
+        * @param listOfTerms\r
+        * @param selectedUseCategory\r
+        * @return\r
+        */\r
        private List<State> setUseCategoryComboTerms(List<State> listOfTerms,\r
                        State selectedUseCategory) {\r
                List<State> termsToAdd = new ArrayList<State>();\r
@@ -217,6 +243,13 @@ public class UseRecordDetailElement extends
                return termsToAdd;\r
        }\r
        \r
+       \r
+       /**\r
+        * This function sets the EthnicGroup combo term\r
+        * @param listOfTerms\r
+        * @param selectedHumangroup\r
+        * @return\r
+        */\r
        private List<Modifier> setEthnicGroupComboTerms(List<Modifier> listOfTerms,\r
                        Modifier selectedHumangroup) {\r
                List<Modifier> termsToAdd = new ArrayList<Modifier>();\r
@@ -255,6 +288,7 @@ public class UseRecordDetailElement extends
                return termsToAdd;\r
        }\r
 \r
+       \r
        /** {@inheritDoc} */\r
        @Override\r
        public void handleEvent(Object eventSource) {\r
@@ -496,6 +530,12 @@ public class UseRecordDetailElement extends
        \r
        \r
 \r
+       /**\r
+        * This function Checks the vocabulary type\r
+        * @param term\r
+        * @param vocabularyExpected\r
+        * @return\r
+        */\r
        private boolean GetVocabularyType(Modifier term, String vocabularyExpected) {\r
                if ((term.getPartOf() != null)  && (term.getPartOf().getTitleCache().equals(vocabularyExpected))) {\r
                        return true;\r
@@ -517,6 +557,7 @@ public class UseRecordDetailElement extends
                super.setEntity(entity);\r
        }\r
 \r
+       /** {@inheritDoc} */\r
        @Override\r
        public void widgetSelected(SelectionEvent e) {\r
                Object eventSource = e.getSource();\r
@@ -562,6 +603,7 @@ public class UseRecordDetailElement extends
                }\r
        }\r
 \r
+       /** {@inheritDoc} */\r
        @Override\r
        public void widgetDefaultSelected(SelectionEvent e) {\r
                // TODO Auto-generated method stub\r