2 * Copyright (C) 2007 EDIT
3 * European Distributed Institute of Taxonomy
4 * http://www.e-taxonomy.eu
6 * The contents of this file are subject to the Mozilla Public License Version 1.1
7 * See LICENSE.TXT at the top of this package for the full license terms.
10 package eu
.etaxonomy
.taxeditor
.editor
;
12 import java
.util
.HashSet
;
14 import java
.util
.UUID
;
16 import org
.eclipse
.jface
.resource
.ImageDescriptor
;
17 import org
.eclipse
.ui
.IEditorInput
;
18 import org
.eclipse
.ui
.IMemento
;
19 import org
.eclipse
.ui
.IPersistableElement
;
21 import eu
.etaxonomy
.cdm
.api
.conversation
.ConversationHolder
;
22 import eu
.etaxonomy
.cdm
.api
.conversation
.IConversationEnabled
;
23 import eu
.etaxonomy
.cdm
.api
.service
.IClassificationService
;
24 import eu
.etaxonomy
.cdm
.api
.service
.ITaxonNodeService
;
25 import eu
.etaxonomy
.cdm
.api
.service
.ITaxonService
;
26 import eu
.etaxonomy
.cdm
.model
.common
.CdmBase
;
27 import eu
.etaxonomy
.cdm
.model
.name
.TaxonNameBase
;
28 import eu
.etaxonomy
.cdm
.model
.taxon
.ITaxonTreeNode
;
29 import eu
.etaxonomy
.cdm
.model
.taxon
.Synonym
;
30 import eu
.etaxonomy
.cdm
.model
.taxon
.Taxon
;
31 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonBase
;
32 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonNode
;
33 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonRelationship
;
34 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonRelationshipType
;
35 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
36 import eu
.etaxonomy
.taxeditor
.model
.DataChangeBridge
;
37 import eu
.etaxonomy
.taxeditor
.model
.MessagingUtils
;
38 import eu
.etaxonomy
.taxeditor
.preference
.PreferencesUtil
;
39 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
43 * <p>TaxonEditorInput class.</p>
49 public class TaxonEditorInput
implements IEditorInput
, IConversationEnabled
, IPersistableElement
{
51 private ConversationHolder conversation
;
53 private TaxonNode taxonNode
;
55 private TaxonEditorInputDataChangeBehaviour dataChangeBehavior
;
57 private TaxonBase initiallySelectedTaxonBase
;
59 private TaxonEditorInput(TaxonNode taxonNode
, ConversationHolder conversation
){
60 this.conversation
= conversation
;
61 this.taxonNode
= taxonNode
;
69 * @param taxonNodeUuid a {@link java.util.UUID} object.
70 * @return a {@link eu.etaxonomy.taxeditor.editor.TaxonEditorInput} object.
71 * @throws java.lang.Exception if any.
73 public static TaxonEditorInput
NewInstance(UUID taxonNodeUuid
) throws Exception
{
75 ConversationHolder conversation
= CdmStore
.createConversation();
76 return NewInstance(taxonNodeUuid
, conversation
);
84 * @param taxonNodeUuid
88 private static TaxonEditorInput
NewInstance(UUID taxonNodeUuid
, ConversationHolder conversation
){
91 TaxonNode taxonNode
= CdmStore
.getService(ITaxonNodeService
.class).load(taxonNodeUuid
, null);
93 if(taxonNode
== null){
94 MessagingUtils
.warningDialog("Not yet implemented", TaxonEditorInput
.class, "Selected element is not type TaxonBase.");
98 return new TaxonEditorInput(taxonNode
, conversation
);
102 * <p>NewInstanceFromTaxonBase</p>
104 * @param taxonBaseUuid a {@link java.util.UUID} object.
105 * @return a {@link eu.etaxonomy.taxeditor.editor.TaxonEditorInput} object.
107 public static TaxonEditorInput
NewInstanceFromTaxonBase(UUID taxonBaseUuid
){
108 ConversationHolder conversation
= CdmStore
.createConversation();
110 TaxonEditorInput input
= null;
112 TaxonBase taxonBase
= CdmStore
.getService(ITaxonService
.class).find(taxonBaseUuid
);
113 if (taxonBase
!= null){
114 if(taxonBase
.isOrphaned()) {
115 MessagingUtils
.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.");
117 else if(taxonBase
.isInstanceOf(Taxon
.class)){
118 Taxon taxon
= CdmBase
.deproxy(taxonBase
, Taxon
.class);
120 if (taxon
.getTaxonNodes().size() == 0 && taxon
.isMisapplication()){
121 // TODO get accepted taxon
122 MessagingUtils
.info("trying to open Mispplied Name ");
124 Set
<Taxon
> acceptedTaxa
= new HashSet
<Taxon
>();
125 Set
<TaxonRelationship
> relations
= taxon
.getRelationsFromThisTaxon();
126 for(TaxonRelationship relation
: relations
){
127 if(relation
.getType().equals(TaxonRelationshipType
.MISAPPLIED_NAME_FOR())){
128 acceptedTaxa
.add(relation
.getToTaxon());
131 input
= getInputForMultipleTaxa(conversation
, acceptedTaxa
);
134 input
= getInputForMultipleNodes(conversation
, taxon
.getTaxonNodes());
136 }else if(taxonBase
instanceof Synonym
){
137 Synonym synonym
= (Synonym
) taxonBase
;
139 Set
<Taxon
> taxa
= synonym
.getAcceptedTaxa();
140 input
= getInputForMultipleTaxa(conversation
, taxa
);
143 input
.setInitiallySelectedTaxonBase(taxonBase
);
151 private static TaxonEditorInput
getInputForMultipleNodes(ConversationHolder conversation
, Set
<TaxonNode
> taxonNodes
){
152 if(taxonNodes
.size() == 1){
153 TaxonNode taxonNode
= taxonNodes
.iterator().next();
154 return NewInstance(taxonNode
.getUuid(), conversation
);
155 }else if(taxonNodes
.size() > 1){
156 TaxonNode taxonNode
= ChooseFromMultipleTaxonNodesDialog
.choose(taxonNodes
);
157 if(taxonNode
!= null){
158 return NewInstance(taxonNode
.getUuid(), conversation
);
160 }else if(taxonNodes
.size() == 0){
161 // this is an undesired state
162 MessagingUtils
.warningDialog("Incorrect state", TaxonEditorInput
.class, "The accepted taxon is not part of any classification. This should not have happened.");
167 private static TaxonEditorInput
getInputForMultipleTaxa(ConversationHolder conversation
, Set
<Taxon
> taxa
){
168 if(taxa
.size() == 1){
169 Taxon taxon
= taxa
.iterator().next();
170 Set
<TaxonNode
> nodes
= taxon
.getTaxonNodes();
171 return getInputForMultipleNodes(conversation
, nodes
);
172 }else if(taxa
.size() > 1){
173 Set
<TaxonNode
> taxonNodes
= new HashSet
<TaxonNode
>();
174 for ( Taxon taxon
: taxa
){
175 taxonNodes
.addAll(taxon
.getTaxonNodes());
177 return getInputForMultipleNodes(conversation
, taxonNodes
);
178 }else if(taxa
.size() == 0){
179 // this is an undesired state
180 MessagingUtils
.warningDialog("Incorrect state", TaxonEditorInput
.class, "Trying to open accepted taxon for a synonym or misapplication but" +
181 " no accepted taxa are present. This should not have happened.");
187 * <p>NewEmptyInstance</p>
189 * @param parentNodeUuid a {@link java.util.UUID} object.
190 * @return a {@link eu.etaxonomy.taxeditor.editor.TaxonEditorInput} object.
192 public static TaxonEditorInput
NewEmptyInstance(UUID parentNodeUuid
){
193 ConversationHolder conversation
= CdmStore
.createConversation();
195 TaxonNameBase
<?
, ?
> name
= PreferencesUtil
.getPreferredNomenclaturalCode().getNewTaxonNameInstance(null);
196 ITaxonTreeNode parentNode
= CdmStore
.getService(IClassificationService
.class).getTreeNodeByUuid(parentNodeUuid
);
198 Taxon newTaxon
= Taxon
.NewInstance(name
, parentNode
.getReference());
199 TaxonNode newTaxonNode
= parentNode
.addChildTaxon(newTaxon
, parentNode
.getReference(), parentNode
.getMicroReference());
201 // add the new taxon to the editors persistence context
202 UUID newTaxonNodeUuid
= CdmStore
.getService(ITaxonNodeService
.class).save(newTaxonNode
);
204 return new TaxonEditorInput(newTaxonNode
, conversation
);
208 * @see org.eclipse.ui.IEditorInput#exists()
216 public boolean exists() {
217 return taxonNode
!= null;
221 * @see org.eclipse.ui.IEditorInput#getImageDescriptor()
224 * <p>getImageDescriptor</p>
226 * @return a {@link org.eclipse.jface.resource.ImageDescriptor} object.
229 public ImageDescriptor
getImageDescriptor() {
234 * @see org.eclipse.ui.IEditorInput#getName()
239 * @return a {@link java.lang.String} object.
242 public String
getName() {
243 if(getTaxon() == null){
246 TaxonNameBase
<?
, ?
> name
= getTaxon().getName();
247 if (name
== null || name
.getTitleCache() == null) {
250 return name
.getTitleCache();
255 * @see org.eclipse.ui.IEditorInput#getPersistable()
258 * <p>getPersistable</p>
260 * @return a {@link org.eclipse.ui.IPersistableElement} object.
263 public IPersistableElement
getPersistable() {
264 // if(CdmStore.isActive()){
265 // TaxonNode test = CdmStore.getTaxonTreeService().getTaxonNodeByUuid(taxonNode.getUuid());
266 // boolean isPersistable = CdmStore.getTaxonTreeService().getTaxonNodeByUuid(taxonNode.getUuid()) != null;
267 // if (isPersistable) {
275 * @see org.eclipse.ui.IEditorInput#getToolTipText()
278 * <p>getToolTipText</p>
280 * @return a {@link java.lang.String} object.
283 public String
getToolTipText() {
288 * @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class)
292 public Object
getAdapter(Class adapter
) {
294 if (adapter
== Taxon
.class) {
295 return taxonNode
.getTaxon();
298 if (adapter
== TaxonNode
.class) {
308 * Overrides equals to ensure that a taxon can only be edited by
309 * one editor at a time.
312 public boolean equals(Object obj
) {
313 if (TaxonEditorInput
.class.equals(obj
.getClass())
314 && getTaxon() != null
315 && getTaxon().equals(((TaxonEditorInput
) obj
).getTaxon())){
316 if(((TaxonEditorInput
) obj
).getInitiallySelectedTaxonBase() != null){
317 setInitiallySelectedTaxonBase(((TaxonEditorInput
) obj
).getInitiallySelectedTaxonBase());
329 public Taxon
getTaxon(){
330 return taxonNode
.getTaxon();
334 * <p>Getter for the field <code>taxonNode</code>.</p>
336 * @return the taxonNode
338 public TaxonNode
getTaxonNode() {
344 * @see eu.etaxonomy.cdm.api.conversation.IConversationEnabled#getConversationHolder()
347 * <p>getConversationHolder</p>
349 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
352 public ConversationHolder
getConversationHolder() {
358 * @see eu.etaxonomy.cdm.persistence.hibernate.ICdmPostCrudObserver#update(eu.etaxonomy.cdm.persistence.hibernate.CdmCrudEvent)
362 public void update(CdmDataChangeMap events
) {
363 if(dataChangeBehavior
== null){
364 dataChangeBehavior
= new TaxonEditorInputDataChangeBehaviour(this);
367 DataChangeBridge
.handleDataChange(events
, dataChangeBehavior
);
371 * @see org.eclipse.ui.IPersistableElement#getFactoryId()
374 * <p>getFactoryId</p>
376 * @return a {@link java.lang.String} object.
379 public String
getFactoryId() {
380 return TaxonEditorInputFactory
.getFactoryId();
384 * @see org.eclipse.ui.IPersistable#saveState(org.eclipse.ui.IMemento)
388 public void saveState(IMemento memento
) {
389 TaxonEditorInputFactory
.saveState(memento
, this);
394 * <p>Setter for the field <code>initiallySelectedTaxonBase</code>.</p>
396 * @param taxonBase a {@link eu.etaxonomy.cdm.model.taxon.TaxonBase} object.
398 public void setInitiallySelectedTaxonBase(TaxonBase taxonBase
) {
399 this.initiallySelectedTaxonBase
= taxonBase
;
403 * <p>Getter for the field <code>initiallySelectedTaxonBase</code>.</p>
405 * @return a {@link eu.etaxonomy.cdm.model.taxon.TaxonBase} object.
407 public TaxonBase
getInitiallySelectedTaxonBase() {
408 return initiallySelectedTaxonBase
;
412 public String
toString() {
413 return String
.format("%s[%s]", this.getClass().getSimpleName(), getTaxon());