performed javacscript:fix and worked on documentation

[taxeditor.git] / taxeditor-editor / src / main / java / eu / etaxonomy / taxeditor / editor / name / ContainerFactory.java

diff --git a/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/editor/name/ContainerFactory.java b/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/editor/name/ContainerFactory.java
index 72d58d3f1a7cc2c080a73e0ae3e76a15f15a7e04..33779a7e046afdd2cfc97a2d2bc76ce4ebe33ed6 100644 (file)
--- a/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/editor/name/ContainerFactory.java
+++ b/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/editor/name/ContainerFactory.java
@@ -9,8 +9,6 @@ import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
-import org.apache.log4j.Logger;
-
 import eu.etaxonomy.cdm.hibernate.HibernateProxyHelper;
 import eu.etaxonomy.cdm.model.name.HomotypicalGroup;
 import eu.etaxonomy.cdm.model.taxon.Synonym;
@@ -20,26 +18,40 @@ import eu.etaxonomy.cdm.model.taxon.TaxonRelationship;
 import eu.etaxonomy.cdm.model.taxon.TaxonRelationshipType;
 
 /**
- * @author n.hoffmann
+ * <p>ContainerFactory class.</p>
  *
+ * @author n.hoffmann
+ * @version $Id: $
  */
 public class ContainerFactory {
        
-       private static final Logger logger = Logger.getLogger(ContainerFactory.class);
-
+       /** Constant <code>ACCEPTED=1</code> */
        public static final int ACCEPTED = 1;
+       /** Constant <code>SYNONYM=2</code> */
        public static final int SYNONYM = 2;
+       /** Constant <code>MISAPPLICATION=3</code> */
        public static final int MISAPPLICATION = 3;
+       /** Constant <code>CONCEPT=4</code> */
        public static final int CONCEPT = 4;
        
        private static ContainerFactory instance = new ContainerFactory();
        
        private ContainerFactory(){}
        
+       /**
+        * <p>Getter for the field <code>instance</code>.</p>
+        *
+        * @return a {@link eu.etaxonomy.taxeditor.editor.name.ContainerFactory} object.
+        */
        public static synchronized ContainerFactory getInstance(){
                return instance;
        }
 
+       /**
+        * <p>createAcceptedTaxonsHomotypicGroup</p>
+        *
+        * @param taxonNameEditor a {@link eu.etaxonomy.taxeditor.editor.name.TaxonNameEditor} object.
+        */
        public void createAcceptedTaxonsHomotypicGroup(TaxonNameEditor taxonNameEditor) {
                Taxon taxon = taxonNameEditor.getTaxon();
                                
@@ -72,6 +84,11 @@ public class ContainerFactory {
                }
        }
 
+       /**
+        * <p>createHeterotypicSynonymGroups</p>
+        *
+        * @param taxonNameEditor a {@link eu.etaxonomy.taxeditor.editor.name.TaxonNameEditor} object.
+        */
        public void createHeterotypicSynonymGroups(TaxonNameEditor taxonNameEditor) {
                Taxon taxon = taxonNameEditor.getTaxon();
                
@@ -104,6 +121,11 @@ public class ContainerFactory {
                }
        }
        
+       /**
+        * <p>createMisapplicationGroup</p>
+        *
+        * @param taxonNameEditor a {@link eu.etaxonomy.taxeditor.editor.name.TaxonNameEditor} object.
+        */
        public void createMisapplicationGroup(TaxonNameEditor taxonNameEditor) {
                Taxon taxon = taxonNameEditor.getTaxon();
                
@@ -118,6 +140,11 @@ public class ContainerFactory {
                }
        }
        
+       /**
+        * <p>createConceptGroup</p>
+        *
+        * @param taxonNameEditor a {@link eu.etaxonomy.taxeditor.editor.name.TaxonNameEditor} object.
+        */
        public void createConceptGroup(TaxonNameEditor taxonNameEditor) {
                Taxon taxon = taxonNameEditor.getTaxon();
                
@@ -149,6 +176,13 @@ public class ContainerFactory {
        }
        
        
+       /**
+        * <p>fillGroup</p>
+        *
+        * @param group a {@link eu.etaxonomy.taxeditor.editor.name.AbstractGroup} object.
+        * @param content a {@link java.util.List} object.
+        * @param mode a int.
+        */
        public void fillGroup(AbstractGroup group, List<? extends TaxonBase> content, int mode){
                if(content == null || (mode != ACCEPTED && content.size() == 0)){
                        return;
@@ -188,6 +222,14 @@ public class ContainerFactory {
                }
        }
        
+       /**
+        * <p>createContainerFactoryMethod</p>
+        *
+        * @param mode a int.
+        * @param group a {@link eu.etaxonomy.taxeditor.editor.name.AbstractGroup} object.
+        * @param taxonBase a {@link eu.etaxonomy.cdm.model.taxon.TaxonBase} object.
+        * @return a {@link eu.etaxonomy.taxeditor.editor.name.AbstractGroupedContainer} object.
+        */
        public AbstractGroupedContainer createContainerFactoryMethod(int mode, AbstractGroup group, TaxonBase taxonBase){
                switch(mode){
                case ACCEPTED:
@@ -202,6 +244,12 @@ public class ContainerFactory {
                return null;
        }
        
+       /**
+        * <p>createHeterotypicSynonymGroup</p>
+        *
+        * @param taxonNameEditor a {@link eu.etaxonomy.taxeditor.editor.name.TaxonNameEditor} object.
+        * @param group a {@link eu.etaxonomy.taxeditor.editor.name.HomotypicalSynonymGroup} object.
+        */
        public void createHeterotypicSynonymGroup(TaxonNameEditor taxonNameEditor, HomotypicalSynonymGroup group) {
                Taxon taxon = taxonNameEditor.getTaxon();
                
@@ -212,10 +260,6 @@ public class ContainerFactory {
                fillGroup(group, heterotypicSynonyms, SYNONYM);
        }
        
-       /**********************************************************************************/
-       
-       
-
        
        private MisappliedGroup getMisappliedGroup(TaxonNameEditor editor) {
                if(editor.getMisappliedGroup() == null){
@@ -250,8 +294,4 @@ public class ContainerFactory {
                return conceptGroup;
 
        }
-
-
-
-
 }