eu.etaxonomy.taxeditor.editor/src/main/java/eu/etaxonomy/taxeditor/editor/view/derivate/DerivateView.java

   1 package eu.etaxonomy.taxeditor.editor.view.derivate;
   2
   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;
   8 import java.util.List;
   9 import java.util.Map;
  10 import java.util.Set;
  11 import java.util.UUID;
  12
  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;
  41
  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;
  69
  70 /**
  71  * Displays the derivate hierarchy of the specimen specified in the editor input.
  72  *
  73  */
  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$
  78
  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;
  81
  82     private static final List<String> SPECIMEN_INIT_STRATEGY = Arrays.asList(new String[] {
  83             "descriptions",
  84             "annotations",
  85             "markers",
  86             "credits",
  87             "extensions",
  88             "rights",
  89             "sources",
  90             "derivationEvents.derivatives.annotations",
  91             "derivationEvents.derivatives.markers",
  92             "derivationEvents.derivatives.credits",
  93             "derivationEvents.derivatives.extensions",
  94             "derivationEvents.derivatives.rights",
  95             "derivationEvents.derivatives.sources"
  96     });
  97
  98         private ConversationHolder conversation;
  99
 100         private TreeViewer viewer;
 101
 102     private boolean isDirty;
 103
 104     private final int dndOperations = DND.DROP_MOVE;
 105
 106     private DerivateLabelProvider labelProvider;
 107
 108     private DerivateContentProvider contentProvider;
 109
 110     private DerivateSearchCompositeController derivateSearchCompositeController;
 111
 112     /**
 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)
 115      */
 116     private Map<SpecimenOrObservationBase<?>, SpecimenOrObservationBase<?>> derivateToRootEntityMap;
 117
 118     /**
 119      * The set of root elements
 120      */
 121     private Set<SpecimenOrObservationBase<?>> rootElements;
 122
 123     private ICdmEntitySession cdmEntitySession;
 124
 125     /**
 126      * <code>true</code> if this view is listening to selection  changes
 127      */
 128     private boolean listenToSelectionChange;
 129
 130     private Taxon selectedTaxon;
 131
 132     private ISelectionService selectionService;
 133
 134     /**
 135      * Default constructor
 136      */
 137     public DerivateView() {
 138     }
 139
 140
 141     /**
 142      * {@inheritDoc}
 143      */
 144     @Override
 145     public void init(IEditorSite site, IEditorInput input) throws PartInitException {
 146         this.setSite(site);
 147         this.setInput(input);
 148         this.derivateToRootEntityMap = new HashMap<SpecimenOrObservationBase<?>, SpecimenOrObservationBase<?>>();
 149         this.rootElements = new HashSet<SpecimenOrObservationBase<?>>();
 150
 151         if (CdmStore.isActive() && conversation == null) {
 152             conversation = CdmStore.createConversation();
 153         }
 154         if (CdmStore.isActive()) {
 155             cdmEntitySession = CdmStore.getCurrentSessionManager().newSession(this, true);
 156         }
 157         //listen to context changes
 158         CdmStore.getContextManager().addContextListener(this);
 159     }
 160
 161     @Override
 162     public void createPartControl(Composite parent) {
 163
 164         parent.setLayout(new GridLayout());
 165
 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());
 173
 174         //---tree viewer---
 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);
 191
 192         //listen to selection changes
 193         selectionService = getSite().getWorkbenchWindow().getSelectionService();
 194         selectionService.addSelectionListener(this);
 195
 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);
 203
 204         //init tree
 205         updateRootEntities();
 206         //reset status bar
 207         getEditorSite().getActionBars().getStatusLineManager().setMessage("");
 208
 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));
 213     }
 214
 215     public void updateRootEntities() {
 216         updateRootEntities((Collection)null);
 217     }
 218
 219     public void updateRootEntities(Collection<UUID> derivativeUuids) {
 220         if(conversation!=null){
 221             if (!conversation.isBound()) {
 222                 conversation.bind();
 223             }
 224             /*
 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.
 232              */
 233             ICdmEntitySession previousCdmEntitySession = CdmStore.getCurrentSessionManager().getActiveSession();
 234             if(cdmEntitySession != null) {
 235                 cdmEntitySession.bind();
 236             }
 237
 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);
 243             }
 244             updateRootEntities(derivates);
 245             previousCdmEntitySession.bind();
 246         }
 247     }
 248
 249
 250     public void updateRootEntities(List<SpecimenOrObservationBase> derivates) {
 251
 252             if(derivates!=null){
 253                 this.derivateToRootEntityMap = new HashMap<SpecimenOrObservationBase<?>, SpecimenOrObservationBase<?>>();
 254                 this.rootElements = new HashSet<SpecimenOrObservationBase<?>>();
 255                 for (SpecimenOrObservationBase derivate : derivates) {
 256
 257                     if(derivate instanceof FieldUnit){
 258                         derivateToRootEntityMap.put(derivate, derivate);
 259                     }
 260                     else {
 261                         SpecimenOrObservationBase<?> topMostDerivate = EditorUtil.getTopMostDerivate(derivate);
 262                         if(topMostDerivate!=null){
 263                             derivateToRootEntityMap.put(derivate, topMostDerivate);
 264                         }
 265                         else{
 266                             derivateToRootEntityMap.put(derivate, derivate);
 267                         }
 268                     }
 269                 }
 270                 for (SpecimenOrObservationBase<?> specimen : derivateToRootEntityMap.values()) {
 271                     rootElements.add(specimen);
 272                 }
 273             }
 274             labelProvider.updateLabelCache(rootElements);
 275             viewer.setInput(rootElements);
 276
 277             getEditorSite().getActionBars().getStatusLineManager().setMessage(rootElements.size() +" derivative hierarchies found");
 278
 279     }
 280
 281     public void updateLabelCache(){
 282         labelProvider.updateLabelCache(rootElements);
 283     }
 284
 285     @Override
 286     public void doSave(IProgressMonitor monitor) {
 287         String taskName = Messages.DerivateView_SAVING_HIERARCHY;
 288         monitor.beginTask(taskName, 3);
 289         if (!conversation.isBound()) {
 290             conversation.bind();
 291         }
 292         monitor.worked(1);
 293
 294         // commit the conversation and start a new transaction immediately
 295         conversation.commit(true);
 296
 297         if(CdmStore.getCurrentSessionManager().isRemoting()) {
 298             CdmStore.getService(IOccurrenceService.class).merge(new ArrayList<SpecimenOrObservationBase>(rootElements), true);
 299         }
 300         monitor.worked(1);
 301
 302         this.setDirty(false);
 303         monitor.worked(1);
 304         monitor.done();
 305         firePropertyChange(PROP_DIRTY);
 306         refreshTree();
 307     }
 308
 309     @Override
 310     public void doSaveAs() {
 311     }
 312
 313     @Override
 314     public String getTitleToolTip() {
 315         return Messages.DerivateView_DERIVATIVE_EDITOR;
 316     }
 317
 318     @Override
 319     public boolean isDirty() {
 320         return isDirty;
 321     }
 322
 323     /**
 324      * @param isDirty the isDirty to set
 325      */
 326     public void setDirty(boolean isDirty) {
 327         this.isDirty = isDirty;
 328     }
 329
 330     @Override
 331     public boolean isSaveAsAllowed() {
 332         return false;
 333     }
 334
 335     @Override
 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()){
 340             conversation.bind();
 341         }
 342         if(cdmEntitySession != null) {
 343             cdmEntitySession.bind();
 344         }
 345     }
 346
 347     @Override
 348     public void update(CdmDataChangeMap changeEvents) {
 349     }
 350
 351     @Override
 352     public ConversationHolder getConversationHolder() {
 353         return conversation;
 354     }
 355
 356     @Override
 357     public void changed(Object element) {
 358         setDirty(true);
 359         firePropertyChange(IEditorPart.PROP_DIRTY);
 360         viewer.update(new TreeNode(element), null);
 361     }
 362
 363     @Override
 364     public void forceDirty() {
 365         changed(null);
 366     }
 367
 368     @Override
 369     public Map<Object, List<String>> getPropertyPathsMap() {
 370         List<String> specimenPropertyPaths = Arrays.asList(new String[] {
 371                 "descriptions",
 372                 "derivationEvents.derivates",
 373                 "annotations",
 374                 "markers",
 375                 "credits",
 376                 "extensions",
 377                 "rights",
 378                 "sources"
 379         });
 380         Map<Object, List<String>> specimenPropertyPathMap =
 381                 new HashMap<Object, List<String>>();
 382         specimenPropertyPathMap.put(SpecimenOrObservationBase.class,specimenPropertyPaths);
 383         return specimenPropertyPathMap;
 384     }
 385
 386     /**
 387      * Refreshes the derivate hierarchy tree and expands the tree
 388      * to show and select the given object.
 389      *
 390      * @param expandTo the object to which the tree should be expanded
 391      */
 392     public void refreshTree(Object expandTo){
 393         refreshTree();
 394         TreeSelection selection = (TreeSelection) viewer.getSelection();
 395         viewer.expandToLevel(selection.getFirstElement(), 1);
 396         viewer.setSelection(new StructuredSelection(new TreeNode(expandTo)));
 397     }
 398
 399     /**
 400      * Refreshes the derivate hierarchy tree
 401      */
 402     public void refreshTree(){
 403         viewer.refresh();
 404     }
 405
 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);
 411     }
 412
 413     /**
 414      * @return a set of {@link SingleRead}s that have multiple parents
 415      */
 416     public Set<SingleRead> getMultiLinkSingleReads() {
 417         return DerivateLabelProvider.getMultiLinkSingleReads();
 418     }
 419
 420     public Object getSelectionInput() {
 421         return selectedTaxon;
 422     }
 423
 424     public DerivateLabelProvider getLabelProvider() {
 425         return labelProvider;
 426     }
 427
 428     @Override
 429     public boolean postOperation(CdmBase objectAffectedByOperation) {
 430         refreshTree();
 431         if(objectAffectedByOperation!=null){
 432             changed(objectAffectedByOperation);
 433         }
 434         return true;
 435     }
 436
 437     @Override
 438     public boolean onComplete() {
 439         return true;
 440     }
 441
 442
 443     @Override
 444     public boolean canAttachMedia() {
 445         return true;
 446     }
 447
 448     public void addFieldUnit(FieldUnit fieldUnit) {
 449         rootElements.add(fieldUnit);
 450         derivateToRootEntityMap.put(fieldUnit, fieldUnit);
 451     }
 452
 453     @Override
 454     public ICdmEntitySession getCdmEntitySession() {
 455         return cdmEntitySession;
 456     }
 457
 458     @Override
 459     public void dispose() {
 460         super.dispose();
 461         if(conversation!=null){
 462             conversation.close();
 463         }
 464         if(cdmEntitySession != null) {
 465             cdmEntitySession.dispose();
 466         }
 467     }
 468
 469     @Override
 470     public void selectionChanged(IWorkbenchPart part, ISelection selection) {
 471         if(viewer.getTree().isDisposed()){
 472             return;
 473         }
 474         if(listenToSelectionChange){
 475             if(part instanceof MultiPageTaxonEditor){
 476                 selectedTaxon = ((MultiPageTaxonEditor) part).getTaxon();
 477             }
 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();
 483                     }
 484                     else if(((CdmBase) selectedElement).isInstanceOf(Taxon.class)){
 485                         selectedTaxon = HibernateProxyHelper.deproxy(selectedElement, Taxon.class);
 486                     }
 487                 }
 488             }
 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());
 494                 }
 495                 updateRootEntities(uuids);
 496                 setPartName("Derivative Editor: " + selectedTaxon.getName());
 497             }
 498         }
 499     }
 500
 501     public TreeViewer getViewer() {
 502         return viewer;
 503     }
 504
 505     /**
 506      * {@inheritDoc}
 507      */
 508     @Override
 509     public List<SpecimenOrObservationBase<?>> getRootEntities() {
 510         return new ArrayList<SpecimenOrObservationBase<?>>(rootElements);
 511     }
 512
 513     public void toggleListenToSelectionChange() {
 514         listenToSelectionChange = !listenToSelectionChange;
 515         derivateSearchCompositeController.setEnabled(!listenToSelectionChange);
 516         if(!listenToSelectionChange){
 517             selectedTaxon = null;
 518             setPartName("Derivative Editor");
 519         }
 520         else if(selectedTaxon==null){
 521             setPartName("Derivative Editor [no taxon selected]");
 522         }
 523     }
 524
 525     public boolean isListenToSelectionChange(){
 526         return listenToSelectionChange;
 527     }
 528
 529     /**
 530      * {@inheritDoc}
 531      */
 532     @Override
 533     public void contextAboutToStop(IMemento memento, IProgressMonitor monitor) {
 534     }
 535
 536     /**
 537      * {@inheritDoc}
 538      */
 539     @Override
 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);
 545         }
 546     }
 547
 548     /**
 549      * {@inheritDoc}
 550      */
 551     @Override
 552     public void contextStart(IMemento memento, IProgressMonitor monitor) {
 553         derivateSearchCompositeController.setEnabled(!listenToSelectionChange);
 554         viewer.getTree().setEnabled(true);
 555         refreshTree();
 556     }
 557
 558     /**
 559      * {@inheritDoc}
 560      */
 561     @Override
 562     public void contextRefresh(IProgressMonitor monitor) {
 563     }
 564
 565     /**
 566      * {@inheritDoc}
 567      */
 568     @Override
 569     public void workbenchShutdown(IMemento memento, IProgressMonitor monitor) {
 570     }
 571
 572 }