Project

General

Profile

Download (18.8 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;
11

    
12
import java.util.Collection;
13
import java.util.HashSet;
14
import java.util.UUID;
15

    
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;
32

    
33
import eu.etaxonomy.cdm.hibernate.HibernateProxyHelper;
34
import eu.etaxonomy.cdm.model.occurrence.DerivedUnit;
35
import eu.etaxonomy.cdm.model.occurrence.FieldUnit;
36
import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;
37
import eu.etaxonomy.cdm.model.taxon.Synonym;
38
import eu.etaxonomy.cdm.model.taxon.TaxonBase;
39
import eu.etaxonomy.cdm.model.taxon.TaxonNode;
40
import eu.etaxonomy.cdm.persistence.dto.TaxonNodeDto;
41
import eu.etaxonomy.taxeditor.bulkeditor.e4.BulkEditorE4;
42
import eu.etaxonomy.taxeditor.bulkeditor.input.TaxonEditorInput;
43
import eu.etaxonomy.taxeditor.editor.descriptiveDataSet.DescriptiveDataSetEditor;
44
import eu.etaxonomy.taxeditor.editor.descriptiveDataSet.matrix.CharacterMatrixPart;
45
import eu.etaxonomy.taxeditor.editor.e4.TaxonEditorInputE4;
46
import eu.etaxonomy.taxeditor.editor.group.authority.CdmAuthorityEditorInput;
47
import eu.etaxonomy.taxeditor.editor.group.authority.e4.CdmAuthorityEditorE4;
48
import eu.etaxonomy.taxeditor.editor.internal.TaxeditorEditorPlugin;
49
import eu.etaxonomy.taxeditor.editor.l10n.Messages;
50
import eu.etaxonomy.taxeditor.editor.name.e4.TaxonNameEditorE4;
51
import eu.etaxonomy.taxeditor.editor.view.checklist.e4.DistributionEditorPart;
52
import eu.etaxonomy.taxeditor.editor.view.derivate.DerivateView;
53
import eu.etaxonomy.taxeditor.editor.view.derivate.DerivateViewEditorInput;
54
import eu.etaxonomy.taxeditor.model.AbstractUtility;
55
import eu.etaxonomy.taxeditor.model.MessagingUtils;
56
import eu.etaxonomy.taxeditor.workbench.WorkbenchUtility;
57

    
58
/**
59
 * Utility for the editor package
60
 *
61
 * @author n.hoffmann
62
 * @created 20.01.2009
63
 * @version 1.0
64
 */
65
public class EditorUtil extends AbstractUtility {
66

    
67
    private static final String NAME_EDITOR_ID = "eu.etaxonomy.taxeditor.editor.name.e4.TaxonNameEditorE4";
68

    
69
    public static void openDescriptiveDataSetEditor(UUID descriptiveDataSetUuid, EModelService modelService, EPartService partService, MApplication application){
70
        Collection<MPart> parts = partService.getParts();
71
        for (MPart part : parts) {
72
            if(part.getObject() instanceof DescriptiveDataSetEditor
73
                && ((DescriptiveDataSetEditor) part.getObject()).getDescriptiveDataSet().getUuid().equals(descriptiveDataSetUuid)){
74
                partService.showPart(part, PartState.ACTIVATE);
75
                return;
76
            }
77
        }
78
        String partId = AppModelId.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_DESCRIPTIVEDATASET_DESCRIPTIVEDATASETEDITOR;
79
        MPart part = showPart(partId, modelService, partService, application);
80
        DescriptiveDataSetEditor editor = (DescriptiveDataSetEditor) part.getObject();
81
        editor.init(descriptiveDataSetUuid);
82
    }
83

    
84
    public static void openCharacterMatrix(UUID descriptiveDataSetUuid, EModelService modelService, EPartService partService, MApplication application){
85
        Collection<MPart> parts = partService.getParts();
86
        for (MPart part : parts) {
87
            if(part.getObject() instanceof CharacterMatrixPart
88
                && ((CharacterMatrixPart) part.getObject()).getDescriptiveDataSet().getUuid().equals(descriptiveDataSetUuid)){
89
                partService.showPart(part, PartState.ACTIVATE);
90
                return;
91
            }
92
        }
93
        String partId = AppModelId.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_DESCRIPTIVEDATASET_MATRIX_CHARACTERMATRIXPART;
94
        MPart part = showPart(partId, modelService, partService, application);
95
        CharacterMatrixPart editor = (CharacterMatrixPart) part.getObject();
96
        editor.init(descriptiveDataSetUuid, true);
97
    }
98

    
99
    public static void openDistributionEditor(UUID parentTaxonUuid, EModelService modelService, EPartService partService, MApplication application){
100
        Collection<MPart> parts = partService.getParts();
101
        String partId = AppModelId.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_CHECKLIST_E4_DISTRIBUTIONEDITORPART;
102
        String partIdFactualData = AppModelId.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_DESCRIPTIVE_E4_FACTUALDATAPARTE4;
103
        String partIdMedia = AppModelId.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_MEDIA_E4_MEDIAVIEWPARTE4;
104
        closePart(partIdMedia, partService);
105
        closePart(partIdFactualData, partService);
106
        MPart part = showPart(partId, modelService, partService, application);
107
        DistributionEditorPart editor = (DistributionEditorPart) part.getObject();
108
        editor.init(parentTaxonUuid);
109
    }
110

    
111

    
112
    public static void openSpecimenEditor(DerivateViewEditorInput input, EModelService modelService, EPartService partService, MApplication application){
113
        String partId = AppModelId.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_DERIVATE_DERIVATEVIEW;
114
        MPart part = showPart(partId, modelService, partService, application);
115
        DerivateView derivateView = (DerivateView) part.getObject();
116
        derivateView.init(input);
117
    }
118

    
119
    public static void openRightsEditor(CdmAuthorityEditorInput input, EModelService modelService, EPartService partService, MApplication application){
120
        Collection<MPart> parts = partService.getParts();
121
        for (MPart part : parts) {
122
            if(part.getObject() instanceof CdmAuthorityEditorE4
123
                && ((CdmAuthorityEditorE4) part.getObject()).getInput().getGroup().equals(input.getGroup())){
124
                partService.showPart(part, PartState.ACTIVATE);
125
                return;
126
            }
127
        }
128
        String partId = AppModelId.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_GROUP_AUTHORITY_E4_CDMAUTHORITYEDITORE4;
129
        MPart part = showPart(partId, modelService, partService, application);
130
        CdmAuthorityEditorE4 authorityView = (CdmAuthorityEditorE4) part.getObject();
131
        authorityView.init(input);
132
    }
133

    
134
    public static MPart showPart(String partId, EModelService modelService, EPartService partService, MApplication application){
135
        MPart part = partService.findPart(partId);
136
        if(part==null || modelService.getPartDescriptor(partId).isAllowMultiple()){
137
            part = partService.createPart(partId);
138
        }
139
        MPartStack editorAreaPartStack = WorkbenchUtility.getEditorAreaPartStack(application, modelService);
140
        if(editorAreaPartStack!=null){
141
            editorAreaPartStack.getChildren().add(part);
142
        }
143
        return partService.showPart(part, PartState.ACTIVATE);
144
    }
145

    
146
    public static MPart showPart(String partId, EModelService modelService, EPartService partService){
147
        MPart part = partService.findPart(partId);
148
        if(part==null || modelService.getPartDescriptor(partId).isAllowMultiple()){
149
            part = partService.createPart(partId);
150
            partService.activate(part);
151
        }else{
152
            partService.activate(part);
153
        }
154

    
155
       return part;
156
    }
157

    
158
	public static void openTaxonNodeE4(UUID taxonNodeUuid, EModelService modelService, EPartService partService, MApplication application) {
159
	    TaxonEditorInputE4 input = TaxonEditorInputE4.NewInstance(taxonNodeUuid);
160
	    openNameEditor_internal(input, modelService, partService, application);
161
	}
162

    
163
	public static void openTaxonBaseE4(UUID taxonBaseUuid, EModelService modelService, EPartService partService, MApplication application) {
164
	    TaxonEditorInputE4 input = TaxonEditorInputE4.NewInstanceFromTaxonBase(taxonBaseUuid);
165
	    openNameEditor_internal(input, modelService, partService, application);
166
	}
167

    
168
    public static void openTaxonBaseE4(UUID taxonBaseUuid) {
169
        //FIXME E4 this can probably be removed when fully migrated
170
        TaxonEditorInputE4 input = TaxonEditorInputE4.NewInstanceFromTaxonBase(taxonBaseUuid);
171

    
172
        EPartService partService = TaxeditorEditorPlugin.getDefault().getWorkbench().getActiveWorkbenchWindow().getService(EPartService.class);
173
        EModelService modelService = TaxeditorEditorPlugin.getDefault().getWorkbench().getActiveWorkbenchWindow().getService(EModelService.class);
174
        openNameEditor_internal(input, modelService, partService, null);
175
    }
176

    
177
    private static void openNameEditor_internal(TaxonEditorInputE4 input, EModelService modelService, EPartService partService, MApplication application) {
178
        TaxonBase taxonBase = input.getTaxon();
179
        if(taxonBase==null){
180
            return;
181
        }
182
        if (taxonBase.isOrphaned()) {
183
            if(taxonBase.isInstanceOf(Synonym.class)){
184
                MessagingUtils.warningDialog(Messages.EditorUtil_ORPHAN_ACCEPTED_TAXON, TaxonEditorInputE4.class, Messages.EditorUtil_ORPHAN_ACCEPTED_TAXON_MESSAGE);
185
                return;
186
            }
187
            else{
188
                MessagingUtils.warningDialog(Messages.EditorUtil_ORPHAN_TAXON, TaxonEditorInputE4.class, Messages.EditorUtil_ORPHAN_TAXON_MESSAGE);
189
                return;
190
            }
191
        }
192

    
193
        Collection<MPart> parts = partService.getParts();
194
        //check if part is already opened
195
        for (MPart part : parts) {
196
        	if(part.getObject() instanceof TaxonNameEditorE4
197
                    && ((TaxonNameEditorE4) part.getObject()).getTaxon()!=null
198
                    && ((TaxonNameEditorE4) part.getObject()).getTaxon().getUuid().equals(input.getTaxon().getUuid())){
199
        	    if (part.isDirty()){
200
        	        forceUserSaveE4Editor(((TaxonNameEditorE4) part.getObject()), getShell());
201
        	    }
202
                partService.hidePart(part);
203
                break;
204
            }
205
        }
206
        MPart part = showPart(NAME_EDITOR_ID, modelService, partService, application);
207

    
208
        TaxonNameEditorE4 editor = (TaxonNameEditorE4) part.getObject();
209
        editor.init(input);
210
        String partIdFactualData = AppModelId.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_DESCRIPTIVE_E4_FACTUALDATAPARTE4;
211
        String partIdMedia = AppModelId.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_MEDIA_E4_MEDIAVIEWPARTE4;
212
        showPart(partIdMedia, modelService, partService);
213
        showPart(partIdFactualData, modelService, partService);
214
        editor.setFocus();
215
    }
216

    
217
    public static Collection<MPart> checkForChanges(UUID taxonUUID, EPartService partService ){
218
        Collection<MPart> parts = partService.getParts();
219
        Collection<MPart> dirtyParts = new HashSet();
220
        //check if part is already opened
221
        boolean isDirty = false;
222
        for (MPart part : parts) {
223
            if(part.getObject() instanceof TaxonNameEditorE4
224
                    && ((TaxonNameEditorE4) part.getObject()).getTaxon()!=null
225
                    && ((TaxonNameEditorE4) part.getObject()).getTaxon().getUuid().equals(taxonUUID)){
226
                if (part.isDirty()){
227
                    dirtyParts.add(part);
228
                }
229

    
230
                break;
231
            }else if (taxonUUID == null){
232
                if (part.isDirty()){
233
                    dirtyParts.add(part);
234
                }
235
            }
236
        }
237
        return dirtyParts;
238
    }
239

    
240
    public static Collection<MPart> checkForTaxonChanges(UUID taxonUUID, EPartService partService ){
241
        Collection<MPart> parts = partService.getParts();
242
        Collection<MPart> dirtyParts = new HashSet();
243
        //check if part is already opened
244
        boolean isDirty = false;
245
        for (MPart part : parts) {
246
            if(part.getObject() instanceof TaxonNameEditorE4
247
                    && ((TaxonNameEditorE4) part.getObject()).getTaxon()!=null
248
                    && ((TaxonNameEditorE4) part.getObject()).getTaxon().getUuid().equals(taxonUUID)){
249
                if (part.isDirty()){
250
                    dirtyParts.add(part);
251
                }
252

    
253
                break;
254
            }else if (taxonUUID == null){
255
                if (part.isDirty() && (part.getObject() instanceof TaxonNameEditorE4 || (part.getObject() instanceof BulkEditorE4 && ((BulkEditorE4)part.getObject()).getEditorInput() instanceof TaxonEditorInput))){
256
                    dirtyParts.add(part);
257
                }
258
            }
259
        }
260
        return dirtyParts;
261
    }
262

    
263
	/**
264
	 * An uninitialized taxon is one that hasn't been saved yet. As such, it
265
	 * should appear in neither the list of recent names nor in the taxonomic
266
	 * tree when opened.
267
	 *
268
	 * @param parentNodeUuid
269
	 *            a {@link java.util.UUID} object.
270
	 */
271
	public static void openEmptyE4(UUID parentNodeUuid) {
272
		TaxonEditorInputE4 input = TaxonEditorInputE4
273
				.NewEmptyInstance(parentNodeUuid);
274
        EPartService partService = TaxeditorEditorPlugin.getDefault().getWorkbench().getActiveWorkbenchWindow().getService(EPartService.class);
275
        MPart part = partService.createPart(NAME_EDITOR_ID);
276
        part = partService.showPart(part, PartState.ACTIVATE);
277
        TaxonNameEditorE4 editor = (TaxonNameEditorE4) part.getObject();
278
        editor.init(input);
279
	}
280

    
281
	/**
282
	 * <p>
283
	 * getUndoContext
284
	 * </p>
285
	 *
286
	 * @return a {@link org.eclipse.core.commands.operations.IUndoContext}
287
	 *         object.
288
	 */
289
	public static IUndoContext getUndoContext() {
290
		return IOperationHistory.GLOBAL_UNDO_CONTEXT;
291
	}
292

    
293
	/**
294
	 * <p>
295
	 * forceUserSave
296
	 * </p>
297
	 *
298
	 * @param editor
299
	 *            a {@link org.eclipse.ui.IEditorPart} object.
300
	 * @param shell
301
	 *            a {@link org.eclipse.swt.widgets.Shell} object.
302
	 * @return a boolean.
303
	 */
304
	public static boolean forceUserSave(IEditorPart editor, Shell shell) {
305
		if (editor.isDirty()) {
306

    
307
			boolean doSave = MessageDialog
308
					.openConfirm(shell, Messages.EditorUtil_COMFIRM_SAVE,
309
							Messages.EditorUtil_CONFIRM_SAVE_MESSAGE);
310

    
311
			if (!doSave) {
312
				return false;
313
			}
314

    
315
			editor.doSave(AbstractUtility.getMonitor());
316
		}
317
		return true;
318
	}
319

    
320
	public static boolean forceUserSaveE4Editor(TaxonNameEditorE4 editor, Shell shell) {
321
	    if (editor.isDirty()) {
322

    
323
	        boolean doSave = MessageDialog
324
	                .openConfirm(shell, Messages.EditorUtil_COMFIRM_SAVE,
325
	                        Messages.EditorUtil_CONFIRM_SAVE_MESSAGE);
326

    
327
	        if (!doSave) {
328
	            return false;
329
	        }
330

    
331
	        editor.save(AbstractUtility.getMonitor());
332
	    }
333
	    return true;
334
	}
335

    
336
	/**
337
	 * <p>
338
	 * getSelection
339
	 * </p>
340
	 *
341
	 * @param event
342
	 *            a {@link org.eclipse.core.commands.ExecutionEvent} object.
343
	 * @return a {@link org.eclipse.jface.viewers.IStructuredSelection} object.
344
	 */
345
	public static IStructuredSelection getSelection(ExecutionEvent event) {
346
		IEditorPart activeEditor = HandlerUtil.getActiveEditor(event);
347

    
348
		return (IStructuredSelection) activeEditor.getSite()
349
				.getSelectionProvider().getSelection();
350
	}
351

    
352
	/**
353
	 * <p>
354
	 * getPluginId
355
	 * </p>
356
	 *
357
	 * @return a {@link java.lang.String} object.
358
	 */
359
	public static String getPluginId() {
360
		return TaxeditorEditorPlugin.PLUGIN_ID;
361
	}
362

    
363
	/**
364
	 * Iterates recursively over all originals having the given specimen as a derivate.
365
	 * The first {@link DerivedUnit} with no more originals or the first {@link FieldUnit} is returned
366
	 * @param specimen the start element for which the originals are iterated recursively
367
	 * @return either a FieldUnit or a the topmost DerivedUnit (which can be itself)
368
	 */
369
	public static SpecimenOrObservationBase<?> getTopMostDerivate(SpecimenOrObservationBase<?> specimen){
370
	    if(specimen==null){
371
	        return null;
372
	    }
373
	    if(specimen.isInstanceOf(FieldUnit.class)){
374
	        return specimen;
375
	    }
376
	    else if(specimen.isInstanceOf(DerivedUnit.class)){
377
	        DerivedUnit derivedUnit = HibernateProxyHelper.deproxy(specimen, DerivedUnit.class);
378
	        if(derivedUnit.getOriginals()!=null
379
	                && !(derivedUnit.getOriginals().isEmpty())){
380
	            for(SpecimenOrObservationBase<?> original:((DerivedUnit) specimen).getOriginals()){
381
	                return getTopMostDerivate(original);
382
	            }
383
	        }
384
	    }
385
	    return specimen;
386
	}
387

    
388
    /**
389
     * If the current selection is a single {@link TreeNode} it will be returned.
390
     * @param selection the selection to check
391
     * @return the selected TreeNode or <code>null</code> if no TreeNode selected
392
     */
393
    public static TreeNode getTreeNodeOfSelection(ISelection selection){
394
        if(selection instanceof IStructuredSelection
395
                && ((IStructuredSelection) selection).size()==1
396
                && ((IStructuredSelection) selection).getFirstElement() instanceof TreeNode){
397
            return (TreeNode) ((IStructuredSelection) selection).getFirstElement();
398

    
399
        }
400
        return null;
401
    }
402

    
403
    public static void closeObsoleteEditor(TaxonNodeDto taxonNode, EPartService partService){
404
        String treeIndex = taxonNode.getTreeIndex();
405
        Collection<MPart> parts = partService.getParts();
406
        for (MPart part : parts) {
407
            Object object = part.getObject();
408
            if(object instanceof TaxonNameEditorE4){
409
                TaxonNameEditorE4 taxonEditor = (TaxonNameEditorE4)object;
410
                TaxonNode node = taxonEditor.getEditorInput().getTaxonNode();
411
                if (node.treeIndex()!= null){
412
	                if(node.treeIndex().startsWith(treeIndex)){
413
	                    if (part.isDirty()){
414
	                        forceUserSaveE4Editor(taxonEditor, getShell());
415
	                    }
416
	                    partService.hidePart(part);
417
	                }
418
                }else{
419
                	logger.debug("The taxonnode of taxon " + node.getTaxon().getTitleCache() + " uuid: " + node.getUuid() + " has no treeindex");;
420
                }
421
            }
422
        }
423
    }
424

    
425

    
426
    public static void closePart(String partID, EPartService partService){
427

    
428
        Collection<MPart> parts = partService.getParts();
429
        for (MPart part : parts) {
430
            String elementId = part.getElementId();
431
            if (elementId.equals(partID)){
432
                partService.hidePart(part);
433
            }
434
        }
435
    }
436

    
437
    public static void updateEditor(TaxonNode taxonNode, TaxonNameEditorE4 editor){
438
        String treeIndex = taxonNode.treeIndex();
439
        TaxonNode node = editor.getEditorInput().getTaxonNode();
440
        if(node.treeIndex().equals(treeIndex)){
441
        	TaxonEditorInputE4 input = TaxonEditorInputE4.NewInstance(node.getUuid());
442
        	editor.init(input);
443

    
444

    
445
        }
446
    }
447

    
448
}
(5-5/9)