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