eu.etaxonomy.taxeditor.editor/src/main/java/eu/etaxonomy/taxeditor/editor/EditorUtil.java

   1 /**
   2  * Copyright (C) 2007 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
  10 package eu.etaxonomy.taxeditor.editor;
  11
  12 import java.util.HashSet;
  13 import java.util.Set;
  14 import java.util.UUID;
  15
  16 import org.eclipse.core.commands.ExecutionEvent;
  17 import org.eclipse.core.commands.operations.IOperationHistory;
  18 import org.eclipse.core.commands.operations.IUndoContext;
  19 import org.eclipse.jface.dialogs.MessageDialog;
  20 import org.eclipse.jface.viewers.ISelection;
  21 import org.eclipse.jface.viewers.IStructuredSelection;
  22 import org.eclipse.jface.viewers.TreeNode;
  23 import org.eclipse.swt.widgets.Shell;
  24 import org.eclipse.ui.IEditorInput;
  25 import org.eclipse.ui.IEditorPart;
  26 import org.eclipse.ui.IEditorReference;
  27 import org.eclipse.ui.IWorkbenchPage;
  28 import org.eclipse.ui.PartInitException;
  29 import org.eclipse.ui.handlers.HandlerUtil;
  30
  31 import eu.etaxonomy.cdm.api.service.ITaxonService;
  32 import eu.etaxonomy.cdm.model.common.ITreeNode;
  33 import eu.etaxonomy.cdm.model.occurrence.DerivedUnit;
  34 import eu.etaxonomy.cdm.model.occurrence.FieldUnit;
  35 import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;
  36 import eu.etaxonomy.cdm.model.taxon.TaxonBase;
  37 import eu.etaxonomy.cdm.model.taxon.TaxonNode;
  38 import eu.etaxonomy.taxeditor.editor.group.authority.CdmAuthorityEditor;
  39 import eu.etaxonomy.taxeditor.editor.group.authority.CdmAuthorityEditorInput;
  40 import eu.etaxonomy.taxeditor.editor.internal.TaxeditorEditorPlugin;
  41 import eu.etaxonomy.taxeditor.editor.key.KeyEditor;
  42 import eu.etaxonomy.taxeditor.editor.key.polytomous.PolytomousKeyEditorInput;
  43 import eu.etaxonomy.taxeditor.editor.view.checklist.ChecklistEditor;
  44 import eu.etaxonomy.taxeditor.editor.view.checklist.ChecklistEditorInput;
  45 import eu.etaxonomy.taxeditor.editor.view.dataimport.BioCaseEditorInput;
  46 import eu.etaxonomy.taxeditor.editor.view.dataimport.DataImportEditor;
  47 import eu.etaxonomy.taxeditor.editor.view.dataimport.DataImportEditorInput;
  48 import eu.etaxonomy.taxeditor.editor.view.dataimport.GbifImportEditor;
  49 import eu.etaxonomy.taxeditor.editor.view.dataimport.GbifImportEditorInput;
  50 import eu.etaxonomy.taxeditor.editor.view.dataimport.SpecimenImportEditor;
  51 import eu.etaxonomy.taxeditor.editor.view.derivate.DerivateView;
  52 import eu.etaxonomy.taxeditor.editor.view.derivate.DerivateViewEditorInput;
  53 import eu.etaxonomy.taxeditor.model.AbstractUtility;
  54 import eu.etaxonomy.taxeditor.model.MessagingUtils;
  55 import eu.etaxonomy.taxeditor.store.CdmStore;
  56
  57 /**
  58  * Utility for the editor package
  59  *
  60  * @author n.hoffmann
  61  * @created 20.01.2009
  62  * @version 1.0
  63  */
  64 public class EditorUtil extends AbstractUtility {
  65
  66         private static boolean isSaving = false;
  67
  68         /**
  69          * Opens a new editor window with the given input
  70          *
  71          * @param input
  72          * @param editorId
  73          * @return
  74          * @return
  75          * @throws PartInitException
  76          */
  77         private static IEditorPart open(final IEditorInput input,
  78                         final String editorId) throws PartInitException {
  79                 return getActivePage().openEditor(input, editorId);
  80         }
  81
  82         /**
  83          * Opens a new editor window with the given TaxonEditorInput
  84          *
  85          * @param input
  86          *            a {@link eu.etaxonomy.taxeditor.editor.TaxonEditorInput}
  87          *            object.
  88          * @throws org.eclipse.ui.PartInitException
  89          *             if any.
  90          */
  91         public static void open(TaxonEditorInput input) throws PartInitException {
  92                 open(input, MultiPageTaxonEditor.ID);
  93         }
  94
  95         public static void open(PolytomousKeyEditorInput input)
  96                         throws PartInitException {
  97                 open(input, KeyEditor.ID);
  98         }
  99
 100         public static void open(CdmAuthorityEditorInput input)
 101                         throws PartInitException {
 102                 open(input, CdmAuthorityEditor.ID);
 103         }
 104
 105         /**
 106          * Opens a new DerivateView for the given input
 107          * @param input a {@link DerivateViewEditorInput} representing the selected derivate
 108          * @throws PartInitException
 109          */
 110         public static void open(DerivateViewEditorInput input)
 111                 throws PartInitException {
 112             open(input, DerivateView.ID);
 113         }
 114
 115
 116         /**
 117          * Opens a new ChecklistView for the given input
 118          * @param input a {@link ChecklistEditorInput} representing the selected checklist
 119          * @throws PartInitException
 120          */
 121         public static void open(ChecklistEditorInput input)
 122                 throws PartInitException {
 123             open(input, ChecklistEditor.ID);
 124         }
 125
 126         /**
 127          * Opens a new {@link DataImportEditor} for the given input
 128          * @param input a {@link DataImportEditorInput}
 129          * @throws PartInitException
 130          */
 131         public static void open(DataImportEditorInput<?> input)
 132                 throws PartInitException {
 133             if(input instanceof BioCaseEditorInput){
 134                 open(input, SpecimenImportEditor.ID);
 135             }
 136             else if(input instanceof GbifImportEditorInput){
 137                 open(input, GbifImportEditor.ID);
 138             }
 139         }
 140
 141         /**
 142          * Taxon Editors may be opened by supplying a taxon node uuid. Session gets
 143          * initialised here and is passed to the editor
 144          *
 145          * @param taxonNodeUuid
 146          *            a {@link java.util.UUID} object.
 147          * @throws java.lang.Exception
 148          *             if any.
 149          */
 150         public static void openTaxonNode(UUID taxonNodeUuid) throws Exception {
 151                 TaxonEditorInput input = TaxonEditorInput.NewInstance(taxonNodeUuid);
 152                 open(input);
 153         }
 154
 155         /**
 156          * <p>
 157          * openTaxonBase
 158          * </p>
 159          *
 160          * @param taxonBaseUuid
 161          *            a {@link java.util.UUID} object.
 162          * @throws org.eclipse.ui.PartInitException
 163          *             if any.
 164          */
 165         public static void openTaxonBase(UUID taxonBaseUuid)
 166                         throws PartInitException {
 167             TaxonBase taxonBase = CdmStore.getService(ITaxonService.class).find(taxonBaseUuid);
 168         if (taxonBase != null && taxonBase.isOrphaned()) {
 169                 MessagingUtils.warningDialog("Orphaned Taxon", TaxonEditorInput.class, "This is an orphaned taxon i.e. a taxon that is not connected to a classification and not having any taxonomic relationships. Editing of orphaned taxon is currently not supported.");
 170                 return;
 171         }
 172                 TaxonEditorInput input = TaxonEditorInput
 173                                 .NewInstanceFromTaxonBase(taxonBaseUuid);
 174                 open(input);
 175         }
 176
 177         /**
 178          * <p>
 179          * findEditorByTaxonNodeUuid
 180          * </p>
 181          *
 182          * @param taxonNodeUuid
 183          *            a {@link java.util.UUID} object.
 184          * @return a {@link org.eclipse.ui.IEditorPart} object.
 185          * @throws java.lang.Exception
 186          *             if any.
 187          */
 188         public static IEditorPart findEditorByTaxonNodeUuid(UUID taxonNodeUuid)
 189                         throws Exception {
 190                 IEditorInput input = TaxonEditorInput.NewInstance(taxonNodeUuid);
 191                 return getActivePage().findEditor(input);
 192         }
 193
 194         /**
 195          * An uninitialized taxon is one that hasn't been saved yet. As such, it
 196          * should appear in neither the list of recent names nor in the taxonomic
 197          * tree when opened.
 198          *
 199          * @throws org.eclipse.ui.PartInitException
 200          *             if any.
 201          * @param parentNodeUuid
 202          *            a {@link java.util.UUID} object.
 203          */
 204         public static void openEmpty(UUID parentNodeUuid) throws PartInitException {
 205                 TaxonEditorInput input = TaxonEditorInput
 206                                 .NewEmptyInstance(parentNodeUuid);
 207                 open(input, MultiPageTaxonEditor.ID);
 208
 209                 getActiveMultiPageTaxonEditor().changed(null);
 210
 211         }
 212
 213         /**
 214          * <p>
 215          * setSaving
 216          * </p>
 217          *
 218          * @param isSaving
 219          *            a boolean.
 220          */
 221         public static void setSaving(boolean isSaving) {
 222                 EditorUtil.isSaving = isSaving;
 223         }
 224
 225         /**
 226          * <p>
 227          * isSaving
 228          * </p>
 229          *
 230          * @return a boolean.
 231          */
 232         public static boolean isSaving() {
 233                 return isSaving;
 234         }
 235
 236         /**
 237          * Returns a set of all currently open <code>MultiPageTaxonEditor</code>s.
 238          *
 239          * @return a {@link java.util.Set} object.
 240          */
 241         public static Set<IEditorPart> getOpenEditors() {
 242                 Set<IEditorPart> taxonEditors = new HashSet<IEditorPart>();
 243
 244                 if (getActivePage() != null) {
 245                         for (IEditorReference reference : getActivePage()
 246                                         .getEditorReferences()) {
 247                                 IEditorPart editor = reference.getEditor(false);
 248                                 if (editor instanceof MultiPageTaxonEditor) {
 249                                         taxonEditors.add(editor);
 250                                 }
 251                         }
 252                 }
 253
 254                 return taxonEditors;
 255         }
 256
 257         /**
 258          * Returns the currently active taxon editor
 259          *
 260          * @return the taxon editor that has focus
 261          */
 262         public static MultiPageTaxonEditor getActiveMultiPageTaxonEditor() {
 263                 IEditorPart editorPart = getActiveEditor();
 264                 if (editorPart != null && editorPart instanceof MultiPageTaxonEditor) {
 265                         MultiPageTaxonEditor editor = (MultiPageTaxonEditor) editorPart;
 266                         editor.getConversationHolder().bind();
 267                         return editor;
 268                 }
 269                 return null;
 270         }
 271
 272         /**
 273          * <p>
 274          * getActiveEditorPage
 275          * </p>
 276          *
 277          * @param page
 278          *            a {@link eu.etaxonomy.taxeditor.editor.Page} object.
 279          * @return a {@link org.eclipse.ui.IEditorPart} object.
 280          */
 281         public static IEditorPart getActiveEditorPage(Page page) {
 282                 MultiPageTaxonEditor editor = getActiveMultiPageTaxonEditor();
 283
 284                 return editor != null ? editor.getPage(page) : null;
 285         }
 286
 287         /**
 288          * Returns the selection of the currently active taxon editor
 289          *
 290          * @return a {@link org.eclipse.jface.viewers.ISelection} object.
 291          */
 292         public static ISelection getCurrentSelection() {
 293                 if (getActiveMultiPageTaxonEditor() == null) {
 294                         return null;
 295                 } else {
 296                         return getActiveMultiPageTaxonEditor().getSite()
 297                                         .getSelectionProvider().getSelection();
 298                 }
 299         }
 300
 301         /**
 302          * <p>
 303          * getUndoContext
 304          * </p>
 305          *
 306          * @param editor
 307          *            a {@link eu.etaxonomy.taxeditor.editor.MultiPageTaxonEditor}
 308          *            object.
 309          * @return a {@link org.eclipse.core.commands.operations.IUndoContext}
 310          *         object.
 311          */
 312         public static IUndoContext getUndoContext(MultiPageTaxonEditor editor) {
 313                 return editor.getUndoContext();
 314         }
 315
 316         /**
 317          * <p>
 318          * getUndoContext
 319          * </p>
 320          *
 321          * @return a {@link org.eclipse.core.commands.operations.IUndoContext}
 322          *         object.
 323          */
 324         public static IUndoContext getUndoContext() {
 325                 return IOperationHistory.GLOBAL_UNDO_CONTEXT;
 326         }
 327
 328         /**
 329          * <p>
 330          * forceUserSave
 331          * </p>
 332          *
 333          * @param editor
 334          *            a {@link org.eclipse.ui.IEditorPart} object.
 335          * @param shell
 336          *            a {@link org.eclipse.swt.widgets.Shell} object.
 337          * @return a boolean.
 338          */
 339         public static boolean forceUserSave(IEditorPart editor, Shell shell) {
 340                 if (editor.isDirty()) {
 341
 342                         boolean doSave = MessageDialog
 343                                         .openConfirm(shell, "Confirm save",
 344                                                         "Warning - this operation will save the editor. This will also save all other unsaved changes " +
 345                                                         "in your working editor to the database. Please 'Cancel' if you are not ready to do this.");
 346
 347                         if (!doSave) {
 348                                 return false;
 349                         }
 350
 351                         editor.doSave(AbstractUtility.getMonitor());
 352                 }
 353                 return true;
 354         }
 355
 356         /**
 357          * <p>
 358          * getSelection
 359          * </p>
 360          *
 361          * @param event
 362          *            a {@link org.eclipse.core.commands.ExecutionEvent} object.
 363          * @return a {@link org.eclipse.jface.viewers.IStructuredSelection} object.
 364          */
 365         public static IStructuredSelection getSelection(ExecutionEvent event) {
 366                 IEditorPart activeEditor = HandlerUtil.getActiveEditor(event);
 367
 368                 return (IStructuredSelection) activeEditor.getSite()
 369                                 .getSelectionProvider().getSelection();
 370         }
 371
 372         /**
 373          * <p>
 374          * getPluginId
 375          * </p>
 376          *
 377          * @return a {@link java.lang.String} object.
 378          */
 379         public static String getPluginId() {
 380                 return TaxeditorEditorPlugin.PLUGIN_ID;
 381         }
 382
 383         public static void openPolytomousKey(UUID polytomousKeyUuid)
 384                         throws Exception {
 385                 PolytomousKeyEditorInput input = PolytomousKeyEditorInput
 386                                 .NewInstance(polytomousKeyUuid);
 387                 open(input);
 388         }
 389
 390 //      public static void openPolytomousKeyEditor(UUID polytomousKeyUuid, String name)
 391 //              throws Exception {
 392 //          PolytomousKeyEditorInput input = new PolytomousKeyEditorInput(polytomousKeyUuid, name);
 393 //          open(input);
 394 //      }
 395
 396         public static void openCdmAuthorities(UUID groupUuid)
 397                         throws Exception {
 398                 CdmAuthorityEditorInput input = CdmAuthorityEditorInput.NewInstance(groupUuid);
 399                 open(input);
 400         }
 401
 402         /**
 403          * Iterates recursively over all originals having the given specimen as a derivate.
 404          * The first {@link DerivedUnit} with no more originals or the first {@link FieldUnit} is returned
 405          * @param specimen the start element for which the originals are iterated recursively
 406          * @return either a FieldUnit or a the topmost DerivedUnit (which can be itself)
 407          */
 408         public static SpecimenOrObservationBase<?> getTopMostDerivate(SpecimenOrObservationBase<?> specimen){
 409             if(specimen.isInstanceOf(FieldUnit.class)){
 410                 return specimen;
 411             }
 412             else if(specimen instanceof DerivedUnit
 413                     && ((DerivedUnit) specimen).getOriginals()!=null
 414                     && !((DerivedUnit) specimen).getOriginals().isEmpty()){
 415                 for(SpecimenOrObservationBase<?> original:((DerivedUnit) specimen).getOriginals()){
 416                     return getTopMostDerivate(original);
 417                 }
 418                 //needed to add this for compilation although this is unreachable
 419                 return specimen;
 420             }
 421             else{
 422                 return specimen;
 423             }
 424         }
 425
 426         /**
 427          * Iterates recursively over all originals having the given specimen as a derivate.
 428          * If a {@link FieldUnit} is found it is returned
 429          * @param specimen the start element for which the originals are iterated recursively
 430          * @return the FieldUnit if found, <code>null</code> otherwise
 431          */
 432     public static FieldUnit getFieldUnit(SpecimenOrObservationBase<?> specimen){
 433         SpecimenOrObservationBase<?> topMostDerivate = getTopMostDerivate(specimen);
 434         if(topMostDerivate instanceof FieldUnit) {
 435             return (FieldUnit) topMostDerivate;
 436         }
 437         return null;
 438     }
 439
 440     /**
 441      * If the current selection is a single {@link TreeNode} it will be returned.
 442      * @param selection the selection to check
 443      * @return the selected TreeNode or <code>null</code> if no TreeNode selected
 444      */
 445     public static TreeNode getTreeNodeOfSelection(ISelection selection){
 446         if(selection instanceof IStructuredSelection
 447                 && ((IStructuredSelection) selection).size()==1
 448                 && ((IStructuredSelection) selection).getFirstElement() instanceof TreeNode){
 449             return (TreeNode) ((IStructuredSelection) selection).getFirstElement();
 450
 451         }
 452         return null;
 453     }
 454
 455     /**
 456      * Opens a taxon editor for the given object if the given object is a valid input.
 457      * @param object the object for which the editor will be opened
 458      * @throws PartInitException
 459      */
 460     public static void openTaxonEditor(Object object) throws PartInitException {
 461         if(object instanceof TaxonBase<?>){
 462             openTaxonBase(((TaxonBase<?>) object).getUuid());
 463         }
 464     }
 465
 466     public static boolean closeObsoleteEditor(TaxonNode taxonNode, IWorkbenchPage activePage){
 467         boolean result = true;
 468         for (IEditorReference ref : activePage.getEditorReferences()) {
 469             try {
 470                 String treeIndex = ((ITreeNode)taxonNode).treeIndex();
 471
 472
 473                 IEditorInput input = ref.getEditorInput();
 474                 if (input instanceof TaxonEditorInput) {
 475                     TaxonNode node = ((TaxonEditorInput) input).getTaxonNode();
 476                     //if node is a child of taxonNode then close the editor
 477                     if( ((ITreeNode) node).treeIndex().startsWith(treeIndex)){
 478                     //if (taxonNode.equals(node)) {
 479                         result &= activePage.closeEditor(ref.getEditor(false), true);
 480
 481                     }
 482                 }
 483             } catch (PartInitException e) {
 484                 continue;
 485             }
 486         }
 487         return result;
 488     }
 489 }