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.initCache(rootElements);
 275             viewer.setInput(rootElements);
 276
 277             getEditorSite().getActionBars().getStatusLineManager().setMessage(rootElements.size() +" derivative hierarchies found");
 278
 279     }
 280
 281     @Override
 282     public void doSave(IProgressMonitor monitor) {
 283         String taskName = Messages.DerivateView_SAVING_HIERARCHY;
 284         monitor.beginTask(taskName, 3);
 285         if (!conversation.isBound()) {
 286             conversation.bind();
 287         }
 288         monitor.worked(1);
 289
 290         // commit the conversation and start a new transaction immediately
 291         conversation.commit(true);
 292
 293         if(CdmStore.getCurrentSessionManager().isRemoting()) {
 294             CdmStore.getService(IOccurrenceService.class).merge(new ArrayList<SpecimenOrObservationBase>(rootElements), true);
 295         }
 296         monitor.worked(1);
 297
 298         this.setDirty(false);
 299         monitor.worked(1);
 300         monitor.done();
 301         firePropertyChange(PROP_DIRTY);
 302         refreshTree();
 303     }
 304
 305     @Override
 306     public void doSaveAs() {
 307     }
 308
 309     @Override
 310     public String getTitleToolTip() {
 311         return Messages.DerivateView_DERIVATIVE_EDITOR;
 312     }
 313
 314     @Override
 315     public boolean isDirty() {
 316         return isDirty;
 317     }
 318
 319     /**
 320      * @param isDirty the isDirty to set
 321      */
 322     public void setDirty(boolean isDirty) {
 323         this.isDirty = isDirty;
 324     }
 325
 326     @Override
 327     public boolean isSaveAsAllowed() {
 328         return false;
 329     }
 330
 331     @Override
 332     public void setFocus() {
 333         viewer.getControl().setFocus();
 334         //make sure to bind again if maybe in another view the conversation was unbound
 335         if(conversation!=null && !conversation.isBound()){
 336             conversation.bind();
 337         }
 338         if(cdmEntitySession != null) {
 339             cdmEntitySession.bind();
 340         }
 341     }
 342
 343     @Override
 344     public void update(CdmDataChangeMap changeEvents) {
 345     }
 346
 347     @Override
 348     public ConversationHolder getConversationHolder() {
 349         return conversation;
 350     }
 351
 352     @Override
 353     public void changed(Object element) {
 354         setDirty(true);
 355         firePropertyChange(IEditorPart.PROP_DIRTY);
 356         viewer.update(new TreeNode(element), null);
 357     }
 358
 359     @Override
 360     public void forceDirty() {
 361         changed(null);
 362     }
 363
 364     @Override
 365     public Map<Object, List<String>> getPropertyPathsMap() {
 366         List<String> specimenPropertyPaths = Arrays.asList(new String[] {
 367                 "descriptions",
 368                 "derivationEvents.derivates",
 369                 "annotations",
 370                 "markers",
 371                 "credits",
 372                 "extensions",
 373                 "rights",
 374                 "sources"
 375         });
 376         Map<Object, List<String>> specimenPropertyPathMap =
 377                 new HashMap<Object, List<String>>();
 378         specimenPropertyPathMap.put(SpecimenOrObservationBase.class,specimenPropertyPaths);
 379         return specimenPropertyPathMap;
 380     }
 381
 382     /**
 383      * Refreshes the derivate hierarchy tree and expands the tree
 384      * to show and select the given object.
 385      *
 386      * @param expandTo the object to which the tree should be expanded
 387      */
 388     public void refreshTree(Object expandTo){
 389         refreshTree();
 390         TreeSelection selection = (TreeSelection) viewer.getSelection();
 391         viewer.expandToLevel(selection.getFirstElement(), 1);
 392         viewer.setSelection(new StructuredSelection(new TreeNode(expandTo)));
 393     }
 394
 395     /**
 396      * Refreshes the derivate hierarchy tree
 397      */
 398     public void refreshTree(){
 399         viewer.refresh();
 400     }
 401
 402     //FIXME:Remoting hack to make this work for remoting
 403     //This should actually be resolved using remoting post operations
 404     public void remove(Object obj) {
 405         rootElements.remove(obj);
 406         viewer.setInput(rootElements);
 407     }
 408
 409     /**
 410      * @return a set of {@link SingleRead}s that have multiple parents
 411      */
 412     public Set<SingleRead> getMultiLinkSingleReads() {
 413         return DerivateLabelProvider.getMultiLinkSingleReads();
 414     }
 415
 416     public Object getSelectionInput() {
 417         return selectedTaxon;
 418     }
 419
 420     public DerivateLabelProvider getLabelProvider() {
 421         return labelProvider;
 422     }
 423
 424     @Override
 425     public boolean postOperation(CdmBase objectAffectedByOperation) {
 426         refreshTree();
 427         if(objectAffectedByOperation!=null){
 428             changed(objectAffectedByOperation);
 429         }
 430         return true;
 431     }
 432
 433     @Override
 434     public boolean onComplete() {
 435         return true;
 436     }
 437
 438
 439     @Override
 440     public boolean canAttachMedia() {
 441         return true;
 442     }
 443
 444     public void addFieldUnit(FieldUnit fieldUnit) {
 445         rootElements.add(fieldUnit);
 446         derivateToRootEntityMap.put(fieldUnit, fieldUnit);
 447     }
 448
 449     @Override
 450     public ICdmEntitySession getCdmEntitySession() {
 451         return cdmEntitySession;
 452     }
 453
 454     @Override
 455     public void dispose() {
 456         super.dispose();
 457         if(conversation!=null){
 458             conversation.close();
 459         }
 460         if(cdmEntitySession != null) {
 461             cdmEntitySession.dispose();
 462         }
 463     }
 464
 465     @Override
 466     public void selectionChanged(IWorkbenchPart part, ISelection selection) {
 467         if(viewer.getTree().isDisposed()){
 468             return;
 469         }
 470         if(listenToSelectionChange){
 471             if(part instanceof MultiPageTaxonEditor){
 472                 selectedTaxon = ((MultiPageTaxonEditor) part).getTaxon();
 473             }
 474             else if(selection instanceof IStructuredSelection){
 475                 Object selectedElement = ((IStructuredSelection) selection).getFirstElement();
 476                 if(selectedElement instanceof CdmBase){
 477                     if(((CdmBase) selectedElement).isInstanceOf(TaxonNode.class)){
 478                         selectedTaxon = HibernateProxyHelper.deproxy(selectedElement, TaxonNode.class).getTaxon();
 479                     }
 480                     else if(((CdmBase) selectedElement).isInstanceOf(Taxon.class)){
 481                         selectedTaxon = HibernateProxyHelper.deproxy(selectedElement, Taxon.class);
 482                     }
 483                 }
 484             }
 485             if(selectedTaxon!=null){
 486                 Collection<SpecimenOrObservationBase> fieldUnits = CdmStore.getService(IOccurrenceService.class).listFieldUnitsByAssociatedTaxon(selectedTaxon, null, null);
 487                 Collection<UUID> uuids = new HashSet<UUID>();
 488                 for (SpecimenOrObservationBase specimenOrObservationBase : fieldUnits) {
 489                     uuids.add(specimenOrObservationBase.getUuid());
 490                 }
 491                 updateRootEntities(uuids);
 492                 setPartName("Derivative Editor: " + selectedTaxon.getName());
 493             }
 494         }
 495     }
 496
 497     public TreeViewer getViewer() {
 498         return viewer;
 499     }
 500
 501     /**
 502      * {@inheritDoc}
 503      */
 504     @Override
 505     public List<SpecimenOrObservationBase<?>> getRootEntities() {
 506         return new ArrayList<SpecimenOrObservationBase<?>>(rootElements);
 507     }
 508
 509     public void toggleListenToSelectionChange() {
 510         listenToSelectionChange = !listenToSelectionChange;
 511         derivateSearchCompositeController.setEnabled(!listenToSelectionChange);
 512         if(!listenToSelectionChange){
 513             selectedTaxon = null;
 514             setPartName("Derivative Editor");
 515         }
 516         else if(selectedTaxon==null){
 517             setPartName("Derivative Editor [no taxon selected]");
 518         }
 519     }
 520
 521     public boolean isListenToSelectionChange(){
 522         return listenToSelectionChange;
 523     }
 524
 525     /**
 526      * {@inheritDoc}
 527      */
 528     @Override
 529     public void contextAboutToStop(IMemento memento, IProgressMonitor monitor) {
 530     }
 531
 532     /**
 533      * {@inheritDoc}
 534      */
 535     @Override
 536     public void contextStop(IMemento memento, IProgressMonitor monitor) {
 537         derivateSearchCompositeController.setEnabled(false);
 538         if(!viewer.getTree().isDisposed()) {
 539             viewer.getTree().setEnabled(false);
 540             viewer.setInput(null);
 541         }
 542     }
 543
 544     /**
 545      * {@inheritDoc}
 546      */
 547     @Override
 548     public void contextStart(IMemento memento, IProgressMonitor monitor) {
 549         derivateSearchCompositeController.setEnabled(!listenToSelectionChange);
 550         viewer.getTree().setEnabled(true);
 551         refreshTree();
 552     }
 553
 554     /**
 555      * {@inheritDoc}
 556      */
 557     @Override
 558     public void contextRefresh(IProgressMonitor monitor) {
 559     }
 560
 561     /**
 562      * {@inheritDoc}
 563      */
 564     @Override
 565     public void workbenchShutdown(IMemento memento, IProgressMonitor monitor) {
 566     }
 567
 568 }