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
;
38 import eu
.etaxonomy
.cdm
.model
.taxon
.Classification
;
39 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonNaturalComparator
;
40 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonNode
;
43 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonNaturalComparator
;
44 import eu
.etaxonomy
.cdm
.model
.taxon
.TaxonNodeComparator
;
45 >>>>>>> ea8a5aa23f73340312c1d094997e7f87c3b82fc6
46 import eu
.etaxonomy
.cdm
.persistence
.hibernate
.CdmDataChangeMap
;
47 import eu
.etaxonomy
.taxeditor
.model
.DataChangeBridge
;
48 import eu
.etaxonomy
.taxeditor
.model
.IDataChangeBehavior
;
49 import eu
.etaxonomy
.taxeditor
.model
.MessagingUtils
;
50 import eu
.etaxonomy
.taxeditor
.navigation
.NavigationUtil
;
51 import eu
.etaxonomy
.taxeditor
.operation
.IPostOperationEnabled
;
52 import eu
.etaxonomy
.taxeditor
.preference
.PreferencesUtil
;
53 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySession
;
54 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySessionEnabled
;
55 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
56 import eu
.etaxonomy
.taxeditor
.store
.LoginManager
;
59 * Taxonomic tree implementation using Common Navigator Framework.
66 public class TaxonNavigator
extends CommonNavigator
implements
67 IPostOperationEnabled
, IConversationEnabled
, Observer
, ICdmEntitySessionEnabled
{
71 * <code>ID="eu.etaxonomy.taxeditor.navigation.navig"{trunked}</code>
73 public static final String ID
= "eu.etaxonomy.taxeditor.navigation.navigator"; //$NON-NLS-1$
75 private static final String TREE_PATH
= "treepath";
77 private static final String TREE_PATHS
= "treepaths";
79 private ConversationHolder conversation
;
81 private ICdmEntitySession cdmEntitySession
;
83 private String partNameCache
;
85 private IDataChangeBehavior dataChangeBehavior
;
92 * @see org.eclipse.ui.navigator.CommonNavigator#getInitialInput()
96 protected IAdaptable
getInitialInput() {
97 Comparator comparator
;
98 if (PreferencesUtil
.getSortNodesNaturally()){
99 comparator
= new TaxonNaturalComparator();
101 comparator
= new TaxonNodeComparator();
103 TaxonNodeNavigatorComparator viewerComparator
= new TaxonNodeNavigatorComparator(comparator
);
104 this.getCommonViewer().setComparator(viewerComparator
);
105 setLinkingEnabled(true);
106 // this.getCommonViewer().addSelectionChangedListener(new ISelectionChangedListener() {
109 // public void selectionChanged(SelectionChangedEvent arg0) {
110 // IStructuredSelection selection = (IStructuredSelection) getCommonViewer().getSelection();
112 // Object firstElement = selection.getFirstElement();
114 // if (!(firstElement instanceof Classification)){
115 // //NavigationUtil.selectInNavigator(firstElement, null);
116 // NavigationUtil.openEditor(firstElement);
122 if (CdmStore
.isActive()) {
124 // TODO when closing and reopening the taxon navigator
125 // we do not preserve state. Closing the view, in contrary to
126 // closing the whole application
127 // should be handled by the state manager too
128 root
= new Root(conversation
);
131 return new EmptyRoot();
136 public void init(IViewSite site
) throws PartInitException
{
148 if (CdmStore
.isActive() && conversation
== null) {
149 conversation
= CdmStore
.createConversation();
150 conversation
.registerForDataStoreChanges(TaxonNavigator
.this);
152 if (CdmStore
.isActive() && cdmEntitySession
== null) {
153 cdmEntitySession
= CdmStore
.getCurrentSessionManager().newSession(this, true);
154 CdmApplicationState
.getCurrentDataChangeService().register(this);
156 CdmStore
.getLoginManager().addObserver(this);
160 * Refresh this navigators viewer
162 public void refresh() {
163 if(getConversationHolder() != null){
164 getConversationHolder().bind();
165 //FIXME : Need to make sure this is a stable fix (ticket 3822)
166 if(!getConversationHolder().isCompleted()){
167 getConversationHolder().commit();
170 getCommonViewer().refresh();
174 * Refresh this navigators viewer
176 public void refresh(Set objects
) {
177 for(Object obj
: objects
) {
178 getCommonViewer().refresh(obj
);
183 * Removes all content
185 public void clear() {
186 getCommonViewer().setInput(new EmptyRoot());
195 * a {@link org.eclipse.ui.IMemento} object.
197 * a {@link org.eclipse.core.runtime.IProgressMonitor} object.
199 public void restore(IMemento memento
, IProgressMonitor monitor
) {
200 root
= new Root(conversation
);
201 if (memento
== null) {
202 getCommonViewer().setInput(root
);
206 Set
<TreePath
> treePaths
= new HashSet
<TreePath
>();
207 IMemento
[] treePathMementos
= null;
209 IMemento treePathsMemento
= memento
.getChild(TREE_PATHS
);
211 if (treePathsMemento
!= null) {
212 treePathMementos
= treePathsMemento
.getChildren(TREE_PATH
);
213 mementoWork
= treePathMementos
.length
;
215 // begin the monitor with steps for all tree paths and steps for
217 // conversation s.o., refreshing the tree and setting the paths
218 IProgressMonitor subProgressMonitor
= NavigationUtil
219 .getSubProgressMonitor(monitor
, 1);
221 subProgressMonitor
.beginTask("Restoring Taxon Navigator",
222 1 + mementoWork
+ 5);
223 subProgressMonitor
.subTask("Restoring Taxon Navigator");
224 subProgressMonitor
.worked(1);
226 conversation
= CdmStore
.createConversation();
227 subProgressMonitor
.worked(1);
228 conversation
.registerForDataStoreChanges(TaxonNavigator
.this);
229 subProgressMonitor
.worked(1);
230 getCommonViewer().setInput(root
);
231 subProgressMonitor
.worked(1);
232 getCommonViewer().refresh();
233 subProgressMonitor
.worked(1);
235 if (treePathMementos
!= null && treePathMementos
.length
> 0) {
236 for (IMemento treePathMemento
: treePathMementos
) {
237 TreePath treePath
= createTreePathFromString(treePathMemento
239 if (!subProgressMonitor
.isCanceled() && treePath
!= null) {
240 treePaths
.add(treePath
);
241 subProgressMonitor
.worked(1);
245 if (treePaths
.size() > 0) {
246 TaxonNavigator
.this.getCommonViewer().setExpandedTreePaths(
247 treePaths
.toArray(new TreePath
[0]));
248 subProgressMonitor
.worked(1);
250 subProgressMonitor
.done();
257 private TreePath
createTreePathFromString(String string
) {
259 List
<CdmBase
> pathList
= new ArrayList
<CdmBase
>();
261 if (string
.length() == 0) {
265 for (String uuid
: string
.split(" ")) {
266 CdmBase cdmBaseObject
= CdmStore
.getService(
267 IClassificationService
.class).getTaxonNodeByUuid(
268 UUID
.fromString(uuid
));
269 if (cdmBaseObject
== null) {
270 // is this a tree uuid?
271 cdmBaseObject
= CdmStore
.getService(
272 IClassificationService
.class).load(
273 UUID
.fromString(uuid
));
275 if (cdmBaseObject
== null) {
279 pathList
.add(cdmBaseObject
);
281 return new TreePath(pathList
.toArray());
286 public void saveState(IMemento aMemento
) {
296 * a {@link org.eclipse.ui.IMemento} object.
297 * @param progressMonitor
298 * a {@link org.eclipse.core.runtime.IProgressMonitor} object.
300 public void saveTreeState(IMemento memento
, IProgressMonitor progressMonitor
) {
301 if (memento
== null) {
304 IProgressMonitor monitor
= NavigationUtil
.getSubProgressMonitor(
307 super.saveState(memento
);
309 memento
= memento
.createChild(TREE_PATHS
);
310 TreePath
[] treePaths
= this.getCommonViewer().getExpandedTreePaths();
312 monitor
.beginTask("Saving Taxon Navigator State", treePaths
.length
);
314 for (TreePath treePath
: treePaths
) {
315 int pathLength
= treePath
.getSegmentCount();
317 for (int i
= 0; i
< pathLength
; i
++) {
318 Object segment
= treePath
.getSegment(i
);
319 if (segment
instanceof CdmBase
) {
320 path
+= ((CdmBase
) segment
).getUuid().toString() + " ";
323 MessagingUtils
.warn(getClass(),
324 "Non-taxon tree path segment " + segment
);
327 memento
.createChild(TREE_PATH
, path
.trim());
336 * eu.etaxonomy.cdm.api.conversation.IConversationEnabled#getConversationHolder
341 * getConversationHolder
344 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder}
348 public ConversationHolder
getConversationHolder() {
356 * eu.etaxonomy.cdm.persistence.hibernate.ICdmPostDataChangeObserver#update
357 * (eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap)
361 public void update(CdmDataChangeMap changeEvents
) {
362 if (dataChangeBehavior
== null) {
363 dataChangeBehavior
= new TaxonNavigatorDataChangeBehavior(this);
366 DataChangeBridge
.handleDataChange(changeEvents
, dataChangeBehavior
);
371 public String
getFrameToolTipText(Object element
) {
372 if (element
instanceof Root
) {
373 return "Taxonomic Tree";
375 return super.getFrameToolTipText(element
);
381 * @see org.eclipse.ui.part.WorkbenchPart#dispose()
385 public void dispose() {
387 dataChangeBehavior
= null;
388 if (conversation
!= null) {
389 conversation
.unregisterForDataStoreChanges(this);
391 if(cdmEntitySession
!= null) {
392 cdmEntitySession
.dispose();
399 * @see org.eclipse.ui.navigator.CommonNavigator#setFocus()
403 public void setFocus() {
404 // logger.warn("Setting focus to navigator");
406 if (getConversationHolder() != null) {
407 getConversationHolder().bind();
409 if(cdmEntitySession
!= null) {
410 cdmEntitySession
.bind();
418 * eu.etaxonomy.taxeditor.operations.IPostOperationEnabled#postOperation
419 * (eu.etaxonomy.cdm.model.common.CdmBase)
423 public boolean postOperation(CdmBase objectAffectedByOperation
) {
424 // nothing to do here
434 * a {@link org.eclipse.ui.IMemento} object.
436 * a {@link org.eclipse.core.runtime.IProgressMonitor} object.
438 public void save(IMemento memento
, IProgressMonitor monitor
) {
439 saveTreeState(memento
, monitor
);
440 if (conversation
!= null) {
441 conversation
.unregisterForDataStoreChanges(this);
448 protected void handleDoubleClick(DoubleClickEvent anEvent
) {
449 NavigationUtil
.executeEditHandler();
450 // If the double click is passed up to the super-class it will
451 // expand/collapse trees.
452 // We do not want that
453 // super.handleDoubleClick(anEvent);
464 public boolean onComplete() {
471 * @see org.eclipse.ui.part.WorkbenchPart#showBusy(boolean)
475 public void showBusy(boolean busy
) {
476 super.showBusy(busy
);
477 getCommonViewer().getControl().setEnabled(!busy
);
479 partNameCache
= getPartName();
480 setPartName("Loading datasources");
482 if (partNameCache
!= null) {
483 setPartName(partNameCache
);
490 * @see java.util.Observer#update(java.util.Observable, java.lang.Object)
493 public void update(Observable o
, Object arg
) {
494 if(o
instanceof LoginManager
){
501 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled#getCdmEntitySession()
504 public ICdmEntitySession
getCdmEntitySession() {
505 return cdmEntitySession
;
509 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySessionEnabled#getRootEntities()
512 public List
<Classification
> getRootEntities() {
514 return root
.getParentBeans();
520 * @see eu.etaxonomy.cdm.api.application.ICdmChangeListener#onChange(eu.etaxonomy.cdm.api.application.CdmChangeEvent)
523 public void onChange(CdmChangeEvent event
) {
524 for(CdmBase cb
: event
.getChangedObjects()) {
525 if(cb
instanceof TaxonNode
) {
526 getCommonViewer().refresh(cb
);
527 } else if (cb
instanceof Classification
) {
528 getCommonViewer().refresh();