Project

General

Profile

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

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

    
15
import org.eclipse.core.commands.ExecutionEvent;
16
import org.eclipse.core.commands.operations.IOperationHistory;
17
import org.eclipse.core.commands.operations.IUndoContext;
18
import org.eclipse.e4.ui.model.application.MApplication;
19
import org.eclipse.e4.ui.model.application.ui.basic.MPart;
20
import org.eclipse.e4.ui.model.application.ui.basic.MPartStack;
21
import org.eclipse.e4.ui.workbench.modeling.EModelService;
22
import org.eclipse.e4.ui.workbench.modeling.EPartService;
23
import org.eclipse.e4.ui.workbench.modeling.EPartService.PartState;
24
import org.eclipse.jface.dialogs.MessageDialog;
25
import org.eclipse.jface.viewers.ISelection;
26
import org.eclipse.jface.viewers.IStructuredSelection;
27
import org.eclipse.jface.viewers.TreeNode;
28
import org.eclipse.swt.widgets.Shell;
29
import org.eclipse.ui.IEditorPart;
30
import org.eclipse.ui.handlers.HandlerUtil;
31

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

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

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

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

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

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

    
108

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

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

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

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

    
152
       return part;
153
    }
154

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

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

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

    
169
        EPartService partService = TaxeditorEditorPlugin.getDefault().getWorkbench().getActiveWorkbenchWindow().getService(EPartService.class);
170
        EModelService modelService = TaxeditorEditorPlugin.getDefault().getWorkbench().getActiveWorkbenchWindow().getService(EModelService.class);
171
        openNameEditor_internal(input, modelService, partService, null);
172
    }
173

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

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

    
205
        TaxonNameEditorE4 editor = (TaxonNameEditorE4) part.getObject();
206
        editor.init(input);
207
        String partIdFactualData = AppModelId.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_DESCRIPTIVE_E4_FACTUALDATAPARTE4;
208
        String partIdMedia = AppModelId.PARTDESCRIPTOR_EU_ETAXONOMY_TAXEDITOR_EDITOR_VIEW_MEDIA_E4_MEDIAVIEWPARTE4;
209
        showPart(partIdMedia, modelService, partService);
210
        showPart(partIdFactualData, modelService, partService);
211
    }
212

    
213
    public static MPart checkForChanges(UUID taxonUUID, EPartService partService ){
214
        Collection<MPart> parts = partService.getParts();
215
        //check if part is already opened
216
        boolean isDirty = false;
217
        for (MPart part : parts) {
218
            if(part.getObject() instanceof TaxonNameEditorE4
219
                    && ((TaxonNameEditorE4) part.getObject()).getTaxon()!=null
220
                    && ((TaxonNameEditorE4) part.getObject()).getTaxon().getUuid().equals(taxonUUID)){
221
                if (part.isDirty()){
222
                    return part;
223
                }
224

    
225
                break;
226
            }
227
        }
228
        return null;
229
    }
230

    
231
	/**
232
	 * An uninitialized taxon is one that hasn't been saved yet. As such, it
233
	 * should appear in neither the list of recent names nor in the taxonomic
234
	 * tree when opened.
235
	 *
236
	 * @param parentNodeUuid
237
	 *            a {@link java.util.UUID} object.
238
	 */
239
	public static void openEmptyE4(UUID parentNodeUuid) {
240
		TaxonEditorInputE4 input = TaxonEditorInputE4
241
				.NewEmptyInstance(parentNodeUuid);
242
        EPartService partService = TaxeditorEditorPlugin.getDefault().getWorkbench().getActiveWorkbenchWindow().getService(EPartService.class);
243
        MPart part = partService.createPart(NAME_EDITOR_ID);
244
        part = partService.showPart(part, PartState.ACTIVATE);
245
        TaxonNameEditorE4 editor = (TaxonNameEditorE4) part.getObject();
246
        editor.init(input);
247
	}
248

    
249
	/**
250
	 * <p>
251
	 * getUndoContext
252
	 * </p>
253
	 *
254
	 * @return a {@link org.eclipse.core.commands.operations.IUndoContext}
255
	 *         object.
256
	 */
257
	public static IUndoContext getUndoContext() {
258
		return IOperationHistory.GLOBAL_UNDO_CONTEXT;
259
	}
260

    
261
	/**
262
	 * <p>
263
	 * forceUserSave
264
	 * </p>
265
	 *
266
	 * @param editor
267
	 *            a {@link org.eclipse.ui.IEditorPart} object.
268
	 * @param shell
269
	 *            a {@link org.eclipse.swt.widgets.Shell} object.
270
	 * @return a boolean.
271
	 */
272
	public static boolean forceUserSave(IEditorPart editor, Shell shell) {
273
		if (editor.isDirty()) {
274

    
275
			boolean doSave = MessageDialog
276
					.openConfirm(shell, Messages.EditorUtil_COMFIRM_SAVE,
277
							Messages.EditorUtil_CONFIRM_SAVE_MESSAGE);
278

    
279
			if (!doSave) {
280
				return false;
281
			}
282

    
283
			editor.doSave(AbstractUtility.getMonitor());
284
		}
285
		return true;
286
	}
287

    
288
	public static boolean forceUserSaveE4Editor(TaxonNameEditorE4 editor, Shell shell) {
289
	    if (editor.isDirty()) {
290

    
291
	        boolean doSave = MessageDialog
292
	                .openConfirm(shell, Messages.EditorUtil_COMFIRM_SAVE,
293
	                        Messages.EditorUtil_CONFIRM_SAVE_MESSAGE);
294

    
295
	        if (!doSave) {
296
	            return false;
297
	        }
298

    
299
	        editor.save(AbstractUtility.getMonitor());
300
	    }
301
	    return true;
302
	}
303

    
304
	/**
305
	 * <p>
306
	 * getSelection
307
	 * </p>
308
	 *
309
	 * @param event
310
	 *            a {@link org.eclipse.core.commands.ExecutionEvent} object.
311
	 * @return a {@link org.eclipse.jface.viewers.IStructuredSelection} object.
312
	 */
313
	public static IStructuredSelection getSelection(ExecutionEvent event) {
314
		IEditorPart activeEditor = HandlerUtil.getActiveEditor(event);
315

    
316
		return (IStructuredSelection) activeEditor.getSite()
317
				.getSelectionProvider().getSelection();
318
	}
319

    
320
	/**
321
	 * <p>
322
	 * getPluginId
323
	 * </p>
324
	 *
325
	 * @return a {@link java.lang.String} object.
326
	 */
327
	public static String getPluginId() {
328
		return TaxeditorEditorPlugin.PLUGIN_ID;
329
	}
330

    
331
	/**
332
	 * Iterates recursively over all originals having the given specimen as a derivate.
333
	 * The first {@link DerivedUnit} with no more originals or the first {@link FieldUnit} is returned
334
	 * @param specimen the start element for which the originals are iterated recursively
335
	 * @return either a FieldUnit or a the topmost DerivedUnit (which can be itself)
336
	 */
337
	public static SpecimenOrObservationBase<?> getTopMostDerivate(SpecimenOrObservationBase<?> specimen){
338
	    if(specimen==null){
339
	        return null;
340
	    }
341
	    if(specimen.isInstanceOf(FieldUnit.class)){
342
	        return specimen;
343
	    }
344
	    else if(specimen.isInstanceOf(DerivedUnit.class)){
345
	        DerivedUnit derivedUnit = HibernateProxyHelper.deproxy(specimen, DerivedUnit.class);
346
	        if(derivedUnit.getOriginals()!=null
347
	                && !(derivedUnit.getOriginals().isEmpty())){
348
	            for(SpecimenOrObservationBase<?> original:((DerivedUnit) specimen).getOriginals()){
349
	                return getTopMostDerivate(original);
350
	            }
351
	        }
352
	    }
353
	    return specimen;
354
	}
355

    
356
    /**
357
     * If the current selection is a single {@link TreeNode} it will be returned.
358
     * @param selection the selection to check
359
     * @return the selected TreeNode or <code>null</code> if no TreeNode selected
360
     */
361
    public static TreeNode getTreeNodeOfSelection(ISelection selection){
362
        if(selection instanceof IStructuredSelection
363
                && ((IStructuredSelection) selection).size()==1
364
                && ((IStructuredSelection) selection).getFirstElement() instanceof TreeNode){
365
            return (TreeNode) ((IStructuredSelection) selection).getFirstElement();
366

    
367
        }
368
        return null;
369
    }
370

    
371
    public static void closeObsoleteEditor(TaxonNodeDto taxonNode, EPartService partService){
372
        String treeIndex = taxonNode.getTreeIndex();
373
        Collection<MPart> parts = partService.getParts();
374
        for (MPart part : parts) {
375
            Object object = part.getObject();
376
            if(object instanceof TaxonNameEditorE4){
377
                TaxonNameEditorE4 taxonEditor = (TaxonNameEditorE4)object;
378
                TaxonNode node = taxonEditor.getEditorInput().getTaxonNode();
379
                if (node.treeIndex()!= null){
380
	                if(node.treeIndex().startsWith(treeIndex)){
381
	                    if (part.isDirty()){
382
	                        forceUserSaveE4Editor(taxonEditor, getShell());
383
	                    }
384
	                    partService.hidePart(part);
385
	                }
386
                }else{
387
                	logger.debug("The taxonnode of taxon " + node.getTaxon().getTitleCache() + " uuid: " + node.getUuid() + " has no treeindex");;
388
                }
389
            }
390
        }
391
    }
392

    
393

    
394
    public static void closePart(String partID, EPartService partService){
395

    
396
        Collection<MPart> parts = partService.getParts();
397
        for (MPart part : parts) {
398
            String elementId = part.getElementId();
399
            if (elementId.equals(partID)){
400
                partService.hidePart(part);
401
            }
402
        }
403
    }
404

    
405
    public static void updateEditor(TaxonNode taxonNode, TaxonNameEditorE4 editor){
406
        String treeIndex = taxonNode.treeIndex();
407
        TaxonNode node = editor.getEditorInput().getTaxonNode();
408
        if(node.treeIndex().equals(treeIndex)){
409
        	TaxonEditorInputE4 input = TaxonEditorInputE4.NewInstance(node.getUuid());
410
        	editor.init(input);
411

    
412

    
413
        }
414
    }
415
}
(5-5/9)