1
|
// $Id$
|
2
|
/**
|
3
|
* Copyright (C) 2017 EDIT
|
4
|
* European Distributed Institute of Taxonomy
|
5
|
* http://www.e-taxonomy.eu
|
6
|
*
|
7
|
* The contents of this file are subject to the Mozilla Public License Version 1.1
|
8
|
* See LICENSE.TXT at the top of this package for the full license terms.
|
9
|
*/
|
10
|
package eu.etaxonomy.taxeditor.editor.descriptiveDataSet.character;
|
11
|
|
12
|
import java.util.ArrayList;
|
13
|
import java.util.Arrays;
|
14
|
import java.util.Collection;
|
15
|
import java.util.HashMap;
|
16
|
import java.util.HashSet;
|
17
|
import java.util.Iterator;
|
18
|
import java.util.List;
|
19
|
import java.util.Map;
|
20
|
import java.util.Set;
|
21
|
|
22
|
import javax.annotation.PostConstruct;
|
23
|
import javax.annotation.PreDestroy;
|
24
|
import javax.inject.Inject;
|
25
|
|
26
|
import org.eclipse.core.runtime.IProgressMonitor;
|
27
|
import org.eclipse.e4.ui.di.Focus;
|
28
|
import org.eclipse.e4.ui.di.Persist;
|
29
|
import org.eclipse.e4.ui.di.UISynchronize;
|
30
|
import org.eclipse.e4.ui.model.application.ui.MDirtyable;
|
31
|
import org.eclipse.e4.ui.services.EMenuService;
|
32
|
import org.eclipse.e4.ui.workbench.modeling.ESelectionService;
|
33
|
import org.eclipse.jface.viewers.ISelection;
|
34
|
import org.eclipse.jface.viewers.ISelectionChangedListener;
|
35
|
import org.eclipse.jface.viewers.IStructuredSelection;
|
36
|
import org.eclipse.jface.viewers.SelectionChangedEvent;
|
37
|
import org.eclipse.jface.viewers.StructuredSelection;
|
38
|
import org.eclipse.jface.viewers.TreeSelection;
|
39
|
import org.eclipse.swt.SWT;
|
40
|
import org.eclipse.swt.custom.SashForm;
|
41
|
import org.eclipse.swt.dnd.Transfer;
|
42
|
import org.eclipse.swt.events.ModifyEvent;
|
43
|
import org.eclipse.swt.events.ModifyListener;
|
44
|
import org.eclipse.swt.events.SelectionAdapter;
|
45
|
import org.eclipse.swt.events.SelectionEvent;
|
46
|
import org.eclipse.swt.layout.GridData;
|
47
|
import org.eclipse.swt.layout.GridLayout;
|
48
|
import org.eclipse.swt.widgets.Button;
|
49
|
import org.eclipse.swt.widgets.Composite;
|
50
|
import org.eclipse.swt.widgets.Display;
|
51
|
import org.eclipse.swt.widgets.Text;
|
52
|
import org.eclipse.ui.forms.widgets.FormToolkit;
|
53
|
|
54
|
import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
|
55
|
import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;
|
56
|
import eu.etaxonomy.cdm.api.service.IFeatureNodeService;
|
57
|
import eu.etaxonomy.cdm.api.service.IFeatureTreeService;
|
58
|
import eu.etaxonomy.cdm.api.service.ITermService;
|
59
|
import eu.etaxonomy.cdm.model.common.Representation;
|
60
|
import eu.etaxonomy.cdm.model.description.Character;
|
61
|
import eu.etaxonomy.cdm.model.description.FeatureNode;
|
62
|
import eu.etaxonomy.cdm.model.description.FeatureTree;
|
63
|
import eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap;
|
64
|
import eu.etaxonomy.taxeditor.editor.AppModelId;
|
65
|
import eu.etaxonomy.taxeditor.editor.l10n.Messages;
|
66
|
import eu.etaxonomy.taxeditor.featuretree.CharacterTransfer;
|
67
|
import eu.etaxonomy.taxeditor.featuretree.FeatureNodeTransfer;
|
68
|
import eu.etaxonomy.taxeditor.featuretree.e4.FeatureNodeDragListener;
|
69
|
import eu.etaxonomy.taxeditor.featuretree.e4.FeatureTreeDropAdapter;
|
70
|
import eu.etaxonomy.taxeditor.featuretree.e4.FeatureTreeEditorComposite;
|
71
|
import eu.etaxonomy.taxeditor.featuretree.e4.IFeatureTreeEditor;
|
72
|
import eu.etaxonomy.taxeditor.model.IDirtyMarkable;
|
73
|
import eu.etaxonomy.taxeditor.model.IPartContentHasDetails;
|
74
|
import eu.etaxonomy.taxeditor.model.IPartContentHasSupplementalData;
|
75
|
import eu.etaxonomy.taxeditor.model.MessagingUtils;
|
76
|
import eu.etaxonomy.taxeditor.preference.PreferencesUtil;
|
77
|
import eu.etaxonomy.taxeditor.session.ICdmEntitySession;
|
78
|
import eu.etaxonomy.taxeditor.store.CdmStore;
|
79
|
import eu.etaxonomy.taxeditor.ui.dialog.selection.FeatureTreeSelectionDialog;
|
80
|
import eu.etaxonomy.taxeditor.workbench.part.IE4ViewerPart;
|
81
|
|
82
|
/**
|
83
|
* Editor for combining structure and property terms to characters.
|
84
|
* @author pplitzner
|
85
|
* @date 24.05.2017
|
86
|
*
|
87
|
*/
|
88
|
public class CharacterEditor implements IFeatureTreeEditor,IConversationEnabled, ISelectionChangedListener,
|
89
|
ModifyListener, IE4ViewerPart, IPartContentHasDetails, IPartContentHasSupplementalData, IDirtyMarkable {
|
90
|
|
91
|
private FeatureTreeEditorComposite characterTreeEditorComposite;
|
92
|
private FeatureTreeEditorComposite propertiesTreeEditorComposite;
|
93
|
private FeatureTreeEditorComposite structuresTreeEditorComposite;
|
94
|
private final FormToolkit formToolkit = new FormToolkit(Display.getDefault());
|
95
|
private Button btnAddCharacter;
|
96
|
|
97
|
@Inject
|
98
|
private ESelectionService selService;
|
99
|
|
100
|
@Inject
|
101
|
private UISynchronize sync;
|
102
|
|
103
|
@Inject
|
104
|
private MDirtyable dirty;
|
105
|
|
106
|
private ConversationHolder conversation;
|
107
|
|
108
|
private ICdmEntitySession cdmEntitySession;
|
109
|
private Composite composite;
|
110
|
|
111
|
public CharacterEditor() {
|
112
|
}
|
113
|
|
114
|
/**
|
115
|
* Create contents of the view part.
|
116
|
*/
|
117
|
@PostConstruct
|
118
|
public void createControls(Composite parent, EMenuService menuService ) {
|
119
|
if (CdmStore.isActive()){
|
120
|
if(conversation == null){
|
121
|
conversation = CdmStore.createConversation();
|
122
|
}
|
123
|
if(cdmEntitySession!=null){
|
124
|
cdmEntitySession = CdmStore.getCurrentSessionManager().newSession(this, true);
|
125
|
}
|
126
|
}
|
127
|
else{
|
128
|
return;
|
129
|
}
|
130
|
parent.setLayout(new GridLayout(1, false));
|
131
|
|
132
|
SashForm sashForm = new SashForm(parent, SWT.NONE);
|
133
|
sashForm.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, 1, 1));
|
134
|
formToolkit.adapt(sashForm);
|
135
|
formToolkit.paintBordersFor(sashForm);
|
136
|
|
137
|
composite = new Composite(sashForm, SWT.NONE);
|
138
|
formToolkit.adapt(composite);
|
139
|
formToolkit.paintBordersFor(composite);
|
140
|
GridLayout gl_composite = new GridLayout(1, false);
|
141
|
gl_composite.marginWidth = 0;
|
142
|
composite.setLayout(gl_composite);
|
143
|
|
144
|
structuresTreeEditorComposite = addFeatureTreeEditor(composite);
|
145
|
|
146
|
initFeatureTreeComposite(structuresTreeEditorComposite,
|
147
|
new FeatureNodeDragListener(structuresTreeEditorComposite.getViewer()), null, null, null, null);
|
148
|
|
149
|
structuresTreeEditorComposite.getLabel_title().setText(Messages.CharacterEditor_STRUCTURES);
|
150
|
|
151
|
Composite composite_1 = new Composite(sashForm, SWT.NONE);
|
152
|
formToolkit.adapt(composite_1);
|
153
|
formToolkit.paintBordersFor(composite_1);
|
154
|
GridLayout gl_composite_1 = new GridLayout(1, false);
|
155
|
gl_composite_1.marginWidth = 0;
|
156
|
composite_1.setLayout(gl_composite_1);
|
157
|
|
158
|
propertiesTreeEditorComposite = addFeatureTreeEditor(composite_1);
|
159
|
initFeatureTreeComposite(propertiesTreeEditorComposite,
|
160
|
|
161
|
new CharacterDragListener(structuresTreeEditorComposite.getViewer(), propertiesTreeEditorComposite.getViewer()),
|
162
|
null,
|
163
|
new Transfer[] {CharacterTransfer.getInstance()},
|
164
|
null,
|
165
|
null
|
166
|
|
167
|
);
|
168
|
propertiesTreeEditorComposite.getLabel_title().setText(Messages.CharacterEditor_PROPERTIES);
|
169
|
|
170
|
Composite composite_3 = new Composite(sashForm, SWT.NONE);
|
171
|
formToolkit.adapt(composite_3);
|
172
|
formToolkit.paintBordersFor(composite_3);
|
173
|
GridLayout gl_composite_3 = new GridLayout(2, false);
|
174
|
gl_composite_3.marginWidth = 0;
|
175
|
composite_3.setLayout(gl_composite_3);
|
176
|
|
177
|
btnAddCharacter = new Button(composite_3, SWT.NONE);
|
178
|
btnAddCharacter.setText(">>"); //$NON-NLS-1$
|
179
|
formToolkit.adapt(btnAddCharacter, true, true);
|
180
|
|
181
|
characterTreeEditorComposite = addFeatureTreeEditor(composite_3);
|
182
|
initFeatureTreeComposite(characterTreeEditorComposite, new FeatureNodeDragListener(characterTreeEditorComposite.getViewer()),
|
183
|
new CharacterDropAdapter(this, characterTreeEditorComposite.getViewer(), sync),
|
184
|
|
185
|
new Transfer[] {FeatureNodeTransfer.getInstance(), CharacterTransfer.getInstance()},
|
186
|
this,
|
187
|
this);
|
188
|
|
189
|
characterTreeEditorComposite.getLabel_title().setText(Messages.CharacterEditor_CHARACTERS);
|
190
|
|
191
|
//add context menu to character viewer//create context menu
|
192
|
menuService.registerContextMenu(characterTreeEditorComposite.getViewer().getControl(),
|
193
|
AppModelId.POPUPMENU_EU_ETAXONOMY_TAXEDITOR_EDITOR_POPUPMENU_CHARACTEREDITOR);
|
194
|
|
195
|
init();
|
196
|
}
|
197
|
|
198
|
private FeatureTreeEditorComposite addFeatureTreeEditor(Composite composite_3) {
|
199
|
FeatureTreeEditorComposite featureTreeEditorComposite = new FeatureTreeEditorComposite(composite_3, SWT.NONE);
|
200
|
featureTreeEditorComposite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, 1, 1));
|
201
|
return featureTreeEditorComposite;
|
202
|
}
|
203
|
|
204
|
private void initFeatureTreeComposite(
|
205
|
FeatureTreeEditorComposite featureTreeEditorComposite,
|
206
|
FeatureNodeDragListener featureNodeDragListener,
|
207
|
FeatureTreeDropAdapter featureNodeDropAdapter,
|
208
|
Transfer[] transfers,
|
209
|
ISelectionChangedListener viewerSelectionChangedListener,
|
210
|
ModifyListener modifyListener) {
|
211
|
|
212
|
featureTreeEditorComposite.init(
|
213
|
featureNodeDragListener,
|
214
|
featureNodeDropAdapter,
|
215
|
transfers,
|
216
|
viewerSelectionChangedListener,
|
217
|
new FeatureTreeChooserListener(featureTreeEditorComposite),
|
218
|
modifyListener);
|
219
|
}
|
220
|
|
221
|
@Focus
|
222
|
public void focus(){
|
223
|
if(characterTreeEditorComposite!=null){
|
224
|
characterTreeEditorComposite.getViewer().getControl().setFocus();
|
225
|
}
|
226
|
if(conversation!=null && !conversation.isBound()){
|
227
|
conversation.bind();
|
228
|
}
|
229
|
if(cdmEntitySession != null) {
|
230
|
cdmEntitySession.bind();
|
231
|
}
|
232
|
}
|
233
|
|
234
|
private void init(){
|
235
|
btnAddCharacter.addSelectionListener(new SelectionAdapter() {
|
236
|
@Override
|
237
|
public void widgetSelected(SelectionEvent e) {
|
238
|
ISelection structureTreeSelection = structuresTreeEditorComposite.getViewer().getSelection();
|
239
|
ISelection propertyTreeSelection = propertiesTreeEditorComposite.getViewer().getSelection();
|
240
|
if(structureTreeSelection==null || propertyTreeSelection==null || characterTreeEditorComposite.getFeatureTree()==null){
|
241
|
MessagingUtils.warningDialog(Messages.CharacterEditor_CANNOT_PERFORM_TITLE, CharacterEditor.this,
|
242
|
Messages.CharacterEditor_CANNOT_PERFORM_MESSAGE);
|
243
|
return;
|
244
|
}
|
245
|
Collection<Character> characters = createCharacters((TreeSelection)structureTreeSelection, (TreeSelection)propertyTreeSelection);
|
246
|
for (Character character : characters) {
|
247
|
//add new Character to feature tree
|
248
|
FeatureNode parent = ((FeatureTree) characterTreeEditorComposite.getViewer().getInput()).getRoot();
|
249
|
CdmStore.getService(IFeatureNodeService.class).createChildFeatureNode(parent, character);
|
250
|
}
|
251
|
characterTreeEditorComposite.getViewer().refresh();
|
252
|
}
|
253
|
});
|
254
|
}
|
255
|
|
256
|
public static Collection<Character> createCharacters(TreeSelection structureTreeSelection, TreeSelection propertyTreeSelection){
|
257
|
Set<Character> characters = new HashSet<>();
|
258
|
//get selected structures and properties
|
259
|
Iterator<FeatureNode> structureIterator = structureTreeSelection.iterator();
|
260
|
|
261
|
//create all combinations of structures and properties
|
262
|
while(structureIterator.hasNext()){
|
263
|
FeatureNode structureNode = structureIterator.next();
|
264
|
Iterator<FeatureNode> propertiesIterator = propertyTreeSelection.iterator();
|
265
|
while(propertiesIterator.hasNext()){
|
266
|
FeatureNode propertyNode = propertiesIterator.next();
|
267
|
Representation structureRepresentation = structureNode.getFeature().getRepresentation(PreferencesUtil.getGlobalLanguage());
|
268
|
Representation propertyRepresentation = propertyNode.getFeature().getRepresentation(PreferencesUtil.getGlobalLanguage());
|
269
|
String label = null;
|
270
|
String abbrevLabel = null;
|
271
|
if(structureRepresentation.getLabel()!=null && propertyRepresentation.getLabel()!=null){
|
272
|
label = structureRepresentation.getLabel()+" "+propertyRepresentation.getLabel();
|
273
|
}
|
274
|
if(structureRepresentation.getAbbreviatedLabel()!=null && propertyRepresentation.getAbbreviatedLabel()!=null){
|
275
|
abbrevLabel = structureRepresentation.getAbbreviatedLabel()+" "+propertyRepresentation.getAbbreviatedLabel();
|
276
|
}
|
277
|
//create new Character
|
278
|
Character character = Character.NewInstance(structureNode, propertyNode, null, label, abbrevLabel);
|
279
|
characters.add(character);
|
280
|
}
|
281
|
}
|
282
|
return characters;
|
283
|
}
|
284
|
|
285
|
@Override
|
286
|
@Persist
|
287
|
public void save(IProgressMonitor monitor){
|
288
|
if (!conversation.isBound()) {
|
289
|
conversation.bind();
|
290
|
}
|
291
|
|
292
|
// commit the conversation and start a new transaction immediately
|
293
|
conversation.commit(true);
|
294
|
|
295
|
FeatureTree featureTree = characterTreeEditorComposite.getFeatureTree();
|
296
|
if(featureTree!=null){
|
297
|
//save characters because they can be modified in this editor
|
298
|
featureTree.getDistinctFeatures().forEach(character->CdmStore.getService(ITermService.class).merge(character,true));
|
299
|
}
|
300
|
CdmStore.getService(IFeatureTreeService.class).saveOrUpdate(featureTree);
|
301
|
|
302
|
|
303
|
dirty.setDirty(false);
|
304
|
}
|
305
|
|
306
|
@Override
|
307
|
public boolean isDirty() {
|
308
|
return dirty.isDirty();
|
309
|
}
|
310
|
|
311
|
@PreDestroy
|
312
|
public void dispose(){
|
313
|
if(conversation!=null){
|
314
|
conversation.close();
|
315
|
conversation = null;
|
316
|
}
|
317
|
if(cdmEntitySession != null) {
|
318
|
cdmEntitySession.dispose();
|
319
|
cdmEntitySession = null;
|
320
|
}
|
321
|
dirty.setDirty(false);
|
322
|
}
|
323
|
|
324
|
@Override
|
325
|
public Map<Object, List<String>> getPropertyPathsMap() {
|
326
|
List<String> propertyPaths = Arrays.asList(new String[] {
|
327
|
"children", //$NON-NLS-1$
|
328
|
"feature", //$NON-NLS-1$
|
329
|
"featureTree", //$NON-NLS-1$
|
330
|
});
|
331
|
Map<Object, List<String>> propertyPathMap =
|
332
|
new HashMap<Object, List<String>>();
|
333
|
propertyPathMap.put(FeatureNode.class,propertyPaths);
|
334
|
return propertyPathMap;
|
335
|
}
|
336
|
|
337
|
@Override
|
338
|
public List<FeatureTree> getRootEntities() {
|
339
|
List<FeatureTree> root = new ArrayList<>();
|
340
|
root.add(characterTreeEditorComposite.getFeatureTree());
|
341
|
return root;
|
342
|
}
|
343
|
|
344
|
@Override
|
345
|
public ICdmEntitySession getCdmEntitySession() {
|
346
|
return cdmEntitySession;
|
347
|
}
|
348
|
|
349
|
@Focus
|
350
|
public void setFocus() {
|
351
|
if(conversation!=null && !conversation.isBound()){
|
352
|
conversation.bind();
|
353
|
}
|
354
|
}
|
355
|
|
356
|
@Override
|
357
|
public void selectionChanged(SelectionChangedEvent event) {
|
358
|
//propagate selection
|
359
|
selService.setSelection(event.getSelection());
|
360
|
}
|
361
|
|
362
|
|
363
|
@Override
|
364
|
public void modifyText(ModifyEvent e) {
|
365
|
characterTreeEditorComposite.getFeatureTree().setTitleCache(((Text) e.widget).getText(), true);
|
366
|
setDirty();
|
367
|
}
|
368
|
|
369
|
|
370
|
private void setDirty() {
|
371
|
dirty.setDirty(true);
|
372
|
}
|
373
|
|
374
|
@Override
|
375
|
public IStructuredSelection getSelection() {
|
376
|
return (IStructuredSelection) characterTreeEditorComposite.getViewer().getSelection();
|
377
|
}
|
378
|
|
379
|
public FeatureTree getCharacterTree(){
|
380
|
return characterTreeEditorComposite.getFeatureTree();
|
381
|
}
|
382
|
|
383
|
@Override
|
384
|
public void refresh(){
|
385
|
structuresTreeEditorComposite.getViewer().refresh();
|
386
|
propertiesTreeEditorComposite.getViewer().refresh();
|
387
|
characterTreeEditorComposite.getViewer().refresh();
|
388
|
}
|
389
|
|
390
|
private class FeatureTreeChooserListener extends SelectionAdapter{
|
391
|
FeatureTreeEditorComposite featureTreeEditorComposite;
|
392
|
|
393
|
public FeatureTreeChooserListener(FeatureTreeEditorComposite featureTreeEditorComposite) {
|
394
|
super();
|
395
|
this.featureTreeEditorComposite = featureTreeEditorComposite;
|
396
|
}
|
397
|
|
398
|
@Override
|
399
|
public void widgetSelected(SelectionEvent e) {
|
400
|
FeatureTree tree = FeatureTreeSelectionDialog.select(featureTreeEditorComposite.getDisplay().getActiveShell(), //conversation,
|
401
|
null);
|
402
|
if(tree!=null){
|
403
|
featureTreeEditorComposite.setSelectedTree(tree);
|
404
|
featureTreeEditorComposite.getText_title().setEnabled(false);
|
405
|
}
|
406
|
}
|
407
|
}
|
408
|
|
409
|
@Override
|
410
|
public void update(CdmDataChangeMap arg0) {
|
411
|
}
|
412
|
|
413
|
@Override
|
414
|
public ConversationHolder getConversationHolder() {
|
415
|
return conversation;
|
416
|
}
|
417
|
|
418
|
@Override
|
419
|
public void changed(Object element) {
|
420
|
setDirty();
|
421
|
}
|
422
|
|
423
|
@Override
|
424
|
public void forceDirty() {
|
425
|
setDirty();
|
426
|
}
|
427
|
|
428
|
@Override
|
429
|
public boolean postOperation(Object objectAffectedByOperation) {
|
430
|
characterTreeEditorComposite.getViewer().refresh();
|
431
|
if(objectAffectedByOperation instanceof FeatureNode){
|
432
|
StructuredSelection selection = new StructuredSelection(objectAffectedByOperation);
|
433
|
characterTreeEditorComposite.getViewer().setSelection(selection);
|
434
|
}
|
435
|
return true;
|
436
|
}
|
437
|
|
438
|
@Override
|
439
|
public boolean onComplete() {
|
440
|
return false;
|
441
|
}
|
442
|
|
443
|
}
|