Project

General

Profile

Download (16.4 KB) Statistics
| Branch: | Tag: | Revision:
1
/**
2
 * Copyright (C) 2007 EDIT
3
 * European Distributed Institute of Taxonomy
4
 * http://www.e-taxonomy.eu
5
 *
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.
8
 */
9

    
10
package eu.etaxonomy.taxeditor.editor.e4;
11

    
12
import java.util.ArrayList;
13
import java.util.Arrays;
14
import java.util.HashMap;
15
import java.util.HashSet;
16
import java.util.List;
17
import java.util.Map;
18
import java.util.Map.Entry;
19
import java.util.Set;
20
import java.util.UUID;
21

    
22
import org.eclipse.e4.ui.di.UISynchronize;
23

    
24
import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
25
import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;
26
import eu.etaxonomy.cdm.api.service.IClassificationService;
27
import eu.etaxonomy.cdm.api.service.INameService;
28
import eu.etaxonomy.cdm.api.service.ITaxonNodeService;
29
import eu.etaxonomy.cdm.api.service.ITaxonService;
30
import eu.etaxonomy.cdm.api.service.config.SynonymDeletionConfigurator;
31
import eu.etaxonomy.cdm.api.service.config.TaxonBaseDeletionConfigurator;
32
import eu.etaxonomy.cdm.api.service.config.TaxonDeletionConfigurator;
33
import eu.etaxonomy.cdm.model.common.CdmBase;
34
import eu.etaxonomy.cdm.model.name.HybridRelationship;
35
import eu.etaxonomy.cdm.model.name.TaxonName;
36
import eu.etaxonomy.cdm.model.taxon.ITaxonTreeNode;
37
import eu.etaxonomy.cdm.model.taxon.Synonym;
38
import eu.etaxonomy.cdm.model.taxon.Taxon;
39
import eu.etaxonomy.cdm.model.taxon.TaxonBase;
40
import eu.etaxonomy.cdm.model.taxon.TaxonNode;
41
import eu.etaxonomy.cdm.model.taxon.TaxonRelationship;
42
import eu.etaxonomy.cdm.model.taxon.TaxonRelationshipType;
43
import eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap;
44
import eu.etaxonomy.taxeditor.editor.CdmEntitySessionInput;
45
import eu.etaxonomy.taxeditor.editor.ChooseFromMultipleTaxonNodesDialog;
46
import eu.etaxonomy.taxeditor.editor.EditorUtil;
47
import eu.etaxonomy.taxeditor.editor.l10n.Messages;
48
import eu.etaxonomy.taxeditor.model.DataChangeBridge;
49
import eu.etaxonomy.taxeditor.model.MessagingUtils;
50
import eu.etaxonomy.taxeditor.operation.AbstractPostOperation;
51
import eu.etaxonomy.taxeditor.operation.AbstractPostTaxonOperation;
52
import eu.etaxonomy.taxeditor.preference.PreferencesUtil;
53
import eu.etaxonomy.taxeditor.store.CdmStore;
54

    
55

    
56
/**
57
 *
58
 * @author pplitzner
59
 * @date Aug 24, 2017
60
 *
61
 */
62
public class TaxonEditorInputE4  extends CdmEntitySessionInput implements IConversationEnabled {
63

    
64
    private static final String INCORRECT_STATE = Messages.TaxonEditorInput_INCORRECT_STATE;
65

    
66
    private final ConversationHolder conversation;
67

    
68
    private TaxonNode taxonNode;
69

    
70
    private Map<TaxonBase, TaxonBaseDeletionConfigurator> toDeletes = new HashMap<>();
71
    private Set<Synonym> toSaveNewSynonyms = new HashSet<>();
72
    private Set<TaxonBase> toSaveNewConcepts = new HashSet<>();
73
    private Set<TaxonName> toSaveNewNames = new HashSet<>();
74

    
75

    
76
    private Set<AbstractPostTaxonOperation> operations = new HashSet<>();
77

    
78
    private TaxonEditorInputDataChangeBehaviourE4 dataChangeBehavior;
79

    
80
    private TaxonBase<?> initiallySelectedTaxonBase;
81

    
82
    private UISynchronize sync;
83

    
84

    
85
    public void setSync(UISynchronize sync) {
86
        this.sync = sync;
87
    }
88

    
89
    private enum CdmType {
90
        TAXON_NODE,
91
        TAXON_BASE,
92
        PARENT_TAXON_NODE
93
    }
94

    
95
    private TaxonEditorInputE4(UUID uuid, CdmType type) {
96
        super(true);
97
        this.conversation = CdmStore.createConversation();
98
        switch(type) {
99
        case PARENT_TAXON_NODE:
100
            initForParentTaxonNode(uuid);
101
            break;
102
        case TAXON_BASE:
103
            initForTaxonBase(uuid);
104
            break;
105
        case TAXON_NODE:
106
            initForTaxonNode(uuid);
107
            break;
108
        }
109
    }
110

    
111
    private void init(TaxonNode taxonNode) {
112
    	this.taxonNode = taxonNode;
113
    }
114

    
115

    
116
    private void initForTaxonNode(UUID taxonNodeUuid) {
117
    	this.getCdmEntitySession().bind();
118
        TaxonNode taxonNode = CdmStore.getService(ITaxonNodeService.class).load(taxonNodeUuid, getTaxonNodePropertyPaths());
119
//    	TaxonNode taxonNode = getCdmEntitySession().remoteLoad(CdmStore.getService(ITaxonNodeService.class), taxonNodeUuid, getTaxonNodePropertyPaths());
120
        if(taxonNode == null){
121
            MessagingUtils.warningDialog(Messages.TaxonEditorInput_NOT_IMPLEMENTED, TaxonEditorInputE4.class, Messages.TaxonEditorInput_NOT_IMPLEMENTED_MESSAGE);
122
        }
123
        init(taxonNode);
124
        setInitiallySelectedTaxonBase(getTaxon());
125

    
126
    }
127

    
128
    private void initForTaxonBase(UUID taxonBaseUuid) {
129
    	this.getCdmEntitySession().bind();
130
//        TaxonBase taxonBase = CdmStore.getService(ITaxonService.class).load(taxonBaseUuid, getTaxonBasePropertyPaths());
131
    	TaxonBase taxonBase = getCdmEntitySession().remoteLoad(CdmStore.getService(ITaxonService.class), taxonBaseUuid, getTaxonBasePropertyPaths());
132
        if (taxonBase != null){
133
            if(taxonBase.isInstanceOf(Taxon.class)){
134
                Taxon taxon = CdmBase.deproxy(taxonBase, Taxon.class);
135
                setInitiallySelectedTaxonBase(taxon);
136

    
137
                if (taxon.getTaxonNodes().size() == 0 && taxon.isMisapplication()){
138
                    // TODO get accepted taxon
139
                    MessagingUtils.info(Messages.TaxonEditorInput_OPEN_MISSAPPLIED_NAME);
140

    
141
                    Set<Taxon> acceptedTaxa = new HashSet<Taxon>();
142
                    Set<TaxonRelationship> relations = taxon.getRelationsFromThisTaxon();
143
                    for(TaxonRelationship relation : relations){
144
                        if(relation.getType().equals(TaxonRelationshipType.MISAPPLIED_NAME_FOR())){
145
                            acceptedTaxa.add(relation.getToTaxon());
146
                        }
147
                    }
148
                    setInputForMultipleTaxa(conversation, acceptedTaxa);
149

    
150
                }else{
151
                    setInputForMultipleNodes(conversation, taxon.getTaxonNodes());
152
                }
153
            }else if(taxonBase instanceof Synonym){
154
                Synonym synonym = (Synonym) taxonBase;
155

    
156
                Set<Taxon> taxa = new HashSet<>();
157
                Taxon taxon = synonym.getAcceptedTaxon();
158
                if (taxon != null){
159
                	taxa.add(taxon);
160
                }
161
                setInputForMultipleTaxa(conversation, taxa);
162
                setInitiallySelectedTaxonBase(synonym);
163
            }
164
        }
165
    }
166

    
167

    
168
    private void initForParentTaxonNode(UUID parentNodeUuid){
169
    	this.getCdmEntitySession().bind();
170
        TaxonName name = PreferencesUtil.getPreferredNomenclaturalCode().getNewTaxonNameInstance(null);
171
        ITaxonTreeNode parentNode = CdmStore.getService(IClassificationService.class).getTreeNodeByUuid(parentNodeUuid);
172

    
173
        Taxon newTaxon = Taxon.NewInstance(name, parentNode.getReference());
174
        TaxonNode newTaxonNode = parentNode.addChildTaxon(newTaxon, parentNode.getReference(), parentNode.getMicroReference());
175

    
176
        // add the new taxon to the editors persistence context
177
        UUID newTaxonNodeUuid = CdmStore.getService(ITaxonNodeService.class).save(newTaxonNode).getUuid();
178

    
179
        initForTaxonNode(newTaxonNodeUuid);
180
    }
181

    
182
    private void setInputForMultipleNodes(ConversationHolder conversation, Set<TaxonNode> taxonNodes){
183
        if(taxonNodes.size() == 1){
184
            TaxonNode taxonNode = taxonNodes.iterator().next();
185
            taxonNode = getCdmEntitySession().remoteLoad(CdmStore.getService(ITaxonNodeService.class), taxonNode.getUuid(), getTaxonNodePropertyPaths());
186
            init(taxonNode);
187
        }else if(taxonNodes.size() > 1){
188
            TaxonNode taxonNode = ChooseFromMultipleTaxonNodesDialog.choose(taxonNodes);
189
            taxonNode = CdmStore.getService(ITaxonNodeService.class).load(taxonNode.getUuid(), getTaxonNodePropertyPaths());
190
            if(taxonNode != null){
191
                init(taxonNode);
192
            }
193
        } else if (taxonNodes.size() == 0) {
194
            // this is an undesired state
195
            MessagingUtils.warningDialog(INCORRECT_STATE,TaxonEditorInputE4.class,Messages.TaxonEditorInput_TAXON_NOT_IN_CLASSIFICATION);
196
        }
197
    }
198

    
199
    private void setInputForMultipleTaxa(ConversationHolder conversation, Set<Taxon> taxa){
200
        if(taxa.size() == 1){
201
            Taxon taxon = taxa.iterator().next();
202
            Set<TaxonNode> nodes = taxon.getTaxonNodes();
203
            setInputForMultipleNodes(conversation, nodes);
204
        }else if(taxa.size() > 1){
205
            Set<TaxonNode> taxonNodes = new HashSet<TaxonNode>();
206
            for ( Taxon taxon : taxa ){
207
                taxonNodes.addAll(taxon.getTaxonNodes());
208
            }
209
            setInputForMultipleNodes(conversation, taxonNodes);
210
        }else if(taxa.size() == 0){
211
            // this is an undesired state
212
            MessagingUtils.warningDialog(INCORRECT_STATE, TaxonEditorInputE4.class, Messages.TaxonEditorInput_NO_ACCEPTED_TAXON_PRESENT);
213
        }
214
    }
215

    
216
    public static TaxonEditorInputE4 NewInstance(UUID taxonNodeUuid) {
217
        return new TaxonEditorInputE4(taxonNodeUuid, CdmType.TAXON_NODE);
218

    
219
    }
220

    
221
    public static TaxonEditorInputE4 NewInstanceFromTaxonBase(UUID taxonBaseUuid){
222
        return new TaxonEditorInputE4(taxonBaseUuid, CdmType.TAXON_BASE);
223
    }
224

    
225

    
226
    public static TaxonEditorInputE4 NewEmptyInstance(UUID parentNodeUuid){
227
        return new TaxonEditorInputE4(parentNodeUuid, CdmType.PARENT_TAXON_NODE);
228
    }
229

    
230
    public Object getAdapter(Class adapter) {
231

    
232
        if (adapter == Taxon.class) {
233
            return getTaxon();
234
        }
235

    
236
        if (adapter == TaxonNode.class) {
237
            return taxonNode;
238
        }
239

    
240
        return null;
241
    }
242

    
243
    /**
244
     * {@inheritDoc}
245
     *
246
     * Overrides equals to ensure that a taxon can only be edited by
247
     * one editor at a time.
248
     */
249
    @Override
250
    public boolean equals(Object obj) {
251
        if (TaxonEditorInputE4.class.equals(obj.getClass())
252
                && getTaxon() != null
253
                && getTaxon().equals(((TaxonEditorInputE4) obj).getTaxon())) {
254
            if (((TaxonEditorInputE4) obj).getInitiallySelectedTaxonBase() != null){
255
                setInitiallySelectedTaxonBase(((TaxonEditorInputE4) obj).getInitiallySelectedTaxonBase());
256
            }
257
            return true;
258
        }
259
        return false;
260
    }
261

    
262
    public Taxon getTaxon(){
263
        if(taxonNode!=null){
264
            Taxon taxon = CdmBase.deproxy(taxonNode.getTaxon(), Taxon.class);
265
            return taxon;
266
        }
267
        return null;
268
    }
269

    
270
    public TaxonNode getTaxonNode() {
271
        return taxonNode;
272
    }
273

    
274
    @Override
275
    public ConversationHolder getConversationHolder() {
276
        return conversation;
277
    }
278

    
279
    /** {@inheritDoc} */
280
    @Override
281
    public void update(CdmDataChangeMap events) {
282
        if(dataChangeBehavior == null){
283
            dataChangeBehavior = new TaxonEditorInputDataChangeBehaviourE4(this);
284
        }
285

    
286
        DataChangeBridge.handleDataChange(events, dataChangeBehavior);
287
    }
288

    
289
    public void setInitiallySelectedTaxonBase(TaxonBase taxonBase) {
290
        this.initiallySelectedTaxonBase = taxonBase;
291
    }
292

    
293
    public TaxonBase getInitiallySelectedTaxonBase() {
294
        return initiallySelectedTaxonBase;
295
    }
296

    
297
    public Set<AbstractPostTaxonOperation> getOperations() {
298
        return operations;
299
    }
300

    
301
    public void setOperations(Set<AbstractPostTaxonOperation> operations) {
302
        this.operations = operations;
303
    }
304

    
305
    public void addOperation(AbstractPostTaxonOperation operation) {
306
        this.operations.add(operation);
307
    }
308

    
309
    public void addToSaveNewSynonym(Synonym toSaveNew) {
310
        this.toSaveNewSynonyms.add(toSaveNew);
311
    }
312
    public void addToSaveNewConcept(Taxon toSaveNew) {
313
        if (!toSaveNew.isPersited()){
314
            this.toSaveNewConcepts.add(toSaveNew);
315
        }
316
    }
317

    
318
    @Override
319
    public List<TaxonNode> getRootEntities() {
320
        return Arrays.asList(taxonNode);
321
    }
322

    
323
    @Override
324
    public void merge() {
325
        if (!this.getCdmEntitySession().isActive()){
326
            this.getCdmEntitySession().bind();
327
        }
328
        for(Entry<TaxonBase, TaxonBaseDeletionConfigurator> entry:toDeletes.entrySet()){
329
            delete(entry.getKey(), entry.getValue());
330
        }
331
        toDeletes.clear();
332
        for(AbstractPostOperation entry:operations){
333
            EditorUtil.executeOperation(entry,sync);
334
        }
335
        operations.clear();
336

    
337
        for (Synonym syn: toSaveNewSynonyms){
338
            for (HybridRelationship rel : syn.getName().getHybridChildRelations()){
339
                if (!rel.getParentName().isPersited()) {
340
                    toSaveNewNames.add(rel.getParentName());
341
                }
342
                    if (!rel.getHybridName().isPersited()) {
343
                   toSaveNewNames.add(rel.getHybridName());
344
                }
345

    
346
            }
347
        }
348

    
349
        for (TaxonBase concept: toSaveNewConcepts){
350
            for (HybridRelationship rel : concept.getName().getHybridChildRelations()){
351
                if (!rel.getParentName().isPersited()) {
352
                    toSaveNewNames.add(rel.getParentName());
353
                }
354
                if (!rel.getHybridName().isPersited()) {
355
                    toSaveNewNames.add(rel.getHybridName());
356
                }
357

    
358
            }
359
        }
360
        CdmStore.getService(INameService.class).save(toSaveNewNames);
361
        CdmStore.getService(ITaxonService.class).save(toSaveNewConcepts);
362

    
363
        toSaveNewNames.clear();
364
        toSaveNewConcepts.clear();
365

    
366
        CdmStore.getService(ITaxonNodeService.class).merge(taxonNode, true);
367

    
368
    }
369

    
370
    /**
371
     * @param key
372
     * @param value
373
     */
374
    private void delete(TaxonBase key, TaxonBaseDeletionConfigurator value) {
375
        if (key instanceof Synonym){
376
            CdmStore.getService(ITaxonService.class).deleteSynonym(((Synonym)key).getUuid(), (SynonymDeletionConfigurator) value);
377
        }else{
378
            CdmStore.getService(ITaxonService.class).deleteTaxon(((Taxon)key).getUuid(), (TaxonDeletionConfigurator) value, null);
379
        }
380

    
381
    }
382

    
383
    @Override
384
    public Map<Object, List<String>> getPropertyPathsMap() {
385
        return null;
386
    }
387

    
388
    private List<String> getTaxonNodePropertyPaths() {
389
        List<String> taxonNodePropertyPaths = new ArrayList<String>();
390
        for(String propertyPath : getTaxonBasePropertyPaths()) {
391
            taxonNodePropertyPaths.add("taxon." + propertyPath); //$NON-NLS-1$
392
        }
393
        return taxonNodePropertyPaths;
394
    }
395

    
396
    private List<String> getTaxonBasePropertyPaths() {
397
        List<String> taxonBasePropertyPaths = Arrays.asList(new String[] {
398
                "sec", //$NON-NLS-1$
399
                "createdBy", //$NON-NLS-1$
400
                "updatedBy", //$NON-NLS-1$
401
                "annotations", //$NON-NLS-1$
402
                "markers", //$NON-NLS-1$
403
                "credits", //$NON-NLS-1$
404
                "extensions", //$NON-NLS-1$
405
                "rights", //$NON-NLS-1$
406
                "sources", //$NON-NLS-1$
407
                "identifiers",
408
                "descriptions", //$NON-NLS-1$
409
                "taxonNodes", //$NON-NLS-1$
410
                "descriptions.descriptionElements.feature", //$NON-NLS-1$
411
                "descriptions.descriptionElements.area", //$NON-NLS-1$
412
                "descriptions.descriptionElements.status", //$NON-NLS-1$
413
                "descriptions.markers", //$NON-NLS-1$
414
                "name.descriptions", //$NON-NLS-1$
415
                "name.typeDesignations.typeSpecimen.derivedFrom.originals", //$NON-NLS-1$
416
                "name.status", //$NON-NLS-1$
417
                "name.nomenclaturalReference.inReference", //$NON-NLS-1$
418
                "name.taxonBases.taxonNodes", //$NON-NLS-1$
419
                "name.relationsFromThisName", //$NON-NLS-1$
420
                "name.relationsToThisName", //$NON-NLS-1$
421
                "name.homotypicalGroup.typifiedNames.taxonBases.synonyms.synonym.name.status", //$NON-NLS-1$
422
                "name.homotypicalGroup.typifiedNames.relationsToThisName.fromName", //$NON-NLS-1$
423
                "synonyms.name.status.type", //$NON-NLS-1$
424
                "synonyms.name.relationsToThisName.fromName", //$NON-NLS-1$
425
                "synonyms.name.nomenclaturalReference.inReference.authorship", //$NON-NLS-1$
426
                "synonyms.name.nomenclaturalReference.authorship", //$NON-NLS-1$
427
                "synonyms.name.homotypicalGroup.typifiedNames.taxonBases.synonyms" //$NON-NLS-1$
428
        });
429

    
430
        return taxonBasePropertyPaths;
431
    }
432

    
433
    /**
434
     * @param selectedElement
435
     * @param deleteConfig
436
     */
437
    public void addTaxonBaseToDelete(TaxonBase selectedElement, TaxonBaseDeletionConfigurator deleteConfig) {
438
        this.toDeletes.put(selectedElement, deleteConfig);
439

    
440
    }
441

    
442
    /**
443
     * @param newName
444
     */
445
    public void addToSaveNewName(TaxonName newName) {
446
        this.toSaveNewNames.add(newName);
447
    }
448

    
449
}
(2-2/2)