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
.HashMap
;
7 import java
.util
.HashSet
;
11 import java
.util
.UUID
;
13 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
14 import org
.eclipse
.jface
.action
.MenuManager
;
15 import org
.eclipse
.jface
.util
.LocalSelectionTransfer
;
16 import org
.eclipse
.jface
.viewers
.AbstractTreeViewer
;
17 import org
.eclipse
.jface
.viewers
.ISelection
;
18 import org
.eclipse
.jface
.viewers
.IStructuredSelection
;
19 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
20 import org
.eclipse
.jface
.viewers
.TreeNode
;
21 import org
.eclipse
.jface
.viewers
.TreeSelection
;
22 import org
.eclipse
.jface
.viewers
.TreeViewer
;
23 import org
.eclipse
.swt
.SWT
;
24 import org
.eclipse
.swt
.dnd
.DND
;
25 import org
.eclipse
.swt
.dnd
.Transfer
;
26 import org
.eclipse
.swt
.layout
.GridData
;
27 import org
.eclipse
.swt
.layout
.GridLayout
;
28 import org
.eclipse
.swt
.widgets
.Composite
;
29 import org
.eclipse
.swt
.widgets
.Control
;
30 import org
.eclipse
.swt
.widgets
.Menu
;
31 import org
.eclipse
.swt
.widgets
.Tree
;
32 import org
.eclipse
.ui
.IEditorInput
;
33 import org
.eclipse
.ui
.IEditorPart
;
34 import org
.eclipse
.ui
.IEditorSite
;
35 import org
.eclipse
.ui
.IMemento
;
36 import org
.eclipse
.ui
.ISelectionListener
;
37 import org
.eclipse
.ui
.ISelectionService
;
38 import org
.eclipse
.ui
.IWorkbenchPart
;
39 import org
.eclipse
.ui
.PartInitException
;
40 import org
.eclipse
.ui
.part
.EditorPart
;
42 import eu
.etaxonomy
.cdm
.api
.conversation
.ConversationHolder
;
43 import eu
.etaxonomy
.cdm
.api
.conversation
.IConversationEnabled
;
44 import eu
.etaxonomy
.cdm
.api
.service
.IOccurrenceService
;
45 import eu
.etaxonomy
.cdm
.hibernate
.HibernateProxyHelper
;
46 import eu
.etaxonomy
.cdm
.model
.common
.CdmBase
;
47 import eu
.etaxonomy
.cdm
.model
.molecular
.SingleRead
;
48 import eu
.etaxonomy
.cdm
.model
.occurrence
.FieldUnit
;
49 import eu
.etaxonomy
.cdm
.model
.occurrence
.SpecimenOrObservationBase
;
50 import eu
.etaxonomy
.cdm
.model
.taxon
.Taxon
;
51 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonNode
;
52 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
53 import eu
.etaxonomy
.taxeditor
.editor
.EditorUtil
;
54 import eu
.etaxonomy
.taxeditor
.editor
.Messages
;
55 import eu
.etaxonomy
.taxeditor
.editor
.MultiPageTaxonEditor
;
56 import eu
.etaxonomy
.taxeditor
.editor
.view
.derivate
.searchFilter
.DerivateSearchCompositeController
;
57 import eu
.etaxonomy
.taxeditor
.model
.IContextListener
;
58 import eu
.etaxonomy
.taxeditor
.model
.IDirtyMarkable
;
59 import eu
.etaxonomy
.taxeditor
.model
.IPartContentHasDetails
;
60 import eu
.etaxonomy
.taxeditor
.model
.IPartContentHasFactualData
;
61 import eu
.etaxonomy
.taxeditor
.model
.IPartContentHasMedia
;
62 import eu
.etaxonomy
.taxeditor
.model
.IPartContentHasSupplementalData
;
63 import eu
.etaxonomy
.taxeditor
.operation
.IPostOperationEnabled
;
64 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySession
;
65 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySessionEnabled
;
66 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
67 import eu
.etaxonomy
.taxeditor
.view
.derivateSearch
.DerivateContentProvider
;
68 import eu
.etaxonomy
.taxeditor
.view
.derivateSearch
.DerivateLabelProvider
;
71 * Displays the derivate hierarchy of the specimen specified in the editor input.
74 public class DerivateView
extends EditorPart
implements IPartContentHasFactualData
, IConversationEnabled
,
75 ICdmEntitySessionEnabled
, IDirtyMarkable
, IPostOperationEnabled
, IPartContentHasDetails
, IPartContentHasSupplementalData
, IPartContentHasMedia
,
76 IContextListener
, ISelectionListener
{
77 public static final String ID
= "eu.etaxonomy.taxeditor.editor.view.derivate.DerivateView"; //$NON-NLS-1$
79 public static final String YOU_NEED_TO_SAVE_BEFORE_PERFORMING_THIS_ACTION
= Messages
.DerivateView_YOU_NEED_TO_SAVE
;
80 public static final String VIEW_HAS_UNSAVED_CHANGES
= Messages
.DerivateView_UNSAVED_CHANGES
;
82 private static final List
<String
> SPECIMEN_INIT_STRATEGY
= Arrays
.asList(new String
[] {
90 "derivationEvents.derivatives.annotations",
91 "derivationEvents.derivatives.markers",
92 "derivationEvents.derivatives.credits",
93 "derivationEvents.derivatives.extensions",
94 "derivationEvents.derivatives.rights",
95 "derivationEvents.derivatives.sources"
98 private ConversationHolder conversation
;
100 private TreeViewer viewer
;
102 private boolean isDirty
;
104 private final int dndOperations
= DND
.DROP_MOVE
;
106 private DerivateLabelProvider labelProvider
;
108 private DerivateContentProvider contentProvider
;
110 private DerivateSearchCompositeController derivateSearchCompositeController
;
113 * A map with keys being the derivative entities belonging to the {@link UUID}s passed to the constructor
114 * and values being the root elements of the hierarchy (may be the same objects as the derivative entities)
116 private Map
<SpecimenOrObservationBase
<?
>, SpecimenOrObservationBase
<?
>> derivateToRootEntityMap
;
119 * The set of root elements
121 private Set
<SpecimenOrObservationBase
<?
>> rootElements
;
123 private ICdmEntitySession cdmEntitySession
;
126 * <code>true</code> if this view is listening to selection changes
128 private boolean listenToSelectionChange
;
130 private Taxon selectedTaxon
;
132 private ISelectionService selectionService
;
135 * Default constructor
137 public DerivateView() {
145 public void init(IEditorSite site
, IEditorInput input
) throws PartInitException
{
147 this.setInput(input
);
148 this.derivateToRootEntityMap
= new HashMap
<SpecimenOrObservationBase
<?
>, SpecimenOrObservationBase
<?
>>();
149 this.rootElements
= new HashSet
<SpecimenOrObservationBase
<?
>>();
151 if (CdmStore
.isActive() && conversation
== null) {
152 conversation
= CdmStore
.createConversation();
154 if (CdmStore
.isActive()) {
155 cdmEntitySession
= CdmStore
.getCurrentSessionManager().newSession(this, true);
157 //listen to context changes
158 CdmStore
.getContextManager().addContextListener(this);
162 public void createPartControl(Composite parent
) {
164 parent
.setLayout(new GridLayout());
166 //---search and filter---
167 derivateSearchCompositeController
= new DerivateSearchCompositeController(parent
, this);
168 GridData gridDataSearchBar
= new GridData();
169 gridDataSearchBar
.horizontalAlignment
= GridData
.FILL
;
170 gridDataSearchBar
.grabExcessHorizontalSpace
= true;
171 derivateSearchCompositeController
.setLayoutData(gridDataSearchBar
);
172 derivateSearchCompositeController
.setEnabled(CdmStore
.isActive());
175 viewer
= new TreeViewer(new Tree(parent
, SWT
.MULTI
| SWT
.H_SCROLL
| SWT
.V_SCROLL
| SWT
.FULL_SELECTION
));
176 GridData gridDataTree
= new GridData();
177 gridDataTree
.horizontalAlignment
= GridData
.FILL
;
178 gridDataTree
.verticalAlignment
= GridData
.FILL
;
179 gridDataTree
.grabExcessVerticalSpace
= true;
180 gridDataTree
.grabExcessHorizontalSpace
= true;
181 viewer
.getTree().setLayoutData(gridDataTree
);
182 contentProvider
= new DerivateContentProvider();
183 viewer
.setContentProvider(contentProvider
);
184 labelProvider
= new DerivateLabelProvider();
185 labelProvider
.setConversation(conversation
);
186 viewer
.setLabelProvider(labelProvider
);
187 viewer
.setAutoExpandLevel(AbstractTreeViewer
.ALL_LEVELS
);
188 viewer
.getTree().setEnabled(CdmStore
.isActive());
189 // Propagate selection from viewer
190 getSite().setSelectionProvider(viewer
);
192 //listen to selection changes
193 selectionService
= getSite().getWorkbenchWindow().getSelectionService();
194 selectionService
.addSelectionListener(this);
196 //create context menu
197 MenuManager menuManager
= new MenuManager();
198 menuManager
.setRemoveAllWhenShown(true);
199 getSite().registerContextMenu(menuManager
, viewer
);
200 Control control
= viewer
.getControl();
201 Menu menu
= menuManager
.createContextMenu(control
);
202 control
.setMenu(menu
);
205 updateRootEntities();
207 getEditorSite().getActionBars().getStatusLineManager().setMessage("");
209 //add drag'n'drop support
210 Transfer
[] transfers
= new Transfer
[] {LocalSelectionTransfer
.getTransfer(),};
211 viewer
.addDragSupport(dndOperations
, transfers
, new DerivateDragListener(this));
212 viewer
.addDropSupport(dndOperations
, transfers
, new DerivateDropListener(this));
215 public void updateRootEntities() {
216 updateRootEntities((Collection
)null);
219 public void updateRootEntities(Collection
<UUID
> derivativeUuids
) {
220 if(conversation
!=null){
221 if (!conversation
.isBound()) {
225 * If the active session is not the session of the Derivative Editor
226 * then we will save the active session for later, bind temporarily
227 * to our session and rebind to the original session when we are
228 * done. This happens e.g. if a selection change happens in the
229 * taxon editor and "Link with editor" is enabled. The selection
230 * change event and thus the loading in updateRootEntities() happens
231 * in the session of the taxon editor.
233 ICdmEntitySession previousCdmEntitySession
= CdmStore
.getCurrentSessionManager().getActiveSession();
234 if(cdmEntitySession
!= null) {
235 cdmEntitySession
.bind();
238 List
<SpecimenOrObservationBase
> derivates
= null;
239 if(derivativeUuids
!=null){
240 this.derivateToRootEntityMap
= new HashMap
<SpecimenOrObservationBase
<?
>, SpecimenOrObservationBase
<?
>>();
241 this.rootElements
= new HashSet
<SpecimenOrObservationBase
<?
>>();
242 derivates
= CdmStore
.getService(IOccurrenceService
.class).load(new ArrayList(derivativeUuids
), SPECIMEN_INIT_STRATEGY
);
244 updateRootEntities(derivates
);
245 previousCdmEntitySession
.bind();
250 public void updateRootEntities(List
<SpecimenOrObservationBase
> derivates
) {
253 this.derivateToRootEntityMap
= new HashMap
<SpecimenOrObservationBase
<?
>, SpecimenOrObservationBase
<?
>>();
254 this.rootElements
= new HashSet
<SpecimenOrObservationBase
<?
>>();
255 for (SpecimenOrObservationBase derivate
: derivates
) {
257 if(derivate
instanceof FieldUnit
){
258 derivateToRootEntityMap
.put(derivate
, derivate
);
261 SpecimenOrObservationBase
<?
> topMostDerivate
= EditorUtil
.getTopMostDerivate(derivate
);
262 if(topMostDerivate
!=null){
263 derivateToRootEntityMap
.put(derivate
, topMostDerivate
);
266 derivateToRootEntityMap
.put(derivate
, derivate
);
270 for (SpecimenOrObservationBase
<?
> specimen
: derivateToRootEntityMap
.values()) {
271 rootElements
.add(specimen
);
274 labelProvider
.updateLabelCache(rootElements
);
275 viewer
.setInput(rootElements
);
277 getEditorSite().getActionBars().getStatusLineManager().setMessage(rootElements
.size() +" derivative hierarchies found");
281 public void updateLabelCache(){
282 labelProvider
.updateLabelCache(rootElements
);
286 public void doSave(IProgressMonitor monitor
) {
287 String taskName
= Messages
.DerivateView_SAVING_HIERARCHY
;
288 monitor
.beginTask(taskName
, 3);
289 if (!conversation
.isBound()) {
294 // commit the conversation and start a new transaction immediately
295 conversation
.commit(true);
297 if(CdmStore
.getCurrentSessionManager().isRemoting()) {
298 CdmStore
.getService(IOccurrenceService
.class).merge(new ArrayList
<SpecimenOrObservationBase
>(rootElements
), true);
302 this.setDirty(false);
305 firePropertyChange(PROP_DIRTY
);
310 public void doSaveAs() {
314 public String
getTitleToolTip() {
315 return Messages
.DerivateView_DERIVATIVE_EDITOR
;
319 public boolean isDirty() {
324 * @param isDirty the isDirty to set
326 public void setDirty(boolean isDirty
) {
327 this.isDirty
= isDirty
;
331 public boolean isSaveAsAllowed() {
336 public void setFocus() {
337 viewer
.getControl().setFocus();
338 //make sure to bind again if maybe in another view the conversation was unbound
339 if(conversation
!=null && !conversation
.isBound()){
342 if(cdmEntitySession
!= null) {
343 cdmEntitySession
.bind();
348 public void update(CdmDataChangeMap changeEvents
) {
352 public ConversationHolder
getConversationHolder() {
357 public void changed(Object element
) {
359 firePropertyChange(IEditorPart
.PROP_DIRTY
);
360 viewer
.update(new TreeNode(element
), null);
364 public void forceDirty() {
369 public Map
<Object
, List
<String
>> getPropertyPathsMap() {
370 List
<String
> specimenPropertyPaths
= Arrays
.asList(new String
[] {
372 "derivationEvents.derivates",
380 Map
<Object
, List
<String
>> specimenPropertyPathMap
=
381 new HashMap
<Object
, List
<String
>>();
382 specimenPropertyPathMap
.put(SpecimenOrObservationBase
.class,specimenPropertyPaths
);
383 return specimenPropertyPathMap
;
387 * Refreshes the derivate hierarchy tree and expands the tree
388 * to show and select the given object.
390 * @param expandTo the object to which the tree should be expanded
392 public void refreshTree(Object expandTo
){
394 TreeSelection selection
= (TreeSelection
) viewer
.getSelection();
395 viewer
.expandToLevel(selection
.getFirstElement(), 1);
396 viewer
.setSelection(new StructuredSelection(new TreeNode(expandTo
)));
400 * Refreshes the derivate hierarchy tree
402 public void refreshTree(){
406 //FIXME:Remoting hack to make this work for remoting
407 //This should actually be resolved using remoting post operations
408 public void remove(Object obj
) {
409 rootElements
.remove(obj
);
410 viewer
.setInput(rootElements
);
414 * @return a set of {@link SingleRead}s that have multiple parents
416 public Set
<SingleRead
> getMultiLinkSingleReads() {
417 return DerivateLabelProvider
.getMultiLinkSingleReads();
420 public Object
getSelectionInput() {
421 return selectedTaxon
;
424 public DerivateLabelProvider
getLabelProvider() {
425 return labelProvider
;
429 public boolean postOperation(CdmBase objectAffectedByOperation
) {
431 if(objectAffectedByOperation
!=null){
432 changed(objectAffectedByOperation
);
438 public boolean onComplete() {
444 public boolean canAttachMedia() {
448 public void addFieldUnit(FieldUnit fieldUnit
) {
449 rootElements
.add(fieldUnit
);
450 derivateToRootEntityMap
.put(fieldUnit
, fieldUnit
);
454 public ICdmEntitySession
getCdmEntitySession() {
455 return cdmEntitySession
;
459 public void dispose() {
461 if(conversation
!=null){
462 conversation
.close();
464 if(cdmEntitySession
!= null) {
465 cdmEntitySession
.dispose();
470 public void selectionChanged(IWorkbenchPart part
, ISelection selection
) {
471 if(viewer
.getTree().isDisposed()){
474 if(listenToSelectionChange
){
475 if(part
instanceof MultiPageTaxonEditor
){
476 selectedTaxon
= ((MultiPageTaxonEditor
) part
).getTaxon();
478 else if(selection
instanceof IStructuredSelection
){
479 Object selectedElement
= ((IStructuredSelection
) selection
).getFirstElement();
480 if(selectedElement
instanceof CdmBase
){
481 if(((CdmBase
) selectedElement
).isInstanceOf(TaxonNode
.class)){
482 selectedTaxon
= HibernateProxyHelper
.deproxy(selectedElement
, TaxonNode
.class).getTaxon();
484 else if(((CdmBase
) selectedElement
).isInstanceOf(Taxon
.class)){
485 selectedTaxon
= HibernateProxyHelper
.deproxy(selectedElement
, Taxon
.class);
489 if(selectedTaxon
!=null){
490 Collection
<SpecimenOrObservationBase
> fieldUnits
= CdmStore
.getService(IOccurrenceService
.class).listFieldUnitsByAssociatedTaxon(selectedTaxon
, null, null);
491 Collection
<UUID
> uuids
= new HashSet
<UUID
>();
492 for (SpecimenOrObservationBase specimenOrObservationBase
: fieldUnits
) {
493 uuids
.add(specimenOrObservationBase
.getUuid());
495 updateRootEntities(uuids
);
496 setPartName("Derivative Editor: " + selectedTaxon
.getName());
501 public TreeViewer
getViewer() {
509 public List
<SpecimenOrObservationBase
<?
>> getRootEntities() {
510 return new ArrayList
<SpecimenOrObservationBase
<?
>>(rootElements
);
513 public void toggleListenToSelectionChange() {
514 listenToSelectionChange
= !listenToSelectionChange
;
515 derivateSearchCompositeController
.setEnabled(!listenToSelectionChange
);
516 if(!listenToSelectionChange
){
517 selectedTaxon
= null;
518 setPartName("Derivative Editor");
520 else if(selectedTaxon
==null){
521 setPartName("Derivative Editor [no taxon selected]");
525 public boolean isListenToSelectionChange(){
526 return listenToSelectionChange
;
533 public void contextAboutToStop(IMemento memento
, IProgressMonitor monitor
) {
540 public void contextStop(IMemento memento
, IProgressMonitor monitor
) {
541 derivateSearchCompositeController
.setEnabled(false);
542 if(!viewer
.getTree().isDisposed()) {
543 viewer
.getTree().setEnabled(false);
544 viewer
.setInput(null);
552 public void contextStart(IMemento memento
, IProgressMonitor monitor
) {
553 derivateSearchCompositeController
.setEnabled(!listenToSelectionChange
);
554 viewer
.getTree().setEnabled(true);
562 public void contextRefresh(IProgressMonitor monitor
) {
569 public void workbenchShutdown(IMemento memento
, IProgressMonitor monitor
) {