reintegrated model changes from branch 3.3-MC-SNAPSHOT
[taxeditor.git] / eu.etaxonomy.taxeditor.editor / src / main / java / eu / etaxonomy / taxeditor / editor / TaxonEditorInput.java
index 65403941dd6a7d7ba04c7f491a9fc887098e7607..6a295e64e9a9763f8d9f779ea4d814aab2523b6c 100644 (file)
@@ -1,8 +1,8 @@
 /**
 * 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.
 */
@@ -25,7 +25,7 @@ import eu.etaxonomy.cdm.api.service.ITaxonNodeService;
 import eu.etaxonomy.cdm.api.service.ITaxonService;
 import eu.etaxonomy.cdm.model.common.CdmBase;
 import eu.etaxonomy.cdm.model.name.TaxonNameBase;
-import eu.etaxonomy.cdm.model.taxon.ITreeNode;
+import eu.etaxonomy.cdm.model.taxon.ITaxonTreeNode;
 import eu.etaxonomy.cdm.model.taxon.Synonym;
 import eu.etaxonomy.cdm.model.taxon.Taxon;
 import eu.etaxonomy.cdm.model.taxon.TaxonBase;
@@ -37,6 +37,7 @@ import eu.etaxonomy.taxeditor.model.DataChangeBridge;
 import eu.etaxonomy.taxeditor.preference.PreferencesUtil;
 import eu.etaxonomy.taxeditor.store.CdmStore;
 
+
 /**
  * <p>TaxonEditorInput class.</p>
  *
@@ -47,20 +48,20 @@ import eu.etaxonomy.taxeditor.store.CdmStore;
 public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPersistableElement {
 
        private ConversationHolder conversation;
-       
+
        private TaxonNode taxonNode;
 
        private TaxonEditorInputDataChangeBehaviour dataChangeBehavior;
-       
+
        private TaxonBase initiallySelectedTaxonBase;
-       
+
        private TaxonEditorInput(TaxonNode taxonNode, ConversationHolder conversation){
                this.conversation = conversation;
                this.taxonNode = taxonNode;
        }
-       
 
-       
+
+
        /**
         * <p>NewInstance</p>
         *
@@ -76,26 +77,26 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
                        throw e;
                }
        }
-       
+
     /**
-     * 
+     *
      * @param taxonNodeUuid
      * @param conversation
      * @return
      */
     private static TaxonEditorInput NewInstance(UUID taxonNodeUuid, ConversationHolder conversation){
-       
-       
+
+
        TaxonNode taxonNode = CdmStore.getService(ITaxonNodeService.class).load(taxonNodeUuid, null);
-               
+
                if(taxonNode == null){
                        EditorUtil.warningDialog("Not yet implemented", TaxonEditorInput.class, "Selected element is not type TaxonBase.");
                        return null;
-               }       
-               
+               }
+
        return new TaxonEditorInput(taxonNode, conversation);
     }
-    
+
     /**
      * <p>NewInstanceFromTaxonBase</p>
      *
@@ -104,18 +105,20 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
      */
     public static TaxonEditorInput NewInstanceFromTaxonBase(UUID taxonBaseUuid){
        ConversationHolder conversation = CdmStore.createConversation();
-       
+
        TaxonEditorInput input = null;
-       
+
        TaxonBase taxonBase = CdmStore.getService(ITaxonService.class).find(taxonBaseUuid);
-       
-       if(taxonBase.isInstanceOf(Taxon.class)){
+       if(taxonBase.isOrphaned()) {
+               EditorUtil.warningDialog("Orphaned Taxon", TaxonEditorInput.class, "This is an orphaned taxon i.e. a taxon that is not connected to a classification and not having any taxonomic relationships. Editing of orphaned taxon is currently not supported.");
+       }
+       else if(taxonBase.isInstanceOf(Taxon.class)){
                Taxon taxon = CdmBase.deproxy(taxonBase, Taxon.class);
-               
+
                if (taxon.isMisapplication()){
                        // TODO get accepted taxon
                        EditorUtil.info("trying to open Mispplied Name ");
-                       
+
                        Set<Taxon> acceptedTaxa = new HashSet<Taxon>();
                        Set<TaxonRelationship> relations = taxon.getRelationsFromThisTaxon();
                        for(TaxonRelationship relation : relations){
@@ -124,22 +127,22 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
                                }
                        }
                        input =  getInputForMultipleTaxa(conversation, acceptedTaxa);
-                       
+
                }else{
                        input = getInputForMultipleNodes(conversation, taxon.getTaxonNodes());
                }
        }else if(taxonBase instanceof Synonym){
                Synonym synonym = (Synonym) taxonBase;
-               
+
                Set<Taxon> taxa = synonym.getAcceptedTaxa();
                input = getInputForMultipleTaxa(conversation, taxa);
        }
-       
+
        input.setInitiallySelectedTaxonBase(taxonBase);
-       
+
        return input;
     }
-    
+
        private static TaxonEditorInput getInputForMultipleNodes(ConversationHolder conversation, Set<TaxonNode> taxonNodes){
        if(taxonNodes.size() == 1){
                TaxonNode taxonNode = taxonNodes.iterator().next();
@@ -147,7 +150,7 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        }else if(taxonNodes.size() > 1){
                        TaxonNode taxonNode = ChooseFromMultipleTaxonNodesDialog.choose(taxonNodes);
                        if(taxonNode != null){
-                               return NewInstance(taxonNode.getUuid(), conversation);                  
+                               return NewInstance(taxonNode.getUuid(), conversation);
                        }
                }else if(taxonNodes.size() == 0){
                        // this is an undesired state
@@ -155,7 +158,7 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
                }
        return null;
     }
-    
+
     private static TaxonEditorInput getInputForMultipleTaxa(ConversationHolder conversation, Set<Taxon> taxa){
        if(taxa.size() == 1){
                Taxon taxon = taxa.iterator().next();
@@ -174,7 +177,7 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
                }
        return null;
     }
-    
+
     /**
      * <p>NewEmptyInstance</p>
      *
@@ -183,19 +186,19 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
      */
     public static TaxonEditorInput NewEmptyInstance(UUID parentNodeUuid){
        ConversationHolder conversation = CdmStore.createConversation();
-               
+
                TaxonNameBase<?, ?> name = PreferencesUtil.getPreferredNomenclaturalCode().getNewTaxonNameInstance(null);
-               ITreeNode parentNode = CdmStore.getService(IClassificationService.class).getTreeNodeByUuid(parentNodeUuid);
-               
+               ITaxonTreeNode parentNode = CdmStore.getService(IClassificationService.class).getTreeNodeByUuid(parentNodeUuid);
+
                Taxon newTaxon = Taxon.NewInstance(name, parentNode.getReference());
-               TaxonNode newTaxonNode = parentNode.addChildTaxon(newTaxon, parentNode.getReference(), parentNode.getMicroReference(), null);
-               
+               TaxonNode newTaxonNode = parentNode.addChildTaxon(newTaxon, parentNode.getReference(), parentNode.getMicroReference());
+
                // add the new taxon to the editors persistence context
                UUID newTaxonNodeUuid = CdmStore.getService(ITaxonNodeService.class).save(newTaxonNode);
-               
+
                return new TaxonEditorInput(newTaxonNode, conversation);
     }
-       
+
        /* (non-Javadoc)
         * @see org.eclipse.ui.IEditorInput#exists()
         */
@@ -204,7 +207,8 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
         *
         * @return a boolean.
         */
-       public boolean exists() {
+       @Override
+    public boolean exists() {
                return taxonNode != null;
        }
 
@@ -216,7 +220,8 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
         *
         * @return a {@link org.eclipse.jface.resource.ImageDescriptor} object.
         */
-       public ImageDescriptor getImageDescriptor() {
+       @Override
+    public ImageDescriptor getImageDescriptor() {
                return null;
        }
 
@@ -228,7 +233,8 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
         *
         * @return a {@link java.lang.String} object.
         */
-       public String getName() {
+       @Override
+    public String getName() {
                if(getTaxon() == null){
                        return null;
                }
@@ -237,7 +243,7 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
                        return "New taxon";
                } else {
                        return name.getTitleCache();
-               }       
+               }
        }
 
        /* (non-Javadoc)
@@ -248,7 +254,8 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
         *
         * @return a {@link org.eclipse.ui.IPersistableElement} object.
         */
-       public IPersistableElement getPersistable() {
+       @Override
+    public IPersistableElement getPersistable() {
 //             if(CdmStore.isActive()){
 //                     TaxonNode test = CdmStore.getTaxonTreeService().getTaxonNodeByUuid(taxonNode.getUuid());
 //                     boolean isPersistable = CdmStore.getTaxonTreeService().getTaxonNodeByUuid(taxonNode.getUuid()) != null;
@@ -267,7 +274,8 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
         *
         * @return a {@link java.lang.String} object.
         */
-       public String getToolTipText() {
+       @Override
+    public String getToolTipText() {
                return getName();
        }
 
@@ -275,27 +283,29 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
         * @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class)
         */
        /** {@inheritDoc} */
-       public Object getAdapter(Class adapter) {
+       @Override
+    public Object getAdapter(Class adapter) {
 
                if (adapter == Taxon.class) {
                        return taxonNode.getTaxon();
                }
-               
+
                if (adapter == TaxonNode.class) {
                        return taxonNode;
                }
-               
+
                return null;
        }
-       
+
        /**
         * {@inheritDoc}
         *
         * Overrides equals to ensure that a taxon can only be edited by
         * one editor at a time.
         */
-       public boolean equals(Object obj) {
-               if (TaxonEditorInput.class.equals(obj.getClass()) 
+       @Override
+    public boolean equals(Object obj) {
+               if (TaxonEditorInput.class.equals(obj.getClass())
                                && getTaxon() != null
                                && getTaxon().equals(((TaxonEditorInput) obj).getTaxon())){
                        if(((TaxonEditorInput) obj).getInitiallySelectedTaxonBase() != null){
@@ -314,7 +324,7 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        public Taxon getTaxon(){
                return taxonNode.getTaxon();
        }
-       
+
        /**
         * <p>Getter for the field <code>taxonNode</code>.</p>
         *
@@ -323,7 +333,7 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        public TaxonNode getTaxonNode() {
                return taxonNode;
        }
-       
+
        /*
         * (non-Javadoc)
         * @see eu.etaxonomy.cdm.api.conversation.IConversationEnabled#getConversationHolder()
@@ -333,7 +343,8 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
         *
         * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
         */
-       public ConversationHolder getConversationHolder() {
+       @Override
+    public ConversationHolder getConversationHolder() {
                return conversation;
        }
 
@@ -342,11 +353,12 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
         * @see eu.etaxonomy.cdm.persistence.hibernate.ICdmPostCrudObserver#update(eu.etaxonomy.cdm.persistence.hibernate.CdmCrudEvent)
         */
        /** {@inheritDoc} */
-       public void update(CdmDataChangeMap events) {
+       @Override
+    public void update(CdmDataChangeMap events) {
                if(dataChangeBehavior == null){
                        dataChangeBehavior = new TaxonEditorInputDataChangeBehaviour(this);
                }
-               
+
                DataChangeBridge.handleDataChange(events, dataChangeBehavior);
        }
 
@@ -358,7 +370,8 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
         *
         * @return a {@link java.lang.String} object.
         */
-       public String getFactoryId() {
+       @Override
+    public String getFactoryId() {
                return TaxonEditorInputFactory.getFactoryId();
        }
 
@@ -366,11 +379,12 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
         * @see org.eclipse.ui.IPersistable#saveState(org.eclipse.ui.IMemento)
         */
        /** {@inheritDoc} */
-       public void saveState(IMemento memento) {
+       @Override
+    public void saveState(IMemento memento) {
                TaxonEditorInputFactory.saveState(memento, this);
        }
 
-    
+
     /**
      * <p>Setter for the field <code>initiallySelectedTaxonBase</code>.</p>
      *
@@ -388,7 +402,7 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        public TaxonBase getInitiallySelectedTaxonBase() {
                return initiallySelectedTaxonBase;
        }
-       
+
        @Override
        public String toString() {
                return String.format("%s[%s]", this.getClass().getSimpleName(), getTaxon());