3 * Copyright (C) 2007 EDIT
4 * European Distributed Institute of Taxonomy
5 * http://www.e-taxonomy.eu
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.
11 package eu
.etaxonomy
.taxeditor
.navigation
.navigator
;
13 import java
.util
.ArrayList
;
14 import java
.util
.HashSet
;
15 import java
.util
.List
;
16 import java
.util
.Observable
;
17 import java
.util
.Observer
;
19 import java
.util
.UUID
;
21 import org
.eclipse
.core
.runtime
.IAdaptable
;
22 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
23 import org
.eclipse
.jface
.viewers
.DoubleClickEvent
;
24 import org
.eclipse
.jface
.viewers
.TreePath
;
25 import org
.eclipse
.ui
.IMemento
;
26 import org
.eclipse
.ui
.IViewSite
;
27 import org
.eclipse
.ui
.PartInitException
;
28 import org
.eclipse
.ui
.navigator
.CommonNavigator
;
30 import eu
.etaxonomy
.cdm
.api
.conversation
.ConversationHolder
;
31 import eu
.etaxonomy
.cdm
.api
.conversation
.IConversationEnabled
;
32 import eu
.etaxonomy
.cdm
.api
.service
.IClassificationService
;
33 import eu
.etaxonomy
.cdm
.model
.common
.CdmBase
;
34 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonComparatorSearch
;
35 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
36 import eu
.etaxonomy
.taxeditor
.model
.DataChangeBridge
;
37 import eu
.etaxonomy
.taxeditor
.model
.IDataChangeBehavior
;
38 import eu
.etaxonomy
.taxeditor
.model
.MessagingUtils
;
39 import eu
.etaxonomy
.taxeditor
.navigation
.NavigationUtil
;
40 import eu
.etaxonomy
.taxeditor
.operation
.IPostOperationEnabled
;
41 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySession
;
42 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySessionEnabled
;
43 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
44 import eu
.etaxonomy
.taxeditor
.store
.LoginManager
;
47 * Taxonomic tree implementation using Common Navigator Framework.
54 public class TaxonNavigator
extends CommonNavigator
implements
55 IPostOperationEnabled
, IConversationEnabled
, Observer
, ICdmEntitySessionEnabled
{
59 * <code>ID="eu.etaxonomy.taxeditor.navigation.navig"{trunked}</code>
61 public static final String ID
= "eu.etaxonomy.taxeditor.navigation.navigator"; //$NON-NLS-1$
63 private static final String TREE_PATH
= "treepath";
65 private static final String TREE_PATHS
= "treepaths";
67 private ConversationHolder conversation
;
69 private ICdmEntitySession cdmEntitySession
;
71 private String partNameCache
;
73 private IDataChangeBehavior dataChangeBehavior
;
78 * @see org.eclipse.ui.navigator.CommonNavigator#getInitialInput()
82 protected IAdaptable
getInitialInput() {
84 TaxonComparatorSearch comparator
= new TaxonComparatorSearch();
85 TaxonNodeComparator viewerComparator
= new TaxonNodeComparator(comparator
);
86 this.getCommonViewer().setComparator(viewerComparator
);
87 setLinkingEnabled(true);
88 // this.getCommonViewer().addSelectionChangedListener(new ISelectionChangedListener() {
91 // public void selectionChanged(SelectionChangedEvent arg0) {
92 // IStructuredSelection selection = (IStructuredSelection) getCommonViewer().getSelection();
94 // Object firstElement = selection.getFirstElement();
96 // if (!(firstElement instanceof Classification)){
97 // //NavigationUtil.selectInNavigator(firstElement, null);
98 // NavigationUtil.openEditor(firstElement);
104 if (CdmStore
.isActive()) {
106 // TODO when closing and reopening the taxon navigator
107 // we do not preserve state. Closing the view, in contrary to
108 // closing the whole application
109 // should be handled by the state manager too
111 return new Root(conversation
);
113 return new EmptyRoot();
118 public void init(IViewSite site
) throws PartInitException
{
130 if (CdmStore
.isActive() && conversation
== null) {
131 conversation
= CdmStore
.createConversation();
132 conversation
.registerForDataStoreChanges(TaxonNavigator
.this);
134 if (CdmStore
.isActive() && cdmEntitySession
== null) {
135 cdmEntitySession
= CdmStore
.getCurrentSessionManager().newSession(this, true);
136 cdmEntitySession
.registerForDataStoreChanges(TaxonNavigator
.this);
138 CdmStore
.getLoginManager().addObserver(this);
142 * Refresh this navigators viewer
144 public void refresh() {
145 if(getConversationHolder() != null){
146 getConversationHolder().bind();
147 //FIXME : Need to make sure this is a stable fix (ticket 3822)
148 if(!getConversationHolder().isCompleted()){
149 getConversationHolder().commit();
152 if (cdmEntitySession
!= null) {
153 cdmEntitySession
.fireNotifications();
155 getCommonViewer().refresh();
159 * Refresh this navigators viewer
161 public void refresh(Set objects
) {
163 for(Object obj
: objects
) {
164 getCommonViewer().refresh(obj
);
169 * Removes all content
171 public void clear() {
172 getCommonViewer().setInput(new EmptyRoot());
181 * a {@link org.eclipse.ui.IMemento} object.
183 * a {@link org.eclipse.core.runtime.IProgressMonitor} object.
185 public void restore(IMemento memento
, IProgressMonitor monitor
) {
186 if (memento
== null) {
187 getCommonViewer().setInput(new Root(conversation
));
191 Set
<TreePath
> treePaths
= new HashSet
<TreePath
>();
192 IMemento
[] treePathMementos
= null;
194 IMemento treePathsMemento
= memento
.getChild(TREE_PATHS
);
196 if (treePathsMemento
!= null) {
197 treePathMementos
= treePathsMemento
.getChildren(TREE_PATH
);
198 mementoWork
= treePathMementos
.length
;
200 // begin the monitor with steps for all tree paths and steps for
202 // conversation s.o., refreshing the tree and setting the paths
203 IProgressMonitor subProgressMonitor
= NavigationUtil
204 .getSubProgressMonitor(monitor
, 1);
206 subProgressMonitor
.beginTask("Restoring Taxon Navigator",
207 1 + mementoWork
+ 5);
208 subProgressMonitor
.subTask("Restoring Taxon Navigator");
209 subProgressMonitor
.worked(1);
211 conversation
= CdmStore
.createConversation();
212 subProgressMonitor
.worked(1);
213 conversation
.registerForDataStoreChanges(TaxonNavigator
.this);
214 subProgressMonitor
.worked(1);
215 getCommonViewer().setInput(new Root(conversation
));
216 subProgressMonitor
.worked(1);
217 getCommonViewer().refresh();
218 subProgressMonitor
.worked(1);
220 if (treePathMementos
!= null && treePathMementos
.length
> 0) {
221 for (IMemento treePathMemento
: treePathMementos
) {
222 TreePath treePath
= createTreePathFromString(treePathMemento
224 if (!subProgressMonitor
.isCanceled() && treePath
!= null) {
225 treePaths
.add(treePath
);
226 subProgressMonitor
.worked(1);
230 if (treePaths
.size() > 0) {
231 TaxonNavigator
.this.getCommonViewer().setExpandedTreePaths(
232 treePaths
.toArray(new TreePath
[0]));
233 subProgressMonitor
.worked(1);
235 subProgressMonitor
.done();
242 private TreePath
createTreePathFromString(String string
) {
244 List
<CdmBase
> pathList
= new ArrayList
<CdmBase
>();
246 if (string
.length() == 0) {
250 for (String uuid
: string
.split(" ")) {
251 CdmBase cdmBaseObject
= CdmStore
.getService(
252 IClassificationService
.class).getTaxonNodeByUuid(
253 UUID
.fromString(uuid
));
254 if (cdmBaseObject
== null) {
255 // is this a tree uuid?
256 cdmBaseObject
= CdmStore
.getService(
257 IClassificationService
.class).load(
258 UUID
.fromString(uuid
));
260 if (cdmBaseObject
== null) {
264 pathList
.add(cdmBaseObject
);
266 return new TreePath(pathList
.toArray());
271 public void saveState(IMemento aMemento
) {
281 * a {@link org.eclipse.ui.IMemento} object.
282 * @param progressMonitor
283 * a {@link org.eclipse.core.runtime.IProgressMonitor} object.
285 public void saveTreeState(IMemento memento
, IProgressMonitor progressMonitor
) {
286 if (memento
== null) {
289 IProgressMonitor monitor
= NavigationUtil
.getSubProgressMonitor(
292 super.saveState(memento
);
294 memento
= memento
.createChild(TREE_PATHS
);
295 TreePath
[] treePaths
= this.getCommonViewer().getExpandedTreePaths();
297 monitor
.beginTask("Saving Taxon Navigator State", treePaths
.length
);
299 for (TreePath treePath
: treePaths
) {
300 int pathLength
= treePath
.getSegmentCount();
302 for (int i
= 0; i
< pathLength
; i
++) {
303 Object segment
= treePath
.getSegment(i
);
304 if (segment
instanceof CdmBase
) {
305 path
+= ((CdmBase
) segment
).getUuid().toString() + " ";
308 MessagingUtils
.warn(getClass(),
309 "Non-taxon tree path segment " + segment
);
312 memento
.createChild(TREE_PATH
, path
.trim());
321 * eu.etaxonomy.cdm.api.conversation.IConversationEnabled#getConversationHolder
326 * getConversationHolder
329 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder}
333 public ConversationHolder
getConversationHolder() {
341 * eu.etaxonomy.cdm.persistence.hibernate.ICdmPostDataChangeObserver#update
342 * (eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap)
346 public void update(CdmDataChangeMap changeEvents
) {
347 if (dataChangeBehavior
== null) {
348 dataChangeBehavior
= new TaxonNavigatorDataChangeBehavior(this);
351 DataChangeBridge
.handleDataChange(changeEvents
, dataChangeBehavior
);
356 public String
getFrameToolTipText(Object element
) {
357 if (element
instanceof Root
) {
358 return "Taxonomic Tree";
360 return super.getFrameToolTipText(element
);
366 * @see org.eclipse.ui.part.WorkbenchPart#dispose()
370 public void dispose() {
372 dataChangeBehavior
= null;
373 if (conversation
!= null) {
374 conversation
.unregisterForDataStoreChanges(this);
376 if(cdmEntitySession
!= null) {
377 cdmEntitySession
.dispose();
384 * @see org.eclipse.ui.navigator.CommonNavigator#setFocus()
388 public void setFocus() {
389 // logger.warn("Setting focus to navigator");
391 if (getConversationHolder() != null) {
392 getConversationHolder().bind();
394 if(cdmEntitySession
!= null) {
395 cdmEntitySession
.bind();
403 * eu.etaxonomy.taxeditor.operations.IPostOperationEnabled#postOperation
404 * (eu.etaxonomy.cdm.model.common.CdmBase)
408 public boolean postOperation(CdmBase objectAffectedByOperation
) {
409 // nothing to do here
419 * a {@link org.eclipse.ui.IMemento} object.
421 * a {@link org.eclipse.core.runtime.IProgressMonitor} object.
423 public void save(IMemento memento
, IProgressMonitor monitor
) {
424 saveTreeState(memento
, monitor
);
425 if (conversation
!= null) {
426 conversation
.unregisterForDataStoreChanges(this);
433 protected void handleDoubleClick(DoubleClickEvent anEvent
) {
434 NavigationUtil
.executeEditHandler();
435 // If the double click is passed up to the super-class it will
436 // expand/collapse trees.
437 // We do not want that
438 // super.handleDoubleClick(anEvent);
449 public boolean onComplete() {
456 * @see org.eclipse.ui.part.WorkbenchPart#showBusy(boolean)
460 public void showBusy(boolean busy
) {
461 super.showBusy(busy
);
462 getCommonViewer().getControl().setEnabled(!busy
);
464 partNameCache
= getPartName();
465 setPartName("Loading datasources");
467 if (partNameCache
!= null) {
468 setPartName(partNameCache
);
475 * @see java.util.Observer#update(java.util.Observable, java.lang.Object)
478 public void update(Observable o
, Object arg
) {
479 if(o
instanceof LoginManager
){
486 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled#getCdmEntitySession()
489 public ICdmEntitySession
getCdmEntitySession() {
490 return cdmEntitySession
;
494 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled#getRootEntities()
497 public <T
extends CdmBase
> List
<T
> getRootEntities() {