merge-update from trunk
[taxeditor.git] / eu.etaxonomy.taxeditor.store / src / main / java / eu / etaxonomy / taxeditor / ui / section / name / NameDetailElement.java
index 0823179168a970ab6730312e3395cedf664c5f46..99279ca673424483300ab7b6b82eba28cbc0aae0 100644 (file)
@@ -1,9 +1,9 @@
 // $Id$
 /**
 * Copyright (C) 2007 EDIT
-* European Distributed Institute of Taxonomy 
+* European Distributed Institute of Taxonomy
 * http://www.e-taxonomy.eu
-* 
+*
 * The contents of this file are subject to the Mozilla Public License Version 1.1
 * See LICENSE.TXT at the top of this package for the full license terms.
 */
@@ -12,24 +12,25 @@ package eu.etaxonomy.taxeditor.ui.section.name;
 
 import java.util.Arrays;
 
+import org.apache.log4j.Logger;
 import org.eclipse.swt.SWT;
 
 import eu.etaxonomy.cdm.model.name.BotanicalName;
+import eu.etaxonomy.cdm.model.name.NomenclaturalCode;
 import eu.etaxonomy.cdm.model.name.NonViralName;
 import eu.etaxonomy.cdm.model.name.Rank;
 import eu.etaxonomy.cdm.model.name.ZoologicalName;
 import eu.etaxonomy.cdm.strategy.parser.ParserProblem;
-import eu.etaxonomy.taxeditor.ui.forms.CdmFormFactory;
-import eu.etaxonomy.taxeditor.ui.forms.CdmFormFactory.TermComboType;
-import eu.etaxonomy.taxeditor.ui.forms.CheckboxElement;
-import eu.etaxonomy.taxeditor.ui.forms.ICdmFormElement;
-import eu.etaxonomy.taxeditor.ui.forms.IEnableableFormElement;
-import eu.etaxonomy.taxeditor.ui.forms.ISelectableElement;
-import eu.etaxonomy.taxeditor.ui.forms.NumberWithLabelElement;
-import eu.etaxonomy.taxeditor.ui.forms.SelectionArbitrator;
-import eu.etaxonomy.taxeditor.ui.forms.TextWithLabelElement;
+import eu.etaxonomy.taxeditor.ui.campanula.compatibility.ICdmFormElement;
+import eu.etaxonomy.taxeditor.ui.combo.TermComboElement;
+import eu.etaxonomy.taxeditor.ui.element.CdmFormFactory;
+import eu.etaxonomy.taxeditor.ui.element.CheckboxElement;
+import eu.etaxonomy.taxeditor.ui.element.IEnableableFormElement;
+import eu.etaxonomy.taxeditor.ui.element.ISelectableElement;
+import eu.etaxonomy.taxeditor.ui.element.NumberWithLabelElement;
+import eu.etaxonomy.taxeditor.ui.element.SelectionArbitrator;
+import eu.etaxonomy.taxeditor.ui.element.TextWithLabelElement;
 import eu.etaxonomy.taxeditor.ui.section.AbstractIdentifiableEntityDetailElement;
-import eu.etaxonomy.taxeditor.ui.term.AbstractTermComboElement;
 
 /**
  * <p>NameDetailElement class.</p>
@@ -40,7 +41,9 @@ import eu.etaxonomy.taxeditor.ui.term.AbstractTermComboElement;
  */
 public class NameDetailElement extends AbstractIdentifiableEntityDetailElement<NonViralName> implements ISelectableElement, IEnableableFormElement{
 
-       private AbstractTermComboElement<Rank> combo_rank;
+    private final Logger logger = Logger.getLogger(NameDetailElement.class);
+
+       private TermComboElement<Rank> combo_rank;
        private TextWithLabelElement text_appendedPhrase;
        private TextWithLabelElement text_uninomial;
        private TextWithLabelElement text_infragenericEpithet;
@@ -52,12 +55,12 @@ public class NameDetailElement extends AbstractIdentifiableEntityDetailElement<N
        private NumberWithLabelElement text_publicationYear;
        private NumberWithLabelElement text_originalPublicationYear;
        private int cursorPosition;
-       
+
        /**
         * <p>Constructor for NameDetailElement.</p>
         *
-        * @param cdmFormFactory a {@link eu.etaxonomy.taxeditor.ui.forms.CdmFormFactory} object.
-        * @param formElement a {@link eu.etaxonomy.taxeditor.ui.forms.ICdmFormElement} object.
+        * @param cdmFormFactory a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory} object.
+        * @param formElement a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement} object.
         * @param style a int.
         */
        public NameDetailElement(CdmFormFactory cdmFormFactory, ICdmFormElement formElement,
@@ -72,20 +75,20 @@ public class NameDetailElement extends AbstractIdentifiableEntityDetailElement<N
        /** {@inheritDoc} */
        @Override
        protected void createControls(ICdmFormElement formElement, NonViralName nonViralName, int style) {
-               
+
                toggleable_cache = formFactory.createToggleableTextField(this, "Name Cache", nonViralName.getNameCache(), nonViralName.isProtectedNameCache(), style);
-               
-               combo_rank = formFactory.createTermComboElement(TermComboType.RANK, this, "Rank", nonViralName.getRank(), style);
+
+               combo_rank = formFactory.createTermComboElement(Rank.class, this, "Rank", nonViralName.getRank(), style);
 
                createGenusOrUninomialControls(this, nonViralName, style);
                createInfragenerericEpithetControls(this, nonViralName, style);
                createSpecificEpithetControls(this, nonViralName, style);
                createInfraSpecificEpithetControls(this, nonViralName, style);
-               
+
                createSpecificNameParts(this, nonViralName, style);
-               
+
                text_appendedPhrase = formFactory.createTextWithLabelElement(formElement, "Appended Phrase", nonViralName.getAppendedPhrase(), style);
-               
+
        }
 
        /**
@@ -94,22 +97,22 @@ public class NameDetailElement extends AbstractIdentifiableEntityDetailElement<N
        protected void clearCheckRankWarnings() {
                if(getEntity().hasProblem(ParserProblem.CheckRank)){
                        getEntity().removeParsingProblem(ParserProblem.CheckRank);
-                       
+
                        // FIXME this has to be reafctored completely. See tickets #1959, #1663, #1957, #1958
 //                     TaxonNameEditor nameEditor = (TaxonNameEditor) EditorUtil.getActiveEditorPage(Page.NAME);
 //                     nameEditor.getSelectedContainer().getNameViewer().clearErrors();
                }
        }
-       
+
        /** {@inheritDoc} */
        @Override
        protected void updateContent() {
                if(getEntity() == null){
                        setEntity(NonViralName.NewInstance(null));
                }
-               
+
                super.updateContent();
-               
+
                if(isIrrelevant()){
                        setIrrelevant(isIrrelevant());
                }else{
@@ -120,16 +123,31 @@ public class NameDetailElement extends AbstractIdentifiableEntityDetailElement<N
 
        private void createSpecificNameParts(ICdmFormElement formElement,
                        NonViralName nonViralName, int style) {
-               switch(nonViralName.getNomenclaturalCode()){
-               case ICBN:
-                       createBotanicalNameParts(formElement, nonViralName, style);
-                       break;
-               case ICZN:
-                       createZoologicalNameParts(formElement, nonViralName, style);
-                       break;
+               NomenclaturalCode code = nonViralName.getNomenclaturalCode();
+               if (code != null){
+                       switch(nonViralName.getNomenclaturalCode()){
+                       case ICNAFP :
+                               createBotanicalNameParts(formElement, nonViralName, style);
+                               break;
+                       case ICZN:
+                               createZoologicalNameParts(formElement, nonViralName, style);
+                               break;
+            case ICVCN:
+                //TODO implement
+                logger.warn("ICVCN not yet implemented");
+                break;
+            case ICNB:
+                //TODO implement
+                logger.warn("ICNB not yet implemented");
+                break;
+            case ICNCP:
+                //TODO implement
+                logger.warn("ICNCP not yet implemented");
+                break;
+            }
                }
        }
-       
+
        private void createBotanicalNameParts(ICdmFormElement formElement, NonViralName nonViralName, int style){
                BotanicalName botanicalName = (BotanicalName) nonViralName;
                checkbox_anamorphic = formFactory.createCheckbox(formElement, "Anamorphic", botanicalName.isAnamorphic(), style);
@@ -138,51 +156,56 @@ public class NameDetailElement extends AbstractIdentifiableEntityDetailElement<N
        private void createZoologicalNameParts(ICdmFormElement formElement, NonViralName nonViralName, int style){
                ZoologicalName zoologicalName = (ZoologicalName) nonViralName;
                text_breed = formFactory.createTextWithLabelElement(formElement, "Breed", zoologicalName.getBreed(), style);
-               text_publicationYear = formFactory.createIntegerTextWithLabelElement(formElement, "Publication Year", zoologicalName.getPublicationYear(), style);
-               text_originalPublicationYear = formFactory.createIntegerTextWithLabelElement(formElement, "Orig. Publication Year", zoologicalName.getOriginalPublicationYear(), style);
+               text_publicationYear = formFactory.createNumberTextWithLabelElement(formElement, "Publication Year", zoologicalName.getPublicationYear(), style);
+               text_originalPublicationYear = formFactory.createNumberTextWithLabelElement(formElement, "Orig. Publication Year", zoologicalName.getOriginalPublicationYear(), style);
        }
-       
-       private void createGenusOrUninomialControls(ICdmFormElement element, NonViralName nonViralName, int style){             
+
+       private void createGenusOrUninomialControls(ICdmFormElement element, NonViralName nonViralName, int style){
                String title = "Genus";
                Rank rank = nonViralName.getRank();
                if(rank != null && rank.isSupraGeneric()){
-                       title = "Uninomial";                    
+                       title = "Uninomial";
                }
                text_uninomial = formFactory.createTextWithLabelElement(element, title, nonViralName.getGenusOrUninomial(), style);
        }
-       
+
        private void createInfragenerericEpithetControls(ICdmFormElement element, NonViralName nonViralName, int style){
                if(nonViralName.getRank() != null && nonViralName.getRank().isInfraGeneric() && !nonViralName.getRank().isSpeciesAggregate()){
                        text_infragenericEpithet = formFactory.createTextWithLabelElement(element, "Infrageneric Epithet", nonViralName.getInfraGenericEpithet(), style);
                }
        }
-       
+
        private void createSpecificEpithetControls(ICdmFormElement element, NonViralName nonViralName, int style){
                if(nonViralName.getRank() != null && (nonViralName.getRank().isSpecies()  || nonViralName.getRank().isInfraSpecific() || nonViralName.getRank().isSpeciesAggregate())){
                        text_specificEpithet = formFactory.createTextWithLabelElement(element, "Specific Epithet", nonViralName.getSpecificEpithet(), SWT.NULL);
                }
        }
-       
+
        private void createInfraSpecificEpithetControls(ICdmFormElement element, NonViralName nonViralName, int style){
                if(nonViralName.getRank() != null && nonViralName.getRank().isInfraSpecific()){
                        text_infraspecificEpithet = formFactory.createTextWithLabelElement(element, "Infraspecific Epithet", nonViralName.getInfraSpecificEpithet(), SWT.NULL);
                }
        }
-       
+
        /** {@inheritDoc} */
        @Override
        public void handleEvent(Object eventSource){
-               if(eventSource == combo_rank){
+               if (eventSource == toggleable_cache) {
+                       getEntity().setNameCache(toggleable_cache.getText(),
+                                       toggleable_cache.getState());
+                       if (!isIrrelevant()) {
+                setIrrelevant(toggleable_cache.getState(),
+                                               Arrays.asList(new Object[] { toggleable_cache }));
+            }
+               }
+               else if(eventSource == combo_rank){
                        getEntity().setRank(combo_rank.getSelection());
                        clearCheckRankWarnings();
                        updateContent();
-               }               
+               }
                else if(eventSource == text_appendedPhrase){
                        getEntity().setAppendedPhrase(text_appendedPhrase.getText());
                }
-               else if(eventSource == toggleable_cache){
-                       handleToggleableCacheField();
-               }
                else if(eventSource == text_infragenericEpithet){
                        getEntity().setInfraGenericEpithet(text_infragenericEpithet.getText());
                }
@@ -194,12 +217,12 @@ public class NameDetailElement extends AbstractIdentifiableEntityDetailElement<N
                }
                else if(eventSource == text_uninomial){
                        getEntity().setGenusOrUninomial(text_uninomial.getText());
-               }               
+               }
                else if(eventSource == checkbox_anamorphic){
                        ((BotanicalName)getEntity()).setAnamorphic(checkbox_anamorphic.getSelection());
                }
        }
-               
+
        /*
         * (non-Javadoc)
         * @see eu.etaxonomy.taxeditor.forms.section.cdmdetail.ISelectableElement#getSelectionArbitrator()
@@ -207,12 +230,13 @@ public class NameDetailElement extends AbstractIdentifiableEntityDetailElement<N
        /**
         * <p>Getter for the field <code>selectionArbitrator</code>.</p>
         *
-        * @return a {@link eu.etaxonomy.taxeditor.ui.forms.SelectionArbitrator} object.
+        * @return a {@link eu.etaxonomy.taxeditor.ui.element.SelectionArbitrator} object.
         */
-       public SelectionArbitrator getSelectionArbitrator() {
+       @Override
+    public SelectionArbitrator getSelectionArbitrator() {
                return selectionArbitrator;
        }
-       
+
        @Override
        public void updateToggleableCacheField() {
                if(! getEntity().isProtectedNameCache()){