eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/view/e4/AbstractCdmEditorPartE4.java

   1 /**
   2 * Copyright (C) 2017 EDIT
   3 * European Distributed Institute of Taxonomy
   4 * http://www.e-taxonomy.eu
   5 *
   6 * The contents of this file are subject to the Mozilla Public License Version 1.1
   7 * See LICENSE.TXT at the top of this package for the full license terms.
   8 */
   9 package eu.etaxonomy.taxeditor.view.e4;
  10
  11 import java.util.Set;
  12
  13 import javax.annotation.PreDestroy;
  14 import javax.inject.Inject;
  15 import javax.inject.Named;
  16
  17 import org.eclipse.e4.core.di.annotations.Optional;
  18 import org.eclipse.e4.ui.di.PersistState;
  19 import org.eclipse.e4.ui.di.UISynchronize;
  20 import org.eclipse.e4.ui.model.application.ui.basic.MPart;
  21 import org.eclipse.e4.ui.services.IServiceConstants;
  22 import org.eclipse.e4.ui.workbench.modeling.EPartService;
  23 import org.eclipse.e4.ui.workbench.modeling.ESelectionService;
  24 import org.eclipse.jface.viewers.ISelectionChangedListener;
  25 import org.eclipse.jface.viewers.IStructuredSelection;
  26 import org.eclipse.jface.viewers.StructuredSelection;
  27 import org.eclipse.jface.viewers.Viewer;
  28
  29 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
  30 import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;
  31 import eu.etaxonomy.cdm.hibernate.HibernateProxyHelper;
  32 import eu.etaxonomy.cdm.model.common.CdmBase;
  33 import eu.etaxonomy.cdm.model.description.Distribution;
  34 import eu.etaxonomy.cdm.model.taxon.Taxon;
  35 import eu.etaxonomy.cdm.model.taxon.TaxonRelationship;
  36 import eu.etaxonomy.cdm.model.taxon.TaxonRelationshipType;
  37 import eu.etaxonomy.cdm.persistence.hibernate.CdmDataChangeMap;
  38 import eu.etaxonomy.taxeditor.editor.IDistributionEditor;
  39 import eu.etaxonomy.taxeditor.editor.ITaxonEditor;
  40 import eu.etaxonomy.taxeditor.event.EventUtility;
  41 import eu.etaxonomy.taxeditor.model.IDirtyMarkable;
  42 import eu.etaxonomy.taxeditor.operation.IPostOperationEnabled;
  43 import eu.etaxonomy.taxeditor.view.e4.details.DetailsViewerE4;
  44 import eu.etaxonomy.taxeditor.workbench.WorkbenchUtility;
  45 import eu.etaxonomy.taxeditor.workbench.part.ISelectionElementEditingPart;
  46
  47 /**
  48  * @author pplitzner
  49  * @since Aug 10, 2017
  50  *
  51  */
  52 public abstract class AbstractCdmEditorPartE4
  53         implements IConversationEnabled, IDirtyMarkable, ISelectionElementEditingPart, IPostOperationEnabled{
  54
  55     private DelaySelection delaySelection = null;
  56     /**
  57      * This is the monitor for the DelaySelection runnable.
  58      * If it is <code>true</code> then it is currently delaying a selection.
  59      */
  60     private boolean isInDelay;
  61
  62
  63     /**
  64      * This class invokes internal_selectionChanged() in a separate thread.
  65      * This allows an asynchronous and/or delayed handling of selection changes
  66      */
  67     private class DelaySelection implements Runnable{
  68         private Object selection;
  69         private MPart activePart;
  70         private MPart thisPart;
  71
  72         public DelaySelection(Object selection, MPart activePart, MPart thisPart) {
  73             super();
  74             this.selection = selection;
  75             this.activePart= activePart;
  76             this.thisPart = thisPart;
  77         }
  78
  79         @Override
  80         public void run() {
  81             try{
  82                 selectionChanged_internal(selection, activePart, thisPart);
  83             }
  84             finally{
  85                 isInDelay = false;
  86             }
  87         }
  88
  89         public synchronized void setSelection(Object selection) {
  90             this.selection = selection;
  91         }
  92
  93         public synchronized void setActivePart(MPart activePart) {
  94             this.activePart = activePart;
  95         }
  96
  97         public synchronized void setThisPart(MPart thisPart) {
  98             this.thisPart = thisPart;
  99         }
 100
 101     }
 102
 103     protected Viewer viewer;
 104
 105     protected MPart thisPart;
 106
 107     protected MPart selectionProvidingPart;
 108
 109     protected Object previousSelection;
 110
 111     protected ISelectionChangedListener selectionChangedListener;
 112
 113     public ISelectionChangedListener getSelectionChangedListener() {
 114         return selectionChangedListener;
 115     }
 116
 117     @Inject
 118     protected ESelectionService selService;
 119
 120     protected abstract void selectionChanged_internal(Object selection, MPart activePart, MPart thisPart);
 121
 122     @Inject
 123     public void selectionChanged(
 124             @Optional@Named(IServiceConstants.ACTIVE_SELECTION)Object selection,
 125             @Optional@Named(IServiceConstants.ACTIVE_PART)MPart activePart,
 126             MPart thisPart, UISynchronize sync, EPartService partService){
 127         if(activePart==thisPart && EventUtility.getActiveEditorPart(partService)==null){
 128             showEmptyPage();
 129             return;
 130         }
 131         viewer.getControl().setEnabled(true);
 132         if(previousSelection==null ||
 133                 previousSelection!=selection){//skip redundant rendering of details view
 134             if(delaySelection==null){
 135                 delaySelection = new DelaySelection(selection, activePart, thisPart);
 136             }
 137             delaySelection.setSelection(selection);
 138             delaySelection.setActivePart(activePart);
 139             delaySelection.setThisPart(thisPart);
 140             if(!isInDelay){
 141                 isInDelay = true;
 142                 sync.asyncExec(delaySelection);
 143                 previousSelection = selection;
 144             }
 145         }
 146     }
 147
 148     /** {@inheritDoc} */
 149     @Override
 150     public void changed(Object object) {
 151         if(selectionProvidingPart!=null){
 152             Object part = selectionProvidingPart.getObject();
 153             if(part instanceof IDirtyMarkable){
 154                 ((IDirtyMarkable) part).changed(object);
 155             }
 156         }
 157     }
 158
 159     public Viewer getViewer() {
 160         return viewer;
 161     }
 162
 163     protected void showViewer(IStructuredSelection selection, MPart activePart, Viewer viewer){
 164         if(viewer!=null && viewer.getControl()!=null && !viewer.getControl().isDisposed()){
 165             Object element = selection.getFirstElement();
 166             Object part = createPartObject(activePart);
 167             viewer.getControl().setEnabled(true);
 168             if(selection.getFirstElement()!=null){
 169                 if (element instanceof Taxon){
 170                     Taxon taxon = HibernateProxyHelper.deproxy(element, Taxon.class);
 171                     if (taxon.isMisapplication()){
 172
 173                         if(part instanceof ITaxonEditor){
 174                             Taxon accepted = ((ITaxonEditor) part).getTaxon();
 175
 176                             //                                  Taxon accepted= ((ITaxonEditor)activePart).getTaxon();
 177                             Set<TaxonRelationship> rels =  taxon.getTaxonRelations(accepted);
 178
 179                             if (rels.iterator().hasNext()){
 180                                 TaxonRelationship rel = rels.iterator().next();
 181                                 if (rel.getType().equals(TaxonRelationshipType.MISAPPLIED_NAME_FOR()) && !rel.getFromTaxon().equals(((ITaxonEditor) part).getTaxon())){
 182                                     viewer.setInput(rel);
 183
 184                                     return;
 185                                 }
 186                             }
 187                         }
 188
 189
 190                     }
 191                 }
 192                 if (element instanceof Distribution && part instanceof IDistributionEditor){
 193                     ((DetailsViewerE4)viewer).setInput(element, part);
 194                 }else{
 195                     viewer.setInput(element);
 196                 }
 197                 selectionProvidingPart = activePart;
 198             }
 199         }
 200     }
 201
 202     protected Object createPartObject(MPart activePart) {
 203         Object partObject = activePart;
 204         Object wrappedPart = WorkbenchUtility.getE4WrappedPart(activePart);
 205         if(wrappedPart!=null){
 206             partObject = wrappedPart;
 207         }
 208         return partObject;
 209     }
 210
 211     protected void showEmptyPage() {
 212         if(viewer!=null && viewer.getControl()!=null && !viewer.getControl().isDisposed()){
 213             viewer.setInput(null);
 214             viewer.getControl().setEnabled(false);
 215         }
 216         selectionProvidingPart = null;
 217         if(thisPart!=null){
 218             thisPart.setLabel(getViewName());
 219         }
 220     }
 221
 222     protected IStructuredSelection createSelection(Object selection) {
 223         if(selection==null){
 224             return null;
 225         }
 226         IStructuredSelection structuredSelection;
 227         if(!(selection instanceof IStructuredSelection)){
 228             structuredSelection = new StructuredSelection(selection);
 229         }
 230         else{
 231             structuredSelection = (IStructuredSelection) selection;
 232         }
 233         return structuredSelection;
 234     }
 235
 236     /**
 237      * {@inheritDoc}
 238      */
 239     @Override
 240     public ConversationHolder getConversationHolder() {
 241         if(selectionProvidingPart != null && selectionProvidingPart instanceof IConversationEnabled) {
 242             return ((IConversationEnabled) selectionProvidingPart).getConversationHolder();
 243         }
 244         return null;
 245     }
 246
 247     /**
 248      * {@inheritDoc}
 249      */
 250     @Override
 251     public boolean postOperation(CdmBase objectAffectedByOperation) {
 252         changed(objectAffectedByOperation);
 253         return true;
 254     }
 255
 256     /**
 257      * {@inheritDoc}
 258      */
 259     @Override
 260     public boolean onComplete() {
 261         viewer.refresh();
 262         return true;
 263     }
 264
 265     /**
 266      * {@inheritDoc}
 267      */
 268     @Override
 269     public Object getSelectionProvidingPart() {
 270         return selectionProvidingPart;
 271     }
 272
 273     @PreDestroy
 274     private void dispose() {
 275     }
 276
 277     @PersistState
 278     private void persistState(){
 279
 280     }
 281
 282     /**
 283      * {@inheritDoc}
 284      */
 285     @Override
 286     public void update(CdmDataChangeMap arg0) {
 287     }
 288
 289     /**
 290      * {@inheritDoc}
 291      */
 292     @Override
 293     public void forceDirty() {
 294     }
 295
 296     protected abstract String getViewName();
 297
 298 }