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
.Comparator
;
15 import java
.util
.HashSet
;
16 import java
.util
.List
;
17 import java
.util
.Observable
;
18 import java
.util
.Observer
;
20 import java
.util
.UUID
;
22 import org
.eclipse
.core
.runtime
.IAdaptable
;
23 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
24 import org
.eclipse
.jface
.viewers
.DoubleClickEvent
;
25 import org
.eclipse
.jface
.viewers
.TreePath
;
26 import org
.eclipse
.ui
.IMemento
;
27 import org
.eclipse
.ui
.IViewSite
;
28 import org
.eclipse
.ui
.PartInitException
;
29 import org
.eclipse
.ui
.navigator
.CommonNavigator
;
31 import eu
.etaxonomy
.cdm
.api
.application
.CdmApplicationState
;
32 import eu
.etaxonomy
.cdm
.api
.application
.CdmChangeEvent
;
33 import eu
.etaxonomy
.cdm
.api
.conversation
.ConversationHolder
;
34 import eu
.etaxonomy
.cdm
.api
.conversation
.IConversationEnabled
;
35 import eu
.etaxonomy
.cdm
.api
.service
.IClassificationService
;
36 import eu
.etaxonomy
.cdm
.model
.common
.CdmBase
;
37 import eu
.etaxonomy
.cdm
.model
.taxon
.Classification
;
38 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonNaturalComparator
;
39 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonNode
;
40 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
41 import eu
.etaxonomy
.taxeditor
.model
.DataChangeBridge
;
42 import eu
.etaxonomy
.taxeditor
.model
.IDataChangeBehavior
;
43 import eu
.etaxonomy
.taxeditor
.model
.MessagingUtils
;
44 import eu
.etaxonomy
.taxeditor
.navigation
.NavigationUtil
;
45 import eu
.etaxonomy
.taxeditor
.operation
.IPostOperationEnabled
;
46 import eu
.etaxonomy
.taxeditor
.preference
.PreferencesUtil
;
47 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySession
;
48 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySessionEnabled
;
49 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
50 import eu
.etaxonomy
.taxeditor
.store
.LoginManager
;
53 * Taxonomic tree implementation using Common Navigator Framework.
60 public class TaxonNavigator
extends CommonNavigator
implements
61 IPostOperationEnabled
, IConversationEnabled
, Observer
, ICdmEntitySessionEnabled
{
65 * <code>ID="eu.etaxonomy.taxeditor.navigation.navig"{trunked}</code>
67 public static final String ID
= "eu.etaxonomy.taxeditor.navigation.navigator"; //$NON-NLS-1$
69 private static final String TREE_PATH
= "treepath";
71 private static final String TREE_PATHS
= "treepaths";
73 private ConversationHolder conversation
;
75 private ICdmEntitySession cdmEntitySession
;
77 private String partNameCache
;
79 private IDataChangeBehavior dataChangeBehavior
;
86 * @see org.eclipse.ui.navigator.CommonNavigator#getInitialInput()
90 protected IAdaptable
getInitialInput() {
91 Comparator comparator
;
92 if (PreferencesUtil
.getSortNodesNaturally()){
93 comparator
= new TaxonNaturalComparator();
95 //comparator = new TaxonComparatorSearch();
97 comparator
= new TaxonNaturalComparator();
98 TaxonNodeComparator viewerComparator
= new TaxonNodeComparator(comparator
);
99 this.getCommonViewer().setComparator(viewerComparator
);
100 setLinkingEnabled(true);
101 // this.getCommonViewer().addSelectionChangedListener(new ISelectionChangedListener() {
104 // public void selectionChanged(SelectionChangedEvent arg0) {
105 // IStructuredSelection selection = (IStructuredSelection) getCommonViewer().getSelection();
107 // Object firstElement = selection.getFirstElement();
109 // if (!(firstElement instanceof Classification)){
110 // //NavigationUtil.selectInNavigator(firstElement, null);
111 // NavigationUtil.openEditor(firstElement);
117 if (CdmStore
.isActive()) {
119 // TODO when closing and reopening the taxon navigator
120 // we do not preserve state. Closing the view, in contrary to
121 // closing the whole application
122 // should be handled by the state manager too
123 root
= new Root(conversation
);
126 return new EmptyRoot();
131 public void init(IViewSite site
) throws PartInitException
{
143 if (CdmStore
.isActive() && conversation
== null) {
144 conversation
= CdmStore
.createConversation();
145 conversation
.registerForDataStoreChanges(TaxonNavigator
.this);
147 if (CdmStore
.isActive() && cdmEntitySession
== null) {
148 cdmEntitySession
= CdmStore
.getCurrentSessionManager().newSession(this, true);
149 CdmApplicationState
.getCurrentDataChangeService().register(this);
151 CdmStore
.getLoginManager().addObserver(this);
155 * Refresh this navigators viewer
157 public void refresh() {
158 if(getConversationHolder() != null){
159 getConversationHolder().bind();
160 //FIXME : Need to make sure this is a stable fix (ticket 3822)
161 if(!getConversationHolder().isCompleted()){
162 getConversationHolder().commit();
165 getCommonViewer().refresh();
169 * Refresh this navigators viewer
171 public void refresh(Set objects
) {
172 for(Object obj
: objects
) {
173 getCommonViewer().refresh(obj
);
178 * Removes all content
180 public void clear() {
181 getCommonViewer().setInput(new EmptyRoot());
190 * a {@link org.eclipse.ui.IMemento} object.
192 * a {@link org.eclipse.core.runtime.IProgressMonitor} object.
194 public void restore(IMemento memento
, IProgressMonitor monitor
) {
195 root
= new Root(conversation
);
196 if (memento
== null) {
197 getCommonViewer().setInput(root
);
201 Set
<TreePath
> treePaths
= new HashSet
<TreePath
>();
202 IMemento
[] treePathMementos
= null;
204 IMemento treePathsMemento
= memento
.getChild(TREE_PATHS
);
206 if (treePathsMemento
!= null) {
207 treePathMementos
= treePathsMemento
.getChildren(TREE_PATH
);
208 mementoWork
= treePathMementos
.length
;
210 // begin the monitor with steps for all tree paths and steps for
212 // conversation s.o., refreshing the tree and setting the paths
213 IProgressMonitor subProgressMonitor
= NavigationUtil
214 .getSubProgressMonitor(monitor
, 1);
216 subProgressMonitor
.beginTask("Restoring Taxon Navigator",
217 1 + mementoWork
+ 5);
218 subProgressMonitor
.subTask("Restoring Taxon Navigator");
219 subProgressMonitor
.worked(1);
221 conversation
= CdmStore
.createConversation();
222 subProgressMonitor
.worked(1);
223 conversation
.registerForDataStoreChanges(TaxonNavigator
.this);
224 subProgressMonitor
.worked(1);
225 getCommonViewer().setInput(root
);
226 subProgressMonitor
.worked(1);
227 getCommonViewer().refresh();
228 subProgressMonitor
.worked(1);
230 if (treePathMementos
!= null && treePathMementos
.length
> 0) {
231 for (IMemento treePathMemento
: treePathMementos
) {
232 TreePath treePath
= createTreePathFromString(treePathMemento
234 if (!subProgressMonitor
.isCanceled() && treePath
!= null) {
235 treePaths
.add(treePath
);
236 subProgressMonitor
.worked(1);
240 if (treePaths
.size() > 0) {
241 TaxonNavigator
.this.getCommonViewer().setExpandedTreePaths(
242 treePaths
.toArray(new TreePath
[0]));
243 subProgressMonitor
.worked(1);
245 subProgressMonitor
.done();
252 private TreePath
createTreePathFromString(String string
) {
254 List
<CdmBase
> pathList
= new ArrayList
<CdmBase
>();
256 if (string
.length() == 0) {
260 for (String uuid
: string
.split(" ")) {
261 CdmBase cdmBaseObject
= CdmStore
.getService(
262 IClassificationService
.class).getTaxonNodeByUuid(
263 UUID
.fromString(uuid
));
264 if (cdmBaseObject
== null) {
265 // is this a tree uuid?
266 cdmBaseObject
= CdmStore
.getService(
267 IClassificationService
.class).load(
268 UUID
.fromString(uuid
));
270 if (cdmBaseObject
== null) {
274 pathList
.add(cdmBaseObject
);
276 return new TreePath(pathList
.toArray());
281 public void saveState(IMemento aMemento
) {
291 * a {@link org.eclipse.ui.IMemento} object.
292 * @param progressMonitor
293 * a {@link org.eclipse.core.runtime.IProgressMonitor} object.
295 public void saveTreeState(IMemento memento
, IProgressMonitor progressMonitor
) {
296 if (memento
== null) {
299 IProgressMonitor monitor
= NavigationUtil
.getSubProgressMonitor(
302 super.saveState(memento
);
304 memento
= memento
.createChild(TREE_PATHS
);
305 TreePath
[] treePaths
= this.getCommonViewer().getExpandedTreePaths();
307 monitor
.beginTask("Saving Taxon Navigator State", treePaths
.length
);
309 for (TreePath treePath
: treePaths
) {
310 int pathLength
= treePath
.getSegmentCount();
312 for (int i
= 0; i
< pathLength
; i
++) {
313 Object segment
= treePath
.getSegment(i
);
314 if (segment
instanceof CdmBase
) {
315 path
+= ((CdmBase
) segment
).getUuid().toString() + " ";
318 MessagingUtils
.warn(getClass(),
319 "Non-taxon tree path segment " + segment
);
322 memento
.createChild(TREE_PATH
, path
.trim());
331 * eu.etaxonomy.cdm.api.conversation.IConversationEnabled#getConversationHolder
336 * getConversationHolder
339 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder}
343 public ConversationHolder
getConversationHolder() {
351 * eu.etaxonomy.cdm.persistence.hibernate.ICdmPostDataChangeObserver#update
352 * (eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap)
356 public void update(CdmDataChangeMap changeEvents
) {
357 if (dataChangeBehavior
== null) {
358 dataChangeBehavior
= new TaxonNavigatorDataChangeBehavior(this);
361 DataChangeBridge
.handleDataChange(changeEvents
, dataChangeBehavior
);
366 public String
getFrameToolTipText(Object element
) {
367 if (element
instanceof Root
) {
368 return "Taxonomic Tree";
370 return super.getFrameToolTipText(element
);
376 * @see org.eclipse.ui.part.WorkbenchPart#dispose()
380 public void dispose() {
382 dataChangeBehavior
= null;
383 if (conversation
!= null) {
384 conversation
.unregisterForDataStoreChanges(this);
386 if(cdmEntitySession
!= null) {
387 cdmEntitySession
.dispose();
394 * @see org.eclipse.ui.navigator.CommonNavigator#setFocus()
398 public void setFocus() {
399 // logger.warn("Setting focus to navigator");
401 if (getConversationHolder() != null) {
402 getConversationHolder().bind();
404 if(cdmEntitySession
!= null) {
405 cdmEntitySession
.bind();
413 * eu.etaxonomy.taxeditor.operations.IPostOperationEnabled#postOperation
414 * (eu.etaxonomy.cdm.model.common.CdmBase)
418 public boolean postOperation(CdmBase objectAffectedByOperation
) {
419 // nothing to do here
429 * a {@link org.eclipse.ui.IMemento} object.
431 * a {@link org.eclipse.core.runtime.IProgressMonitor} object.
433 public void save(IMemento memento
, IProgressMonitor monitor
) {
434 saveTreeState(memento
, monitor
);
435 if (conversation
!= null) {
436 conversation
.unregisterForDataStoreChanges(this);
443 protected void handleDoubleClick(DoubleClickEvent anEvent
) {
444 NavigationUtil
.executeEditHandler();
445 // If the double click is passed up to the super-class it will
446 // expand/collapse trees.
447 // We do not want that
448 // super.handleDoubleClick(anEvent);
459 public boolean onComplete() {
466 * @see org.eclipse.ui.part.WorkbenchPart#showBusy(boolean)
470 public void showBusy(boolean busy
) {
471 super.showBusy(busy
);
472 getCommonViewer().getControl().setEnabled(!busy
);
474 partNameCache
= getPartName();
475 setPartName("Loading datasources");
477 if (partNameCache
!= null) {
478 setPartName(partNameCache
);
485 * @see java.util.Observer#update(java.util.Observable, java.lang.Object)
488 public void update(Observable o
, Object arg
) {
489 if(o
instanceof LoginManager
){
496 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled#getCdmEntitySession()
499 public ICdmEntitySession
getCdmEntitySession() {
500 return cdmEntitySession
;
504 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled#getRootEntities()
507 public List
<Classification
> getRootEntities() {
509 return root
.getParentBeans();
515 * @see eu.etaxonomy.cdm.api.application.ICdmChangeListener#onChange(eu.etaxonomy.cdm.api.application.CdmChangeEvent)
518 public void onChange(CdmChangeEvent event
) {
519 for(CdmBase cb
: event
.getChangedObjects()) {
520 if(cb
instanceof TaxonNode
) {
521 getCommonViewer().refresh(cb
);
522 } else if (cb
instanceof Classification
) {
523 getCommonViewer().refresh();