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.
9 package eu
.etaxonomy
.taxeditor
.editor
;
11 import java
.util
.Collection
;
12 import java
.util
.HashSet
;
13 import java
.util
.List
;
14 import java
.util
.UUID
;
16 import org
.eclipse
.core
.commands
.ExecutionEvent
;
17 import org
.eclipse
.core
.commands
.operations
.IOperationHistory
;
18 import org
.eclipse
.core
.commands
.operations
.IUndoContext
;
19 import org
.eclipse
.e4
.ui
.model
.application
.MApplication
;
20 import org
.eclipse
.e4
.ui
.model
.application
.ui
.basic
.MPart
;
21 import org
.eclipse
.e4
.ui
.model
.application
.ui
.basic
.MPartStack
;
22 import org
.eclipse
.e4
.ui
.workbench
.modeling
.EModelService
;
23 import org
.eclipse
.e4
.ui
.workbench
.modeling
.EPartService
;
24 import org
.eclipse
.e4
.ui
.workbench
.modeling
.EPartService
.PartState
;
25 import org
.eclipse
.jface
.dialogs
.MessageDialog
;
26 import org
.eclipse
.jface
.viewers
.ISelection
;
27 import org
.eclipse
.jface
.viewers
.IStructuredSelection
;
28 import org
.eclipse
.jface
.viewers
.TreeNode
;
29 import org
.eclipse
.swt
.widgets
.Shell
;
30 import org
.eclipse
.ui
.IEditorPart
;
31 import org
.eclipse
.ui
.handlers
.HandlerUtil
;
33 import eu
.etaxonomy
.cdm
.hibernate
.HibernateProxyHelper
;
34 import eu
.etaxonomy
.cdm
.model
.description
.DescriptiveDataSet
;
35 import eu
.etaxonomy
.cdm
.model
.occurrence
.DerivedUnit
;
36 import eu
.etaxonomy
.cdm
.model
.occurrence
.FieldUnit
;
37 import eu
.etaxonomy
.cdm
.model
.occurrence
.SpecimenOrObservationBase
;
38 import eu
.etaxonomy
.cdm
.model
.taxon
.ITaxonTreeNode
;
39 import eu
.etaxonomy
.cdm
.model
.taxon
.Synonym
;
40 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonBase
;
41 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonNode
;
42 import eu
.etaxonomy
.cdm
.persistence
.dto
.TaxonNodeDto
;
43 import eu
.etaxonomy
.cdm
.persistence
.dto
.UuidAndTitleCache
;
44 import eu
.etaxonomy
.taxeditor
.bulkeditor
.e4
.BulkEditor
;
45 import eu
.etaxonomy
.taxeditor
.bulkeditor
.input
.TaxonBulkEditorInput
;
46 import eu
.etaxonomy
.taxeditor
.editor
.descriptiveDataSet
.DescriptiveDataSetEditor
;
47 import eu
.etaxonomy
.taxeditor
.editor
.descriptiveDataSet
.matrix
.CharacterMatrixPart
;
48 import eu
.etaxonomy
.taxeditor
.editor
.e4
.TaxonEditorInput
;
49 import eu
.etaxonomy
.taxeditor
.editor
.group
.authority
.CdmAuthorityEditorInput
;
50 import eu
.etaxonomy
.taxeditor
.editor
.group
.authority
.e4
.CdmAuthorityEditorE4
;
51 import eu
.etaxonomy
.taxeditor
.editor
.internal
.TaxeditorEditorPlugin
;
52 import eu
.etaxonomy
.taxeditor
.editor
.l10n
.Messages
;
53 import eu
.etaxonomy
.taxeditor
.editor
.name
.e4
.TaxonEditor
;
54 import eu
.etaxonomy
.taxeditor
.editor
.view
.checklist
.e4
.DistributionEditorPart
;
55 import eu
.etaxonomy
.taxeditor
.editor
.view
.derivate
.DerivateView
;
56 import eu
.etaxonomy
.taxeditor
.editor
.view
.derivate
.DerivateViewEditorInput
;
57 import eu
.etaxonomy
.taxeditor
.model
.AbstractUtility
;
58 import eu
.etaxonomy
.taxeditor
.model
.MessagingUtils
;
59 import eu
.etaxonomy
.taxeditor
.security
.RequiredPermissions
;
60 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
61 import eu
.etaxonomy
.taxeditor
.workbench
.WorkbenchUtility
;
62 import eu
.etaxonomy
.taxeditor
.workbench
.part
.IE4SavablePart
;
65 * Utility for the editor package
70 public class EditorUtil
extends AbstractUtility
{
72 private static final String NAME_EDITOR_ID
= "eu.etaxonomy.taxeditor.editor.name.e4.TaxonEditor";
74 private static boolean factsVisible
= true;
76 private static boolean mediaVisible
= true;
78 public static void openDescriptiveDataSetEditor(UUID descriptiveDataSetUuid
, EModelService modelService
, EPartService partService
, MApplication application
){
79 Collection
<MPart
> parts
= partService
.getParts();
80 for (MPart part
: parts
) {
81 if(part
.getObject() instanceof DescriptiveDataSetEditor
82 && ((DescriptiveDataSetEditor
) part
.getObject()).getDescriptiveDataSet().getUuid().equals(descriptiveDataSetUuid
)){
83 partService
.showPart(part
, PartState
.ACTIVATE
);
87 String partId
= AppModelId
.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_DESCRIPTIVEDATASET_DESCRIPTIVEDATASETEDITOR
;
88 MPart part
= showPart(partId
, modelService
, partService
, application
);
89 DescriptiveDataSetEditor editor
= (DescriptiveDataSetEditor
) part
.getObject();
90 editor
.init(descriptiveDataSetUuid
);
93 public static void openCharacterMatrix(UUID descriptiveDataSetUuid
, EModelService modelService
, EPartService partService
, MApplication application
){
94 Collection
<MPart
> parts
= partService
.getParts();
95 for (MPart part
: parts
) {
96 if(part
.getObject() instanceof CharacterMatrixPart
97 && ((CharacterMatrixPart
) part
.getObject()).getDescriptiveDataSet().getUuid().equals(descriptiveDataSetUuid
)){
98 partService
.showPart(part
, PartState
.ACTIVATE
);
102 String partId
= AppModelId
.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_DESCRIPTIVEDATASET_MATRIX_CHARACTERMATRIXPART
;
103 MPart part
= showPart(partId
, modelService
, partService
, application
);
104 CharacterMatrixPart editor
= (CharacterMatrixPart
) part
.getObject();
105 editor
.init(descriptiveDataSetUuid
, true);
108 public static void openDistributionEditor(List
<UuidAndTitleCache
<ITaxonTreeNode
>> parentTaxonUuidList
, EModelService modelService
, EPartService partService
, MApplication application
){
109 String partId
= AppModelId
.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_CHECKLIST_E4_DISTRIBUTIONEDITORPART
;
110 checkAndCloseFactsAndMediaParts(partService
);
111 MPart part
= showPart(partId
, modelService
, partService
, application
);
112 DistributionEditorPart editor
= (DistributionEditorPart
) part
.getObject();
113 editor
.init(parentTaxonUuidList
);
116 public static void checkAndCloseFactsAndMediaParts(EPartService partService
) {
117 String partIdFactualData
= AppModelId
.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_DESCRIPTIVE_E4_FACTUALDATAPARTE4
;
118 String partIdMedia
= AppModelId
.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_MEDIA_E4_MEDIAVIEWPARTE4
;
119 MPart part1
= partService
.findPart(AppModelId
.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_DESCRIPTIVE_E4_FACTUALDATAPARTE4
);
120 if (factsVisible
|| (part1
!=null && part1
.getWidget() != null && partService
.isPartVisible(part1
))){
123 factsVisible
= false;
125 part1
= partService
.findPart(AppModelId
.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_MEDIA_E4_MEDIAVIEWPARTE4
);
126 if (mediaVisible
|| (part1
!=null && part1
.getWidget() != null && partService
.isPartVisible(part1
))){
129 mediaVisible
= false;
131 closePart(partIdMedia
, partService
);
132 closePart(partIdFactualData
, partService
);
136 public static void openSpecimenEditor(DerivateViewEditorInput input
, EModelService modelService
, EPartService partService
, MApplication application
){
137 String partId
= AppModelId
.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_DERIVATE_DERIVATEVIEW
;
138 MPart part
= showPart(partId
, modelService
, partService
, application
);
139 DerivateView derivateView
= (DerivateView
) part
.getObject();
140 derivateView
.init(input
);
143 public static void openRightsEditor(CdmAuthorityEditorInput input
, EModelService modelService
, EPartService partService
, MApplication application
){
144 Collection
<MPart
> parts
= partService
.getParts();
145 for (MPart part
: parts
) {
146 if(part
.getObject() instanceof CdmAuthorityEditorE4
147 && ((CdmAuthorityEditorE4
) part
.getObject()).getInput().getGroup().equals(input
.getGroup())){
148 partService
.showPart(part
, PartState
.ACTIVATE
);
152 String partId
= AppModelId
.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_GROUP_AUTHORITY_E4_CDMAUTHORITYEDITORE4
;
153 MPart part
= showPart(partId
, modelService
, partService
, application
);
154 CdmAuthorityEditorE4 authorityView
= (CdmAuthorityEditorE4
) part
.getObject();
155 authorityView
.init(input
);
158 public static MPart
showPart(String partId
, EModelService modelService
, EPartService partService
, MApplication application
){
159 MPart part
= partService
.findPart(partId
);
160 if(part
==null || modelService
.getPartDescriptor(partId
).isAllowMultiple()){
161 part
= partService
.createPart(partId
);
163 MPartStack editorAreaPartStack
= WorkbenchUtility
.getEditorAreaPartStack(application
, modelService
);
164 if(editorAreaPartStack
!=null){
165 editorAreaPartStack
.getChildren().add(part
);
168 return partService
.showPart(part
, PartState
.ACTIVATE
);
171 public static MPart
showPart(String partId
, EModelService modelService
, EPartService partService
){
172 MPart part
= partService
.findPart(partId
);
173 if(part
==null || modelService
.getPartDescriptor(partId
).isAllowMultiple()){
174 part
= partService
.createPart(partId
);
175 partService
.activate(part
);
177 partService
.activate(part
);
183 public static void openTaxonNodeE4(UUID taxonNodeUuid
, EModelService modelService
, EPartService partService
, MApplication application
) {
184 TaxonEditorInput input
= TaxonEditorInput
.NewInstance(taxonNodeUuid
);
185 openTaxonEditor_internal(input
, modelService
, partService
, application
);
188 public static void openTaxonBaseE4(UUID taxonBaseUuid
, EModelService modelService
, EPartService partService
, MApplication application
) {
189 TaxonEditorInput input
= TaxonEditorInput
.NewInstanceFromTaxonBase(taxonBaseUuid
);
190 openTaxonEditor_internal(input
, modelService
, partService
, application
);
193 private static void openTaxonEditor_internal(TaxonEditorInput input
, EModelService modelService
, EPartService partService
, MApplication application
) {
194 TaxonBase
<?
> taxonBase
= input
.getTaxon();
195 TaxonNode node
= input
.getTaxonNode();
196 if(taxonBase
== null){
199 boolean hasPermission
= false;
200 // if (node != null){
201 hasPermission
= CdmStore
.currentAuthentiationHasPermission(node
, RequiredPermissions
.TAXON_EDIT
);
203 // if (!hasPermission){
204 // MessagingUtils.warningDialog(Messages.EditorUtil_MISSING_PERMISSION, TaxonEditorInputE4.class, Messages.EditorUtil_MISSING_PERMISSION_MESSAGE);
207 if (taxonBase
.isOrphaned()) {
208 if(taxonBase
.isInstanceOf(Synonym
.class)){
209 MessagingUtils
.warningDialog(Messages
.EditorUtil_ORPHAN_ACCEPTED_TAXON
, TaxonEditorInput
.class, Messages
.EditorUtil_ORPHAN_ACCEPTED_TAXON_MESSAGE
);
213 MessagingUtils
.warningDialog(Messages
.EditorUtil_ORPHAN_TAXON
, TaxonEditorInput
.class, Messages
.EditorUtil_ORPHAN_TAXON_MESSAGE
);
218 Collection
<MPart
> parts
= partService
.getParts();
219 //check if part is already opened
220 MPart alreadyOpenInOtherClassification
= null;
221 for (MPart part
: parts
) {
222 if(part
.getObject() instanceof TaxonEditor
223 && ((TaxonEditor
) part
.getObject()).getTaxon()!=null
224 && ((TaxonEditor
) part
.getObject()).getTaxon().getUuid().equals(input
.getTaxon().getUuid())){
226 UUID inputNode
= input
.getTaxonNode().getUuid();
227 UUID editorNode
= ((TaxonEditor
) part
.getObject()).getTaxonNode().getUuid();
228 if (!inputNode
.equals(editorNode
)){
229 alreadyOpenInOtherClassification
= part
;
231 ((TaxonEditor
) part
.getObject()).init(input
);
232 partService
.activate(part
, true);
237 if (alreadyOpenInOtherClassification
!= null){
238 boolean doSave
= forceUserSaveE4Editor(((TaxonEditor
) alreadyOpenInOtherClassification
.getObject()), getShell());
240 input
= TaxonEditorInput
.NewInstance(input
.getTaxonNode().getUuid());
241 partService
.hidePart(alreadyOpenInOtherClassification
);
247 MPart part
= showPart(NAME_EDITOR_ID
, modelService
, partService
, application
);
249 TaxonEditor editor
= (TaxonEditor
) part
.getObject();
250 // editor.setDisabled();
252 // editor.setEnabled();
256 public static void showMedia(EModelService modelService
, EPartService partService
) {
257 String partIdFactualData
= AppModelId
.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_MEDIA_E4_MEDIAVIEWPARTE4
;
258 showPart(partIdFactualData
, modelService
, partService
);
261 public static void showFacts(EModelService modelService
, EPartService partService
) {
262 String partIdFactualData
= AppModelId
.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_DESCRIPTIVE_E4_FACTUALDATAPARTE4
;
263 showPart(partIdFactualData
, modelService
, partService
);
266 public static Collection
<MPart
> checkForChanges(UUID taxonUUID
, EPartService partService
){
267 Collection
<MPart
> parts
= partService
.getParts();
268 Collection
<MPart
> dirtyParts
= new HashSet
<>();
269 //check if part is already opened
270 boolean isDirty
= false;
271 for (MPart part
: parts
) {
272 if(part
.getObject() instanceof TaxonEditor
273 && ((TaxonEditor
) part
.getObject()).getTaxon()!=null
274 && ((TaxonEditor
) part
.getObject()).getTaxon().getUuid().equals(taxonUUID
)){
276 dirtyParts
.add(part
);
280 }else if (taxonUUID
== null){
282 dirtyParts
.add(part
);
289 public static Collection
<IE4SavablePart
> checkForTaxonChanges(UUID taxonUUID
, EPartService partService
){
290 Collection
<MPart
> parts
= partService
.getParts();
291 Collection
<IE4SavablePart
> dirtyParts
= new HashSet
<>();
292 //check if part is already opened
293 for (MPart part
: parts
) {
294 if(part
.getObject() instanceof TaxonEditor
295 && ((TaxonEditor
) part
.getObject()).getTaxon()!=null
296 && ((TaxonEditor
) part
.getObject()).getTaxon().getUuid().equals(taxonUUID
)){
298 dirtyParts
.add((IE4SavablePart
) part
);
302 }else if (taxonUUID
== null){
303 if (part
.isDirty() && (part
.getObject() instanceof TaxonEditor
|| (part
.getObject() instanceof BulkEditor
&& ((BulkEditor
)part
.getObject()).getEditorInput() instanceof TaxonBulkEditorInput
))){
304 dirtyParts
.add((IE4SavablePart
) part
.getObject());
312 * An uninitialized taxon is one that hasn't been saved yet. As such, it
313 * should appear in neither the list of recent names nor in the taxonomic
316 * @param parentNodeUuid
317 * a {@link java.util.UUID} object.
319 public static void openEmptyE4(UUID parentNodeUuid
) {
320 TaxonEditorInput input
= TaxonEditorInput
321 .NewEmptyInstance(parentNodeUuid
);
322 EPartService partService
= TaxeditorEditorPlugin
.getDefault().getWorkbench().getActiveWorkbenchWindow().getService(EPartService
.class);
323 MPart part
= partService
.createPart(NAME_EDITOR_ID
);
324 part
= partService
.showPart(part
, PartState
.ACTIVATE
);
325 TaxonEditor editor
= (TaxonEditor
) part
.getObject();
334 * @return a {@link org.eclipse.core.commands.operations.IUndoContext}
337 public static IUndoContext
getUndoContext() {
338 return IOperationHistory
.GLOBAL_UNDO_CONTEXT
;
341 public static boolean isFactsVisible() {
345 public static void setFactsVisible(boolean factsVisible
) {
346 EditorUtil
.factsVisible
= factsVisible
;
349 public static boolean isMediaVisible() {
353 public static void setMediaVisible(boolean mediaVisible
) {
354 EditorUtil
.mediaVisible
= mediaVisible
;
357 public static boolean forceUserSave(IEditorPart editor
, Shell shell
) {
358 if (editor
.isDirty()) {
360 boolean doSave
= MessageDialog
361 .openConfirm(shell
, Messages
.EditorUtil_COMFIRM_SAVE
,
362 Messages
.EditorUtil_CONFIRM_SAVE_MESSAGE
);
368 editor
.doSave(AbstractUtility
.getMonitor());
373 public static boolean forceUserSaveE4Editor(IE4SavablePart editor
, Shell shell
) {
374 if (editor
.isDirty()) {
376 boolean doSave
= MessageDialog
377 .openConfirm(shell
, Messages
.EditorUtil_COMFIRM_SAVE
,
378 Messages
.EditorUtil_CONFIRM_SAVE_MESSAGE
);
384 editor
.save(AbstractUtility
.getMonitor());
395 * a {@link org.eclipse.core.commands.ExecutionEvent} object.
396 * @return a {@link org.eclipse.jface.viewers.IStructuredSelection} object.
398 public static IStructuredSelection
getSelection(ExecutionEvent event
) {
399 IEditorPart activeEditor
= HandlerUtil
.getActiveEditor(event
);
401 return (IStructuredSelection
) activeEditor
.getSite()
402 .getSelectionProvider().getSelection();
410 * @return a {@link java.lang.String} object.
412 public static String
getPluginId() {
413 return TaxeditorEditorPlugin
.PLUGIN_ID
;
417 * Iterates recursively over all originals having the given specimen as a derivate.
418 * The first {@link DerivedUnit} with no more originals or the first {@link FieldUnit} is returned
419 * @param specimen the start element for which the originals are iterated recursively
420 * @return either a FieldUnit or a the topmost DerivedUnit (which can be itself)
422 public static SpecimenOrObservationBase
<?
> getTopMostDerivate(SpecimenOrObservationBase
<?
> specimen
){
426 if(specimen
.isInstanceOf(FieldUnit
.class)){
429 else if(specimen
.isInstanceOf(DerivedUnit
.class)){
430 DerivedUnit derivedUnit
= HibernateProxyHelper
.deproxy(specimen
, DerivedUnit
.class);
431 if(derivedUnit
.getOriginals()!=null
432 && !(derivedUnit
.getOriginals().isEmpty())){
433 for(SpecimenOrObservationBase
<?
> original
:((DerivedUnit
) specimen
).getOriginals()){
434 return getTopMostDerivate(original
);
442 * If the current selection is a single {@link TreeNode} it will be returned.
443 * @param selection the selection to check
444 * @return the selected TreeNode or <code>null</code> if no TreeNode selected
446 public static TreeNode
getTreeNodeOfSelection(ISelection selection
){
447 if(selection
instanceof IStructuredSelection
448 && ((IStructuredSelection
) selection
).size()==1
449 && ((IStructuredSelection
) selection
).getFirstElement() instanceof TreeNode
){
450 return (TreeNode
) ((IStructuredSelection
) selection
).getFirstElement();
456 public static void closeObsoleteEditor(TaxonNodeDto taxonNode
, EPartService partService
){
457 String treeIndex
= taxonNode
.getTreeIndex();
458 Collection
<MPart
> parts
= partService
.getParts();
459 for (MPart part
: parts
) {
460 Object object
= part
.getObject();
461 if(object
instanceof TaxonEditor
){
462 TaxonEditor taxonEditor
= (TaxonEditor
)object
;
463 TaxonNode node
= taxonEditor
.getEditorInput().getTaxonNode();
464 if (node
.treeIndex()!= null){
465 if(node
.treeIndex().startsWith(treeIndex
)){
467 forceUserSaveE4Editor(taxonEditor
, getShell());
469 partService
.hidePart(part
);
472 logger
.debug("The taxonnode of taxon " + node
.getTaxon().getTitleCache() + " uuid: " + node
.getUuid() + " has no treeindex");;
478 public static void closeObsoleteEditorWithChildren(TaxonNodeDto taxonNode
, EPartService partService
){
479 String treeIndex
= taxonNode
.getTreeIndex();
480 Collection
<MPart
> parts
= partService
.getParts();
481 for (MPart part
: parts
) {
482 Object object
= part
.getObject();
483 if(object
instanceof TaxonEditor
){
484 TaxonEditor taxonEditor
= (TaxonEditor
)object
;
485 TaxonNode node
= taxonEditor
.getEditorInput().getTaxonNode();
486 if (node
.treeIndex()!= null){
487 if(node
.treeIndex().startsWith(treeIndex
)){
489 forceUserSaveE4Editor(taxonEditor
, getShell());
491 partService
.hidePart(part
);
494 logger
.debug("The taxonnode of taxon " + node
.getTaxon().getTitleCache() + " uuid: " + node
.getUuid() + " has no treeindex");;
500 public static void closeObsoleteDescriptiveDatasetEditor(UUID datasetUuid
, EPartService partService
){
502 Collection
<MPart
> parts
= partService
.getParts();
503 for (MPart part
: parts
) {
504 Object object
= part
.getObject();
505 if(object
instanceof DescriptiveDataSetEditor
){
506 DescriptiveDataSetEditor editor
= (DescriptiveDataSetEditor
)object
;
507 DescriptiveDataSet descDataSet
= editor
.getDescriptiveDataSet();
508 if(descDataSet
.getUuid().equals(datasetUuid
)){
510 forceUserSaveE4Editor(editor
, getShell());
512 partService
.hidePart(part
);
519 public static void closePart(String partID
, EPartService partService
){
521 Collection
<MPart
> parts
= partService
.getParts();
522 for (MPart part
: parts
) {
523 String elementId
= part
.getElementId();
524 if (elementId
.equals(partID
)){
525 partService
.hidePart(part
);
530 public static void updateEditor(TaxonNode taxonNode
, TaxonEditor editor
){
531 String treeIndex
= taxonNode
.treeIndex();
532 TaxonNode node
= editor
.getEditorInput().getTaxonNode();
533 if(node
.treeIndex().equals(treeIndex
)){
534 TaxonEditorInput input
= TaxonEditorInput
.NewInstance(node
.getUuid());