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
.ArrayList
;
13 import java
.util
.Arrays
;
14 import java
.util
.HashSet
;
15 import java
.util
.List
;
18 import java
.util
.UUID
;
20 import org
.eclipse
.jface
.resource
.ImageDescriptor
;
21 import org
.eclipse
.ui
.IEditorInput
;
22 import org
.eclipse
.ui
.IMemento
;
23 import org
.eclipse
.ui
.IPersistableElement
;
25 import eu
.etaxonomy
.cdm
.api
.conversation
.ConversationHolder
;
26 import eu
.etaxonomy
.cdm
.api
.conversation
.IConversationEnabled
;
27 import eu
.etaxonomy
.cdm
.api
.service
.IClassificationService
;
28 import eu
.etaxonomy
.cdm
.api
.service
.ITaxonNodeService
;
29 import eu
.etaxonomy
.cdm
.api
.service
.ITaxonService
;
30 import eu
.etaxonomy
.cdm
.model
.common
.CdmBase
;
31 import eu
.etaxonomy
.cdm
.model
.name
.TaxonNameBase
;
32 import eu
.etaxonomy
.cdm
.model
.taxon
.ITaxonTreeNode
;
33 import eu
.etaxonomy
.cdm
.model
.taxon
.Synonym
;
34 import eu
.etaxonomy
.cdm
.model
.taxon
.Taxon
;
35 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonBase
;
36 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonNode
;
37 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonRelationship
;
38 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonRelationshipType
;
39 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
40 import eu
.etaxonomy
.taxeditor
.model
.DataChangeBridge
;
41 import eu
.etaxonomy
.taxeditor
.model
.MessagingUtils
;
42 import eu
.etaxonomy
.taxeditor
.preference
.PreferencesUtil
;
43 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
47 * <p>TaxonEditorInput class.</p>
53 public class TaxonEditorInput
extends CdmEntitySessionInput
implements IEditorInput
, IConversationEnabled
, IPersistableElement
{
55 private final ConversationHolder conversation
;
57 private TaxonNode taxonNode
;
59 private TaxonEditorInputDataChangeBehaviour dataChangeBehavior
;
61 private TaxonBase initiallySelectedTaxonBase
;
63 private enum CdmType
{
69 private TaxonEditorInput(UUID uuid
, CdmType type
) {
71 this.conversation
= CdmStore
.createConversation();
73 case PARENT_TAXON_NODE
:
74 initForParentTaxonNode(uuid
);
77 initForTaxonBase(uuid
);
80 initForTaxonNode(uuid
);
85 private void init(TaxonNode taxonNode
) {
86 this.taxonNode
= taxonNode
;
93 * @param taxonNodeUuid a {@link java.util.UUID} object.
94 * @return a {@link eu.etaxonomy.taxeditor.editor.TaxonEditorInput} object.
95 * @throws java.lang.Exception if any.
97 private void initForTaxonNode(UUID taxonNodeUuid
) {
100 TaxonNode taxonNode
= CdmStore
.getService(ITaxonNodeService
.class).load(taxonNodeUuid
, getTaxonNodePropertyPaths());
102 if(taxonNode
== null){
103 MessagingUtils
.warningDialog("Not yet implemented", TaxonEditorInput
.class, "Selected element is not type TaxonBase.");
109 private void initForTaxonBase(UUID taxonBaseUuid
) {
110 TaxonBase taxonBase
= CdmStore
.getService(ITaxonService
.class).load(taxonBaseUuid
, getTaxonBasePropertyPaths());
111 if (taxonBase
!= null){
112 if(taxonBase
.isInstanceOf(Taxon
.class)){
113 Taxon taxon
= CdmBase
.deproxy(taxonBase
, Taxon
.class);
115 if (taxon
.getTaxonNodes().size() == 0 && taxon
.isMisapplication()){
116 // TODO get accepted taxon
117 MessagingUtils
.info("trying to open Mispplied Name ");
119 Set
<Taxon
> acceptedTaxa
= new HashSet
<Taxon
>();
120 Set
<TaxonRelationship
> relations
= taxon
.getRelationsFromThisTaxon();
121 for(TaxonRelationship relation
: relations
){
122 if(relation
.getType().equals(TaxonRelationshipType
.MISAPPLIED_NAME_FOR())){
123 acceptedTaxa
.add(relation
.getToTaxon());
126 setInputForMultipleTaxa(conversation
, acceptedTaxa
);
129 setInputForMultipleNodes(conversation
, taxon
.getTaxonNodes());
131 }else if(taxonBase
instanceof Synonym
){
132 Synonym synonym
= (Synonym
) taxonBase
;
134 Set
<Taxon
> taxa
= synonym
.getAcceptedTaxa();
135 setInputForMultipleTaxa(conversation
, taxa
);
142 * <p>NewEmptyInstance</p>
144 * @param parentNodeUuid a {@link java.util.UUID} object.
145 * @return a {@link eu.etaxonomy.taxeditor.editor.TaxonEditorInput} object.
147 private void initForParentTaxonNode(UUID parentNodeUuid
){
150 TaxonNameBase
<?
, ?
> name
= PreferencesUtil
.getPreferredNomenclaturalCode().getNewTaxonNameInstance(null);
151 ITaxonTreeNode parentNode
= CdmStore
.getService(IClassificationService
.class).getTreeNodeByUuid(parentNodeUuid
);
153 Taxon newTaxon
= Taxon
.NewInstance(name
, parentNode
.getReference());
154 TaxonNode newTaxonNode
= parentNode
.addChildTaxon(newTaxon
, parentNode
.getReference(), parentNode
.getMicroReference());
156 // add the new taxon to the editors persistence context
157 UUID newTaxonNodeUuid
= CdmStore
.getService(ITaxonNodeService
.class).save(newTaxonNode
).getUuid();
159 initForTaxonNode(newTaxonNodeUuid
);
165 private void setInputForMultipleNodes(ConversationHolder conversation
, Set
<TaxonNode
> taxonNodes
){
166 if(taxonNodes
.size() == 1){
167 TaxonNode taxonNode
= taxonNodes
.iterator().next();
169 }else if(taxonNodes
.size() > 1){
170 TaxonNode taxonNode
= ChooseFromMultipleTaxonNodesDialog
.choose(taxonNodes
);
171 if(taxonNode
!= null){
174 } else if (taxonNodes
.size() == 0) {
175 // this is an undesired state
176 MessagingUtils
.warningDialog("Incorrect state",TaxonEditorInput
.class,"The accepted "
177 + "taxon is not part of any classification. Editing with the "
178 + "name editor is currently not implemented. Try to edit the taxon with the bulk editor.");
182 private void setInputForMultipleTaxa(ConversationHolder conversation
, Set
<Taxon
> taxa
){
183 if(taxa
.size() == 1){
184 Taxon taxon
= taxa
.iterator().next();
185 Set
<TaxonNode
> nodes
= taxon
.getTaxonNodes();
186 setInputForMultipleNodes(conversation
, nodes
);
187 }else if(taxa
.size() > 1){
188 Set
<TaxonNode
> taxonNodes
= new HashSet
<TaxonNode
>();
189 for ( Taxon taxon
: taxa
){
190 taxonNodes
.addAll(taxon
.getTaxonNodes());
192 setInputForMultipleNodes(conversation
, taxonNodes
);
193 }else if(taxa
.size() == 0){
194 // this is an undesired state
195 MessagingUtils
.warningDialog("Incorrect state", TaxonEditorInput
.class, "Trying to open accepted taxon for a synonym or misapplication but" +
196 " no accepted taxa are present. This should not have happened.");
203 * @param taxonNodeUuid a {@link java.util.UUID} object.
204 * @return a {@link eu.etaxonomy.taxeditor.editor.TaxonEditorInput} object.
205 * @throws java.lang.Exception if any.
207 public static TaxonEditorInput
NewInstance(UUID taxonNodeUuid
) throws Exception
{
208 return new TaxonEditorInput(taxonNodeUuid
, CdmType
.TAXON_NODE
);
213 * <p>NewInstanceFromTaxonBase</p>
215 * @param taxonBaseUuid a {@link java.util.UUID} object.
216 * @return a {@link eu.etaxonomy.taxeditor.editor.TaxonEditorInput} object.
218 public static TaxonEditorInput
NewInstanceFromTaxonBase(UUID taxonBaseUuid
){
219 return new TaxonEditorInput(taxonBaseUuid
, CdmType
.TAXON_BASE
);
224 * <p>NewEmptyInstance</p>
226 * @param parentNodeUuid a {@link java.util.UUID} object.
227 * @return a {@link eu.etaxonomy.taxeditor.editor.TaxonEditorInput} object.
229 public static TaxonEditorInput
NewEmptyInstance(UUID parentNodeUuid
){
230 return new TaxonEditorInput(parentNodeUuid
, CdmType
.PARENT_TAXON_NODE
);
234 * @see org.eclipse.ui.IEditorInput#exists()
242 public boolean exists() {
243 return taxonNode
!= null;
247 * @see org.eclipse.ui.IEditorInput#getImageDescriptor()
250 * <p>getImageDescriptor</p>
252 * @return a {@link org.eclipse.jface.resource.ImageDescriptor} object.
255 public ImageDescriptor
getImageDescriptor() {
260 * @see org.eclipse.ui.IEditorInput#getName()
265 * @return a {@link java.lang.String} object.
268 public String
getName() {
269 if(getTaxon() == null){
272 TaxonNameBase
<?
, ?
> name
= getTaxon().getName();
273 if (name
== null || name
.getTitleCache() == null) {
276 return name
.getTitleCache();
281 * @see org.eclipse.ui.IEditorInput#getPersistable()
284 * <p>getPersistable</p>
286 * @return a {@link org.eclipse.ui.IPersistableElement} object.
289 public IPersistableElement
getPersistable() {
290 // if(CdmStore.isActive()){
291 // TaxonNode test = CdmStore.getTaxonTreeService().getTaxonNodeByUuid(taxonNode.getUuid());
292 // boolean isPersistable = CdmStore.getTaxonTreeService().getTaxonNodeByUuid(taxonNode.getUuid()) != null;
293 // if (isPersistable) {
301 * @see org.eclipse.ui.IEditorInput#getToolTipText()
304 * <p>getToolTipText</p>
306 * @return a {@link java.lang.String} object.
309 public String
getToolTipText() {
314 * @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class)
318 public Object
getAdapter(Class adapter
) {
320 if (adapter
== Taxon
.class) {
324 if (adapter
== TaxonNode
.class) {
334 * Overrides equals to ensure that a taxon can only be edited by
335 * one editor at a time.
338 public boolean equals(Object obj
) {
339 if (TaxonEditorInput
.class.equals(obj
.getClass())
340 && getTaxon() != null
341 && getTaxon().equals(((TaxonEditorInput
) obj
).getTaxon())){
342 if(((TaxonEditorInput
) obj
).getInitiallySelectedTaxonBase() != null){
343 setInitiallySelectedTaxonBase(((TaxonEditorInput
) obj
).getInitiallySelectedTaxonBase());
355 public Taxon
getTaxon(){
356 Taxon taxon
= CdmBase
.deproxy(taxonNode
.getTaxon(), Taxon
.class);
361 * <p>Getter for the field <code>taxonNode</code>.</p>
363 * @return the taxonNode
365 public TaxonNode
getTaxonNode() {
371 * @see eu.etaxonomy.cdm.api.conversation.IConversationEnabled#getConversationHolder()
374 * <p>getConversationHolder</p>
376 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
379 public ConversationHolder
getConversationHolder() {
385 * @see eu.etaxonomy.cdm.persistence.hibernate.ICdmPostCrudObserver#update(eu.etaxonomy.cdm.persistence.hibernate.CdmCrudEvent)
389 public void update(CdmDataChangeMap events
) {
390 if(dataChangeBehavior
== null){
391 dataChangeBehavior
= new TaxonEditorInputDataChangeBehaviour(this);
394 DataChangeBridge
.handleDataChange(events
, dataChangeBehavior
);
398 * @see org.eclipse.ui.IPersistableElement#getFactoryId()
401 * <p>getFactoryId</p>
403 * @return a {@link java.lang.String} object.
406 public String
getFactoryId() {
407 return TaxonEditorInputFactory
.getFactoryId();
411 * @see org.eclipse.ui.IPersistable#saveState(org.eclipse.ui.IMemento)
415 public void saveState(IMemento memento
) {
416 TaxonEditorInputFactory
.saveState(memento
, this);
421 * <p>Setter for the field <code>initiallySelectedTaxonBase</code>.</p>
423 * @param taxonBase a {@link eu.etaxonomy.cdm.model.taxon.TaxonBase} object.
425 public void setInitiallySelectedTaxonBase(TaxonBase taxonBase
) {
426 this.initiallySelectedTaxonBase
= taxonBase
;
430 * <p>Getter for the field <code>initiallySelectedTaxonBase</code>.</p>
432 * @return a {@link eu.etaxonomy.cdm.model.taxon.TaxonBase} object.
434 public TaxonBase
getInitiallySelectedTaxonBase() {
435 return initiallySelectedTaxonBase
;
439 // public String toString() {
440 // return String.format("%s[%s]", this.getClass().getSimpleName(), getTaxon());
445 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled#getRootEntities()
448 public List
<TaxonNode
> getRootEntities() {
449 return Arrays
.asList(taxonNode
);
453 * @see eu.etaxonomy.taxeditor.editor.CdmEntitySessionInput#merge()
456 public void merge() {
457 if(CdmStore
.getCurrentSessionManager().isRemoting()) {
458 CdmStore
.getService(ITaxonNodeService
.class).merge(taxonNode
, true);
463 public Map
<Object
, List
<String
>> getPropertyPathsMap() {
467 private List
<String
> getTaxonNodePropertyPaths() {
468 List
<String
> taxonNodePropertyPaths
= new ArrayList
<String
>();
469 for(String propertyPath
: getTaxonBasePropertyPaths()) {
470 taxonNodePropertyPaths
.add("taxon." + propertyPath
);
472 return taxonNodePropertyPaths
;
475 private List
<String
> getTaxonBasePropertyPaths() {
476 List
<String
> taxonBasePropertyPaths
= Arrays
.asList(new String
[] {
487 "relationsToThisTaxon",
488 "relationsFromThisTaxon",
490 "descriptions.descriptionElements.feature",
491 "descriptions.descriptionElements.area",
492 "descriptions.descriptionElements.status",
493 "descriptions.markers",
495 "name.typeDesignations",
497 "name.nomenclaturalReference.inReference",
498 "name.taxonBases.taxonNodes",
499 "name.relationsFromThisName",
500 "name.relationsToThisName",
501 "name.homotypicalGroup.typifiedNames.taxonBases.synonymRelations.synonym.name.status",
502 "name.homotypicalGroup.typifiedNames.relationsToThisName.fromName",
503 "synonymRelations.synonym.name.status.type",
504 "synonymRelations.synonym.name.relationsToThisName.fromName",
505 "synonymRelations.synonym.name.nomenclaturalReference.inReference.authorship",
506 "synonymRelations.synonym.name.nomenclaturalReference.authorship",
507 "synonymRelations.synonym.name.homotypicalGroup.typifiedNames.taxonBases.synonymRelations"
510 return taxonBasePropertyPaths
;