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         getSite().registerContextMenu(menuManager, viewer);
 199         Control control = viewer.getControl();
 200         Menu menu = menuManager.createContextMenu(control);
 201         control.setMenu(menu);
 202
 203         //init tree
 204         updateRootEntities();
 205
 206         //add drag'n'drop support
 207         Transfer[] transfers = new Transfer[] {LocalSelectionTransfer.getTransfer(),};
 208         viewer.addDragSupport(dndOperations, transfers, new DerivateDragListener(this));
 209         viewer.addDropSupport(dndOperations, transfers, new DerivateDropListener(this));
 210     }
 211
 212     public void updateRootEntities() {
 213         updateRootEntities((Collection)null);
 214     }
 215
 216     public void updateRootEntities(Collection<UUID> derivativeUuids) {
 217         if(conversation!=null){
 218             if (!conversation.isBound()) {
 219                 conversation.bind();
 220             }
 221             /*
 222              * If the active session is not the session of the Derivate Editor then we will
 223              * save it, bind temporarily to our session and rebind to the original session.
 224              * This happens e.g. if a selection change happens in the taxon editor and
 225              * "Link with editor" is enabled. The selection change event and thus the
 226              * loading in updateRootEntities() happens in the session of the taxon
 227              * editor.
 228              */
 229             ICdmEntitySession previousCdmEntitySession = CdmStore.getCurrentSessionManager().getActiveSession();
 230             if(cdmEntitySession != null) {
 231                 cdmEntitySession.bind();
 232             }
 233
 234             if(derivativeUuids!=null){
 235                 this.derivateToRootEntityMap = new HashMap<SpecimenOrObservationBase<?>, SpecimenOrObservationBase<?>>();
 236                 this.rootElements = new HashSet<SpecimenOrObservationBase<?>>();
 237                 List<SpecimenOrObservationBase> derivates =
 238                         CdmStore.getService(IOccurrenceService.class).load(new ArrayList(derivativeUuids), SPECIMEN_INIT_STRATEGY);
 239                 updateRootEntities(derivates);
 240             }
 241             refreshTree(false);
 242             previousCdmEntitySession.bind();
 243         }
 244     }
 245
 246
 247     public void updateRootEntities(List<SpecimenOrObservationBase> derivates) {
 248
 249             if(derivates!=null){
 250                 this.derivateToRootEntityMap = new HashMap<SpecimenOrObservationBase<?>, SpecimenOrObservationBase<?>>();
 251                 this.rootElements = new HashSet<SpecimenOrObservationBase<?>>();
 252                 for (SpecimenOrObservationBase derivate : derivates) {
 253
 254                     if(derivate instanceof FieldUnit){
 255                         derivateToRootEntityMap.put(derivate, derivate);
 256                     }
 257                     else {
 258                         SpecimenOrObservationBase<?> topMostDerivate = EditorUtil.getTopMostDerivate(derivate);
 259                         if(topMostDerivate!=null){
 260                             derivateToRootEntityMap.put(derivate, topMostDerivate);
 261                         }
 262                         else{
 263                             derivateToRootEntityMap.put(derivate, derivate);
 264                         }
 265                     }
 266                 }
 267                 for (SpecimenOrObservationBase<?> specimen : derivateToRootEntityMap.values()) {
 268                     rootElements.add(specimen);
 269                 }
 270             }
 271             viewer.setInput(rootElements);
 272
 273     }
 274
 275     @Override
 276     public void doSave(IProgressMonitor monitor) {
 277         String taskName = Messages.DerivateView_SAVING_HIERARCHY;
 278         monitor.beginTask(taskName, 3);
 279         if (!conversation.isBound()) {
 280             conversation.bind();
 281         }
 282         monitor.worked(1);
 283
 284         // commit the conversation and start a new transaction immediately
 285         conversation.commit(true);
 286
 287         if(CdmStore.getCurrentSessionManager().isRemoting()) {
 288             CdmStore.getService(IOccurrenceService.class).merge(new ArrayList<SpecimenOrObservationBase>(rootElements), true);
 289         }
 290         monitor.worked(1);
 291
 292         this.setDirty(false);
 293         monitor.worked(1);
 294         monitor.done();
 295         firePropertyChange(PROP_DIRTY);
 296         refreshTree();
 297     }
 298
 299     @Override
 300     public void doSaveAs() {
 301     }
 302
 303     @Override
 304     public String getTitleToolTip() {
 305         return Messages.DerivateView_DERIVATIVE_EDITOR;
 306     }
 307
 308     @Override
 309     public boolean isDirty() {
 310         return isDirty;
 311     }
 312
 313     /**
 314      * @param isDirty the isDirty to set
 315      */
 316     public void setDirty(boolean isDirty) {
 317         this.isDirty = isDirty;
 318     }
 319
 320     @Override
 321     public boolean isSaveAsAllowed() {
 322         return false;
 323     }
 324
 325     @Override
 326     public void setFocus() {
 327         viewer.getControl().setFocus();
 328         //make sure to bind again if maybe in another view the conversation was unbound
 329         if(conversation!=null && !conversation.isBound()){
 330             conversation.bind();
 331         }
 332         if(cdmEntitySession != null) {
 333             cdmEntitySession.bind();
 334         }
 335     }
 336
 337     @Override
 338     public void update(CdmDataChangeMap changeEvents) {
 339     }
 340
 341     @Override
 342     public ConversationHolder getConversationHolder() {
 343         return conversation;
 344     }
 345
 346     @Override
 347     public void changed(Object element) {
 348         setDirty(true);
 349         firePropertyChange(IEditorPart.PROP_DIRTY);
 350         viewer.refresh();
 351     }
 352
 353     @Override
 354     public void forceDirty() {
 355         changed(null);
 356     }
 357
 358     @Override
 359     public Map<Object, List<String>> getPropertyPathsMap() {
 360         List<String> specimenPropertyPaths = Arrays.asList(new String[] {
 361                 "descriptions",
 362                 "derivationEvents.derivates",
 363                 "annotations",
 364                 "markers",
 365                 "credits",
 366                 "extensions",
 367                 "rights",
 368                 "sources"
 369         });
 370         Map<Object, List<String>> specimenPropertyPathMap =
 371                 new HashMap<Object, List<String>>();
 372         specimenPropertyPathMap.put(SpecimenOrObservationBase.class,specimenPropertyPaths);
 373         return specimenPropertyPathMap;
 374     }
 375
 376     /**
 377      * Refreshes the derivate hierarchy tree and expands the tree
 378      * to show and select the given object.
 379      *
 380      * @param expandTo the object to which the tree should be expanded
 381      */
 382     public void refreshTree(Object expandTo){
 383         refreshTree();
 384         TreeSelection selection = (TreeSelection) viewer.getSelection();
 385         viewer.expandToLevel(selection.getFirstElement(), 1);
 386         viewer.setSelection(new StructuredSelection(new TreeNode(expandTo)));
 387     }
 388
 389     /**
 390      * Refreshes the derivate hierarchy tree
 391      */
 392     public void refreshTree(){
 393         refreshTree(true);
 394     }
 395
 396     /**
 397      * Refreshes the derivate hierarchy tree
 398      * @param refreshViewer if <code>true</code> then also the
 399      * viewer will be refreshed. This was implemented due to
 400      * performance reasons. If passing <code>false</code>
 401      * does what was expected use <code>false</code> preferably.
 402      */
 403     public void refreshTree(boolean refreshViewer){
 404         //refresh typedesignations
 405         labelProvider.refresh();
 406         if(refreshViewer){
 407             viewer.refresh();
 408         }
 409     }
 410
 411     //FIXME:Remoting hack to make this work for remoting
 412     //This should actually be resolved using remoting post operations
 413     public void remove(Object obj) {
 414         rootElements.remove(obj);
 415         viewer.setInput(rootElements);
 416     }
 417
 418     /**
 419      * @return a set of {@link SingleRead}s that have multiple parents
 420      */
 421     public Set<SingleRead> getMultiLinkSingleReads() {
 422         return DerivateLabelProvider.getMultiLinkSingleReads();
 423     }
 424
 425     public Object getSelectionInput() {
 426         return selectedTaxon;
 427     }
 428
 429     public DerivateLabelProvider getLabelProvider() {
 430         return labelProvider;
 431     }
 432
 433     @Override
 434     public boolean postOperation(CdmBase objectAffectedByOperation) {
 435         refreshTree();
 436         if(objectAffectedByOperation!=null){
 437             changed(objectAffectedByOperation);
 438         }
 439         return true;
 440     }
 441
 442     @Override
 443     public boolean onComplete() {
 444         return true;
 445     }
 446
 447
 448     @Override
 449     public boolean canAttachMedia() {
 450         return true;
 451     }
 452
 453     public void addFieldUnit(FieldUnit fieldUnit) {
 454         rootElements.add(fieldUnit);
 455         derivateToRootEntityMap.put(fieldUnit, fieldUnit);
 456     }
 457
 458     @Override
 459     public ICdmEntitySession getCdmEntitySession() {
 460         return cdmEntitySession;
 461     }
 462
 463     @Override
 464     public void dispose() {
 465         super.dispose();
 466         if(conversation!=null){
 467             conversation.close();
 468         }
 469         if(cdmEntitySession != null) {
 470             cdmEntitySession.dispose();
 471         }
 472     }
 473
 474     @Override
 475     public void selectionChanged(IWorkbenchPart part, ISelection selection) {
 476         if(viewer.getTree().isDisposed()){
 477             return;
 478         }
 479         if(listenToSelectionChange){
 480             if(part instanceof MultiPageTaxonEditor){
 481                 selectedTaxon = ((MultiPageTaxonEditor) part).getTaxon();
 482             }
 483             else if(selection instanceof IStructuredSelection){
 484                 Object selectedElement = ((IStructuredSelection) selection).getFirstElement();
 485                 if(selectedElement instanceof CdmBase){
 486                     if(((CdmBase) selectedElement).isInstanceOf(TaxonNode.class)){
 487                         selectedTaxon = HibernateProxyHelper.deproxy(selectedElement, TaxonNode.class).getTaxon();
 488                     }
 489                     else if(((CdmBase) selectedElement).isInstanceOf(Taxon.class)){
 490                         selectedTaxon = HibernateProxyHelper.deproxy(selectedElement, Taxon.class);
 491                     }
 492                 }
 493             }
 494             Collection<SpecimenOrObservationBase> fieldUnits = CdmStore.getService(IOccurrenceService.class).listFieldUnitsByAssociatedTaxon(selectedTaxon, null, null);
 495             Collection<UUID> uuids = new HashSet<UUID>();
 496             for (SpecimenOrObservationBase specimenOrObservationBase : fieldUnits) {
 497                 uuids.add(specimenOrObservationBase.getUuid());
 498             }
 499             updateRootEntities(uuids);
 500             setPartName("Derivative Editor: " + selectedTaxon.getName());
 501         }
 502     }
 503
 504     public TreeViewer getViewer() {
 505         return viewer;
 506     }
 507
 508     /**
 509      * {@inheritDoc}
 510      */
 511     @Override
 512     public List<SpecimenOrObservationBase<?>> getRootEntities() {
 513         return new ArrayList<SpecimenOrObservationBase<?>>(rootElements);
 514     }
 515
 516     public void toggleListenToSelectionChange() {
 517         listenToSelectionChange = !listenToSelectionChange;
 518         derivateSearchCompositeController.setEnabled(!listenToSelectionChange);
 519         if(!listenToSelectionChange){
 520             selectedTaxon = null;
 521             setPartName("Derivative Editor");
 522         }
 523         else if(selectedTaxon==null){
 524             setPartName("Derivative Editor [no taxon selected]");
 525         }
 526     }
 527
 528     public boolean isListenToSelectionChange(){
 529         return listenToSelectionChange;
 530     }
 531
 532     /**
 533      * {@inheritDoc}
 534      */
 535     @Override
 536     public void contextAboutToStop(IMemento memento, IProgressMonitor monitor) {
 537     }
 538
 539     /**
 540      * {@inheritDoc}
 541      */
 542     @Override
 543     public void contextStop(IMemento memento, IProgressMonitor monitor) {
 544         derivateSearchCompositeController.setEnabled(false);
 545         viewer.getTree().setEnabled(false);
 546         viewer.setInput(null);
 547     }
 548
 549     /**
 550      * {@inheritDoc}
 551      */
 552     @Override
 553     public void contextStart(IMemento memento, IProgressMonitor monitor) {
 554         derivateSearchCompositeController.setEnabled(!listenToSelectionChange);
 555         viewer.getTree().setEnabled(true);
 556         refreshTree();
 557     }
 558
 559     /**
 560      * {@inheritDoc}
 561      */
 562     @Override
 563     public void contextRefresh(IProgressMonitor monitor) {
 564     }
 565
 566     /**
 567      * {@inheritDoc}
 568      */
 569     @Override
 570     public void workbenchShutdown(IMemento memento, IProgressMonitor monitor) {
 571     }
 572
 573 }