1 package eu
.etaxonomy
.taxeditor
.editor
.view
.derivate
;
3 import java
.util
.ArrayList
;
4 import java
.util
.Arrays
;
5 import java
.util
.Collection
;
6 import java
.util
.Collections
;
7 import java
.util
.HashMap
;
8 import java
.util
.HashSet
;
12 import java
.util
.UUID
;
14 import javax
.annotation
.PostConstruct
;
15 import javax
.annotation
.PreDestroy
;
16 import javax
.inject
.Inject
;
17 import javax
.inject
.Named
;
19 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
20 import org
.eclipse
.e4
.core
.di
.annotations
.Optional
;
21 import org
.eclipse
.e4
.ui
.di
.Focus
;
22 import org
.eclipse
.e4
.ui
.di
.Persist
;
23 import org
.eclipse
.e4
.ui
.model
.application
.ui
.MDirtyable
;
24 import org
.eclipse
.e4
.ui
.model
.application
.ui
.basic
.MPart
;
25 import org
.eclipse
.e4
.ui
.services
.EMenuService
;
26 import org
.eclipse
.e4
.ui
.services
.IServiceConstants
;
27 import org
.eclipse
.e4
.ui
.workbench
.modeling
.EPartService
;
28 import org
.eclipse
.e4
.ui
.workbench
.modeling
.ESelectionService
;
29 import org
.eclipse
.jface
.util
.LocalSelectionTransfer
;
30 import org
.eclipse
.jface
.viewers
.AbstractTreeViewer
;
31 import org
.eclipse
.jface
.viewers
.ISelection
;
32 import org
.eclipse
.jface
.viewers
.ISelectionChangedListener
;
33 import org
.eclipse
.jface
.viewers
.IStructuredSelection
;
34 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
35 import org
.eclipse
.jface
.viewers
.TreeNode
;
36 import org
.eclipse
.jface
.viewers
.TreeSelection
;
37 import org
.eclipse
.jface
.viewers
.TreeViewer
;
38 import org
.eclipse
.swt
.SWT
;
39 import org
.eclipse
.swt
.dnd
.DND
;
40 import org
.eclipse
.swt
.dnd
.Transfer
;
41 import org
.eclipse
.swt
.layout
.GridData
;
42 import org
.eclipse
.swt
.layout
.GridLayout
;
43 import org
.eclipse
.swt
.widgets
.Composite
;
44 import org
.eclipse
.swt
.widgets
.Tree
;
45 import org
.eclipse
.ui
.IMemento
;
47 import eu
.etaxonomy
.cdm
.api
.conversation
.ConversationHolder
;
48 import eu
.etaxonomy
.cdm
.api
.conversation
.IConversationEnabled
;
49 import eu
.etaxonomy
.cdm
.api
.service
.IOccurrenceService
;
50 import eu
.etaxonomy
.cdm
.hibernate
.HibernateProxyHelper
;
51 import eu
.etaxonomy
.cdm
.model
.common
.CdmBase
;
52 import eu
.etaxonomy
.cdm
.model
.molecular
.SingleRead
;
53 import eu
.etaxonomy
.cdm
.model
.occurrence
.FieldUnit
;
54 import eu
.etaxonomy
.cdm
.model
.occurrence
.SpecimenOrObservationBase
;
55 import eu
.etaxonomy
.cdm
.model
.taxon
.Taxon
;
56 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonNode
;
57 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
58 import eu
.etaxonomy
.taxeditor
.editor
.EditorUtil
;
59 import eu
.etaxonomy
.taxeditor
.editor
.MultiPageTaxonEditor
;
60 import eu
.etaxonomy
.taxeditor
.editor
.l10n
.Messages
;
61 import eu
.etaxonomy
.taxeditor
.editor
.view
.derivate
.searchFilter
.DerivateSearchCompositeController
;
62 import eu
.etaxonomy
.taxeditor
.model
.AbstractUtility
;
63 import eu
.etaxonomy
.taxeditor
.model
.IContextListener
;
64 import eu
.etaxonomy
.taxeditor
.model
.IDirtyMarkable
;
65 import eu
.etaxonomy
.taxeditor
.model
.IPartContentHasDetails
;
66 import eu
.etaxonomy
.taxeditor
.model
.IPartContentHasFactualData
;
67 import eu
.etaxonomy
.taxeditor
.model
.IPartContentHasMedia
;
68 import eu
.etaxonomy
.taxeditor
.model
.IPartContentHasSupplementalData
;
69 import eu
.etaxonomy
.taxeditor
.model
.MessagingUtils
;
70 import eu
.etaxonomy
.taxeditor
.operation
.IPostOperationEnabled
;
71 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySession
;
72 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySessionEnabled
;
73 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
74 import eu
.etaxonomy
.taxeditor
.view
.derivateSearch
.DerivateContentProvider
;
75 import eu
.etaxonomy
.taxeditor
.view
.derivateSearch
.DerivateLabelProvider
;
76 import eu
.etaxonomy
.taxeditor
.workbench
.part
.IE4SavablePart
;
79 * Displays the derivate hierarchy of the specimen specified in the editor input.
82 public class DerivateView
implements IPartContentHasFactualData
, IConversationEnabled
,
83 ICdmEntitySessionEnabled
, IDirtyMarkable
, IPostOperationEnabled
, IPartContentHasDetails
, IPartContentHasSupplementalData
, IPartContentHasMedia
,
84 IContextListener
, IE4SavablePart
{
86 private static final String SPECIMEN_EDITOR
= Messages
.DerivateView_SPECIMEN_EDITOR
;
88 public static final String ID
= "eu.etaxonomy.taxeditor.editor.view.derivate.DerivateView"; //$NON-NLS-1$
89 public static final String INPUT_ID
= ID
+".editorInput"; //$NON-NLS-1$
91 public static final String YOU_NEED_TO_SAVE_BEFORE_PERFORMING_THIS_ACTION
= Messages
.DerivateView_YOU_NEED_TO_SAVE
;
92 public static final String VIEW_HAS_UNSAVED_CHANGES
= Messages
.DerivateView_UNSAVED_CHANGES
;
94 private static final List
<String
> SPECIMEN_INIT_STRATEGY
= Arrays
.asList(new String
[] {
95 "descriptions", //$NON-NLS-1$
96 "annotations", //$NON-NLS-1$
97 "markers", //$NON-NLS-1$
98 "credits", //$NON-NLS-1$
99 "extensions", //$NON-NLS-1$
100 "rights", //$NON-NLS-1$
101 "sources", //$NON-NLS-1$
102 "derivationEvents.derivatives.annotations", //$NON-NLS-1$
103 "derivationEvents.derivatives.markers", //$NON-NLS-1$
104 "derivationEvents.derivatives.credits", //$NON-NLS-1$
105 "derivationEvents.derivatives.extensions", //$NON-NLS-1$
106 "derivationEvents.derivatives.rights", //$NON-NLS-1$
107 "derivationEvents.derivatives.sources" //$NON-NLS-1$
110 private static final int WARN_THRESHOLD
= 200;
113 private ConversationHolder conversation
;
115 private TreeViewer viewer
;
117 private final int dndOperations
= DND
.DROP_MOVE
;
119 private DerivateLabelProvider labelProvider
;
121 private DerivateContentProvider contentProvider
;
123 private DerivateSearchCompositeController derivateSearchCompositeController
;
126 * A map with keys being the derivative entities belonging to the {@link UUID}s passed to the constructor
127 * and values being the root elements of the hierarchy (may be the same objects as the derivative entities)
129 private Map
<SpecimenOrObservationBase
<?
>, SpecimenOrObservationBase
<?
>> derivateToRootEntityMap
;
132 * The set of root elements
134 private Set
<SpecimenOrObservationBase
<?
>> rootElements
;
136 private ICdmEntitySession cdmEntitySession
;
139 * <code>true</code> if this view is listening to selection changes
141 private boolean listenToSelectionChange
;
143 private Taxon selectedTaxon
;
146 private ESelectionService selService
;
149 private MDirtyable dirty
;
152 private EPartService partService
;
154 private ISelectionChangedListener selectionChangedListener
;
157 * Default constructor
160 public DerivateView() {
166 public void init(DerivateViewEditorInput editorInput
){
167 this.derivateToRootEntityMap
= new HashMap
<SpecimenOrObservationBase
<?
>, SpecimenOrObservationBase
<?
>>();
168 this.rootElements
= new HashSet
<SpecimenOrObservationBase
<?
>>();
171 Collection
<UUID
> derivativeUuids
= editorInput
.getDerivativeUuids();
172 checkWarnThreshold(derivativeUuids
);
173 updateRootEntities(derivativeUuids
);
175 derivateSearchCompositeController
.setTaxonFilter(editorInput
.getTaxonUuid());
178 // getEditorSite().getActionBars().getStatusLineManager().setMessage(""); //$NON-NLS-1$
182 public void createPartControl(Composite parent
, EMenuService menuService
) {
183 if (CdmStore
.isActive()){
184 if(conversation
== null){
185 conversation
= CdmStore
.createConversation();
187 if(cdmEntitySession
!=null){
188 cdmEntitySession
= CdmStore
.getCurrentSessionManager().newSession(this, true);
194 //listen to context changes
195 CdmStore
.getContextManager().addContextListener(this);
197 parent
.setLayout(new GridLayout());
199 //---search and filter---
200 derivateSearchCompositeController
= new DerivateSearchCompositeController(parent
, this);
201 GridData gridDataSearchBar
= new GridData();
202 gridDataSearchBar
.horizontalAlignment
= GridData
.FILL
;
203 gridDataSearchBar
.grabExcessHorizontalSpace
= true;
204 derivateSearchCompositeController
.setLayoutData(gridDataSearchBar
);
205 derivateSearchCompositeController
.setEnabled(CdmStore
.isActive());
208 viewer
= new TreeViewer(new Tree(parent
, SWT
.MULTI
| SWT
.H_SCROLL
| SWT
.V_SCROLL
| SWT
.FULL_SELECTION
));
209 GridData gridDataTree
= new GridData();
210 gridDataTree
.horizontalAlignment
= GridData
.FILL
;
211 gridDataTree
.verticalAlignment
= GridData
.FILL
;
212 gridDataTree
.grabExcessVerticalSpace
= true;
213 gridDataTree
.grabExcessHorizontalSpace
= true;
214 viewer
.getTree().setLayoutData(gridDataTree
);
215 contentProvider
= new DerivateContentProvider();
216 viewer
.setContentProvider(contentProvider
);
217 labelProvider
= new DerivateLabelProvider();
218 labelProvider
.setConversation(conversation
);
219 viewer
.setLabelProvider(labelProvider
);
220 viewer
.setAutoExpandLevel(AbstractTreeViewer
.ALL_LEVELS
);
221 viewer
.getTree().setEnabled(CdmStore
.isActive());
223 //propagate selection
224 selectionChangedListener
= (event
-> selService
.setSelection(AbstractUtility
.getElementsFromSelectionChangedEvent(event
)));
225 viewer
.addSelectionChangedListener(selectionChangedListener
);
227 //create context menu
228 menuService
.registerContextMenu(viewer
.getControl(), "eu.etaxonomy.taxeditor.editor.popupmenu.specimeneditor");
230 //add drag'n'drop support
231 Transfer
[] transfers
= new Transfer
[] {LocalSelectionTransfer
.getTransfer(),};
232 viewer
.addDragSupport(dndOperations
, transfers
, new DerivateDragListener(this));
233 viewer
.addDropSupport(dndOperations
, transfers
, new DerivateDropListener(this));
236 public void updateRootEntities() {
237 updateRootEntities((Collection
)null);
240 public void updateRootEntities(Collection
<UUID
> derivativeUuids
) {
241 if(conversation
!=null){
242 if (!conversation
.isBound()) {
246 * If the active session is not the session of the Derivative Editor
247 * then we will save the active session for later, bind temporarily
248 * to our session and rebind to the original session when we are
249 * done. This happens e.g. if a selection change happens in the
250 * taxon editor and "Link with editor" is enabled. The selection
251 * change event and thus the loading in updateRootEntities() happens
252 * in the session of the taxon editor.
254 ICdmEntitySession previousCdmEntitySession
= CdmStore
.getCurrentSessionManager().getActiveSession();
255 if(cdmEntitySession
!= null) {
256 cdmEntitySession
.bind();
259 List
<SpecimenOrObservationBase
> derivates
= null;
260 if(derivativeUuids
!=null){
261 this.derivateToRootEntityMap
= new HashMap
<SpecimenOrObservationBase
<?
>, SpecimenOrObservationBase
<?
>>();
262 this.rootElements
= new HashSet
<SpecimenOrObservationBase
<?
>>();
263 derivates
= CdmStore
.getService(IOccurrenceService
.class).load(new ArrayList(derivativeUuids
), SPECIMEN_INIT_STRATEGY
);
265 updateRootEntities(derivates
);
266 previousCdmEntitySession
.bind();
271 public void updateRootEntities(List
<SpecimenOrObservationBase
> derivates
) {
273 this.derivateToRootEntityMap
= new HashMap
<SpecimenOrObservationBase
<?
>, SpecimenOrObservationBase
<?
>>();
274 this.rootElements
= new HashSet
<SpecimenOrObservationBase
<?
>>();
275 for (SpecimenOrObservationBase derivate
: derivates
) {
277 if(derivate
instanceof FieldUnit
){
278 derivateToRootEntityMap
.put(derivate
, derivate
);
281 SpecimenOrObservationBase
<?
> topMostDerivate
= EditorUtil
.getTopMostDerivate(derivate
);
282 if(topMostDerivate
!=null){
283 derivateToRootEntityMap
.put(derivate
, topMostDerivate
);
286 derivateToRootEntityMap
.put(derivate
, derivate
);
290 for (SpecimenOrObservationBase
<?
> specimen
: derivateToRootEntityMap
.values()) {
291 rootElements
.add(specimen
);
294 labelProvider
.updateLabelCache(rootElements
);
295 viewer
.setInput(rootElements
);
298 // getEditorSite().getActionBars().getStatusLineManager().setMessage(String.format(Messages.DerivateView_CNT_DERIVATIVES_FOUND, rootElements.size()));
300 //set selection to derivatives if the filter criteria
301 //taxon assignment or derivative type are set
302 if(derivates
!=null && !derivateSearchCompositeController
.isDefaultSearch()){
303 List
<TreeNode
> nodesToSelect
= new ArrayList
<TreeNode
>();
304 for (SpecimenOrObservationBase specimenOrObservationBase
: derivates
) {
305 nodesToSelect
.add(new TreeNode(specimenOrObservationBase
));
307 setSelection(new StructuredSelection(nodesToSelect
));
314 private void setSelection(StructuredSelection selection
){
315 viewer
.removeSelectionChangedListener(selectionChangedListener
);
316 viewer
.setSelection(selection
);
317 viewer
.addSelectionChangedListener(selectionChangedListener
);
320 public void updateLabelCache(){
321 labelProvider
.updateLabelCache(rootElements
);
326 public void save(IProgressMonitor monitor
) {
327 String taskName
= Messages
.DerivateView_SAVING_HIERARCHY
;
328 monitor
.beginTask(taskName
, 3);
329 if (!conversation
.isBound()) {
334 // commit the conversation and start a new transaction immediately
335 conversation
.commit(true);
337 CdmStore
.getService(IOccurrenceService
.class).merge(new ArrayList
<SpecimenOrObservationBase
>(rootElements
), true);
341 this.setDirty(false);
344 dirty
.setDirty(false);
349 * @param isDirty the isDirty to set
351 public void setDirty(boolean isDirty
) {
352 dirty
.setDirty(isDirty
);
356 public void setFocus() {
357 //make sure to bind again if maybe in another view the conversation was unbound
358 if(conversation
!=null && !conversation
.isBound()){
361 if(cdmEntitySession
!= null) {
362 cdmEntitySession
.bind();
364 if(derivateSearchCompositeController
!=null) {
365 derivateSearchCompositeController
.setFocusOnSearchField();
370 public void update(CdmDataChangeMap changeEvents
) {
374 public ConversationHolder
getConversationHolder() {
379 public void changed(Object element
) {
381 //firePropertyChange(IEditorPart.PROP_DIRTY);
382 viewer
.update(new TreeNode(element
), null);
386 public void forceDirty() {
391 public Map
<Object
, List
<String
>> getPropertyPathsMap() {
392 List
<String
> specimenPropertyPaths
= Arrays
.asList(new String
[] {
393 "descriptions", //$NON-NLS-1$
394 "derivationEvents.derivates", //$NON-NLS-1$
395 "annotations", //$NON-NLS-1$
396 "markers", //$NON-NLS-1$
397 "credits", //$NON-NLS-1$
398 "extensions", //$NON-NLS-1$
399 "rights", //$NON-NLS-1$
400 "sources" //$NON-NLS-1$
402 Map
<Object
, List
<String
>> specimenPropertyPathMap
=
403 new HashMap
<Object
, List
<String
>>();
404 specimenPropertyPathMap
.put(SpecimenOrObservationBase
.class,specimenPropertyPaths
);
405 return specimenPropertyPathMap
;
409 * Refreshes the derivate hierarchy tree and expands the tree
410 * to show and select the given object.
412 * @param expandTo the object to which the tree should be expanded
414 public void refreshTree(Object expandTo
){
416 TreeSelection selection
= (TreeSelection
) viewer
.getSelection();
417 viewer
.expandToLevel(selection
.getFirstElement(), 1);
418 viewer
.setSelection(new StructuredSelection(new TreeNode(expandTo
)));
422 * Refreshes the derivate hierarchy tree
424 public void refreshTree(){
425 if(!viewer
.getTree().isDisposed()){
430 //FIXME:Remoting hack to make this work for remoting
431 //This should actually be resolved using remoting post operations
432 public void remove(Object obj
) {
433 if (obj
instanceof TreeNode
){
434 obj
= ((TreeNode
)obj
).getValue();
436 rootElements
.remove(obj
);
437 Object o
= this.derivateToRootEntityMap
.remove(obj
);
438 viewer
.setInput(rootElements
);
442 * @return a set of {@link SingleRead}s that have multiple parents
444 public Set
<SingleRead
> getMultiLinkSingleReads() {
445 return DerivateLabelProvider
.getMultiLinkSingleReads();
448 public Object
getSelectionInput() {
449 return selectedTaxon
;
452 public DerivateLabelProvider
getLabelProvider() {
453 return labelProvider
;
457 public boolean postOperation(CdmBase objectAffectedByOperation
) {
459 if(objectAffectedByOperation
!=null){
460 changed(objectAffectedByOperation
);
466 public boolean onComplete() {
472 public boolean canAttachMedia() {
476 public void addFieldUnit(FieldUnit fieldUnit
) {
477 rootElements
.add(fieldUnit
);
478 derivateToRootEntityMap
.put(fieldUnit
, fieldUnit
);
482 public ICdmEntitySession
getCdmEntitySession() {
483 return cdmEntitySession
;
487 public void dispose() {
488 if(conversation
!=null){
489 conversation
.close();
491 if(cdmEntitySession
!= null) {
492 cdmEntitySession
.dispose();
499 public void selectionChanged(@Optional @Named(IServiceConstants
.ACTIVE_SELECTION
) ISelection selection
,
500 @Named(IServiceConstants
.ACTIVE_PART
) MPart activePart
, MPart thisPart
)
502 if(activePart
== thisPart
|| viewer
==null){
505 if(viewer
.getTree().isDisposed()){
508 if(listenToSelectionChange
){
509 selectedTaxon
= null;
510 if(activePart
instanceof MultiPageTaxonEditor
){
511 selectedTaxon
= ((MultiPageTaxonEditor
) activePart
).getTaxon();
513 else if(selection
instanceof IStructuredSelection
){
514 Object selectedElement
= ((IStructuredSelection
) selection
).getFirstElement();
515 if(selectedElement
instanceof CdmBase
){
516 if(((CdmBase
) selectedElement
).isInstanceOf(TaxonNode
.class)){
517 selectedTaxon
= HibernateProxyHelper
.deproxy(selectedElement
, TaxonNode
.class).getTaxon();
519 else if(((CdmBase
) selectedElement
).isInstanceOf(Taxon
.class)){
520 selectedTaxon
= HibernateProxyHelper
.deproxy(selectedElement
, Taxon
.class);
524 if(selectedTaxon
!=null){
525 Collection
<SpecimenOrObservationBase
> fieldUnits
= CdmStore
.getService(IOccurrenceService
.class).listFieldUnitsByAssociatedTaxon(selectedTaxon
, null, null);
526 Collection
<UUID
> uuids
= new HashSet
<UUID
>();
527 for (SpecimenOrObservationBase specimenOrObservationBase
: fieldUnits
) {
528 uuids
.add(specimenOrObservationBase
.getUuid());
530 checkWarnThreshold(uuids
);
531 updateRootEntities(uuids
);
533 thisPart
.setLabel(SPECIMEN_EDITOR
+": " + selectedTaxon
.getName()); //$NON-NLS-1$
536 updateRootEntities((Collection
<UUID
>)Collections
.EMPTY_LIST
);
541 private void checkWarnThreshold(Collection
<UUID
> uuids
) {
542 if(uuids
!=null && uuids
.size()>WARN_THRESHOLD
){
543 MessagingUtils
.warningDialog(Messages
.DerivateView_PERF_WARNING
, this.getClass(), String
.format(Messages
.DerivateView_PERF_WARNING_MESSAGE
, uuids
.size()));
548 public TreeViewer
getViewer() {
556 public List
<SpecimenOrObservationBase
<?
>> getRootEntities() {
557 return new ArrayList
<SpecimenOrObservationBase
<?
>>(rootElements
);
560 public void toggleListenToSelectionChange(MPart part
) {
561 listenToSelectionChange
= !listenToSelectionChange
;
562 derivateSearchCompositeController
.setEnabled(!listenToSelectionChange
);
563 if(!listenToSelectionChange
){
564 selectedTaxon
= null;
565 part
.setLabel(SPECIMEN_EDITOR
);
567 else if(selectedTaxon
==null){
568 part
.setLabel(SPECIMEN_EDITOR
+Messages
.DerivateView_NO_TAXON_SELECTED
);
572 public boolean isListenToSelectionChange(){
573 return listenToSelectionChange
;
580 public void contextAboutToStop(IMemento memento
, IProgressMonitor monitor
) {
587 public void contextStop(IMemento memento
, IProgressMonitor monitor
) {
588 derivateSearchCompositeController
.setEnabled(false);
589 if(!viewer
.getTree().isDisposed()) {
590 viewer
.getTree().setEnabled(false);
591 viewer
.setInput(null);
599 public void contextStart(IMemento memento
, IProgressMonitor monitor
) {
600 derivateSearchCompositeController
.setEnabled(!listenToSelectionChange
);
601 if(!viewer
.getTree().isDisposed()){
602 viewer
.getTree().setEnabled(true);
611 public void contextRefresh(IProgressMonitor monitor
) {
618 public void workbenchShutdown(IMemento memento
, IProgressMonitor monitor
) {
622 public boolean isDirty() {
623 return dirty
.isDirty();