minor
[taxeditor.git] / eu.etaxonomy.taxeditor.store / src / main / java / eu / etaxonomy / taxeditor / model / AbstractUtility.java
old mode 100755 (executable)
new mode 100644 (file)
index 40c6aec..ee8102c
@@ -14,7 +14,6 @@ import java.io.File;
 import java.io.FileOutputStream;
 import java.io.OutputStreamWriter;
 import java.io.Writer;
-import java.lang.reflect.InvocationTargetException;
 import java.text.SimpleDateFormat;
 import java.util.ArrayList;
 import java.util.Calendar;
@@ -31,48 +30,35 @@ import java.util.zip.ZipOutputStream;
 import org.apache.commons.lang.StringUtils;
 import org.apache.log4j.Logger;
 import org.eclipse.core.commands.ExecutionException;
-import org.eclipse.core.commands.NotEnabledException;
-import org.eclipse.core.commands.NotHandledException;
-import org.eclipse.core.commands.common.NotDefinedException;
 import org.eclipse.core.commands.operations.AbstractOperation;
 import org.eclipse.core.commands.operations.IOperationHistory;
 import org.eclipse.core.runtime.IAdaptable;
+import org.eclipse.core.runtime.ICoreRunnable;
 import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.NullProgressMonitor;
 import org.eclipse.core.runtime.OperationCanceledException;
 import org.eclipse.core.runtime.Status;
 import org.eclipse.core.runtime.SubProgressMonitor;
-import org.eclipse.core.runtime.jobs.ISchedulingRule;
 import org.eclipse.core.runtime.jobs.Job;
+import org.eclipse.e4.ui.di.UISynchronize;
 import org.eclipse.e4.ui.model.application.ui.basic.MPart;
+import org.eclipse.e4.ui.workbench.modeling.EPartService;
 import org.eclipse.jface.action.IStatusLineManager;
-import org.eclipse.jface.operation.IRunnableWithProgress;
-import org.eclipse.jface.resource.ColorRegistry;
-import org.eclipse.jface.resource.FontRegistry;
 import org.eclipse.jface.viewers.IStructuredSelection;
 import org.eclipse.jface.viewers.SelectionChangedEvent;
 import org.eclipse.swt.graphics.Color;
 import org.eclipse.swt.graphics.Font;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Shell;
-import org.eclipse.ui.IViewPart;
-import org.eclipse.ui.IViewReference;
 import org.eclipse.ui.IWorkbench;
-import org.eclipse.ui.IWorkbenchPage;
-import org.eclipse.ui.IWorkbenchWindow;
-import org.eclipse.ui.PartInitException;
 import org.eclipse.ui.PlatformUI;
-import org.eclipse.ui.handlers.IHandlerService;
 import org.eclipse.ui.ide.undo.WorkspaceUndoUtil;
 import org.eclipse.ui.progress.IProgressConstants;
-import org.eclipse.ui.progress.IProgressService;
-import org.eclipse.ui.progress.IWorkbenchSiteProgressService;
-import org.eclipse.ui.themes.ITheme;
-import org.eclipse.ui.themes.IThemeManager;
 
 import eu.etaxonomy.cdm.api.application.CdmApplicationState;
 import eu.etaxonomy.cdm.api.service.IProgressMonitorService;
+import eu.etaxonomy.cdm.api.service.UpdateResult;
 import eu.etaxonomy.cdm.common.monitor.IRemotingProgressMonitor;
 import eu.etaxonomy.cdm.io.common.ExportDataWrapper;
 import eu.etaxonomy.cdm.io.common.ExportResult;
@@ -84,14 +70,12 @@ import eu.etaxonomy.taxeditor.operation.AbstractPostOperation;
 import eu.etaxonomy.taxeditor.operation.IFeedbackGenerator;
 import eu.etaxonomy.taxeditor.operation.IPostMoniteredOperationEnabled;
 import eu.etaxonomy.taxeditor.operation.IPostOperationEnabled;
-import eu.etaxonomy.taxeditor.operation.RemotingCdmHandler;
 import eu.etaxonomy.taxeditor.operation.e4.RemotingCdmHandlerE4;
 import eu.etaxonomy.taxeditor.store.CdmStore;
 import eu.etaxonomy.taxeditor.store.internal.TaxeditorStorePlugin;
 import eu.etaxonomy.taxeditor.ui.dialog.ReportTextDialog;
-import eu.etaxonomy.taxeditor.view.AbstractCdmDataViewer;
-import eu.etaxonomy.taxeditor.view.detail.DetailsViewPart;
-import eu.etaxonomy.taxeditor.view.supplementaldata.SupplementalDataViewPart;
+import eu.etaxonomy.taxeditor.view.e4.AbstractCdmDataViewerE4;
+import eu.etaxonomy.taxeditor.view.e4.details.DetailsPartE4;
 import eu.etaxonomy.taxeditor.workbench.part.IE4SavablePart;
 
 /**
@@ -102,7 +86,7 @@ import eu.etaxonomy.taxeditor.workbench.part.IE4SavablePart;
  */
 public abstract class AbstractUtility {
 
-    private static final Logger logger = Logger.getLogger(AbstractUtility.class);
+    protected static final Logger logger = Logger.getLogger(AbstractUtility.class);
 
     /** Constant <code>statusLineManager</code> */
     protected static IStatusLineManager statusLineManager;
@@ -117,116 +101,27 @@ public abstract class AbstractUtility {
         return null;
     }
 
-    public static boolean closeAll() {
-        if(getActivePage()!=null){
-            return getActivePage().closeAllEditors(true);
-        }
-        return false;
-    }
-
     public static Shell getShell() {
-
-        return TaxeditorStorePlugin.getDefault().getWorkbench()
-                .getActiveWorkbenchWindow().getShell();
-    }
-
-    public static IWorkbenchPage getActivePage() {
-        try{
-            return TaxeditorStorePlugin.getDefault().getWorkbench()
-                    .getActiveWorkbenchWindow().getActivePage();
-        } catch(NullPointerException npe){
-            return null;
-        }
+        return EventUtility.getShell();
     }
 
     public static IWorkbench getWorkbench() {
         return TaxeditorStorePlugin.getDefault().getWorkbench();
     }
 
-    public static IWorkbenchWindow getWorkbenchWindow() {
-        if (getWorkbench().getWorkbenchWindowCount() > 1) {
-            throw new IllegalStateException("More than one workbench window");
-        }
-        return getWorkbench().getWorkbenchWindows()[0];
-    }
-
-    public static IViewPart showView(String id) {
-        try {
-            return PlatformUI.getWorkbench().getActiveWorkbenchWindow()
-                    .getActivePage()
-                    .showView(id, null, IWorkbenchPage.VIEW_VISIBLE);
-        } catch (PartInitException e) {
-            MessagingUtils.messageDialog("Error opening view", AbstractUtility.class, "Could not open view: " + id, e);
-            return null;
-        }
-    }
-
-    public static void hideView(IViewPart view) {
-        PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage()
-        .hideView(view);
-    }
-
-    public static IViewPart getView(String id, boolean restore) {
-       IWorkbench workbench = PlatformUI.getWorkbench();
-        IWorkbenchWindow activeWorkbenchWindow = workbench.getActiveWorkbenchWindow();
-       IViewReference[] references = null;
-       if(activeWorkbenchWindow!=null && activeWorkbenchWindow.getActivePage()!=null){
-           references = activeWorkbenchWindow.getActivePage().getViewReferences();
-       }
-       else if(workbench.getWorkbenchWindows().length>0 && workbench.getWorkbenchWindows()[0].getActivePage()!=null){
-               references = workbench.getWorkbenchWindows()[0].getActivePage().getViewReferences();
-       }
-       if(references!=null){
-               for (IViewReference reference : references) {
-                       if (reference.getId().equals(id)) {
-                               return reference.getView(restore);
-                       }
-               }
-       }
-        return null;
-    }
-
     public static Object getService(Class api) {
         return TaxeditorStorePlugin.getDefault().getWorkbench().getService(api);
     }
 
-    public static ITheme getCurrentTheme() {
-        IThemeManager themeManager = TaxeditorStorePlugin.getDefault()
-                .getWorkbench().getThemeManager();
-        return themeManager.getCurrentTheme();
-    }
-
-    /**
-     * Fonts registered to the plugin may be obtained with the Eclipse themeing
-     * functionality. Thus fonts are chooseable by the user via
-     * Preferences->General->Appearance->Colors and Fonts
-     *
-     * @return the FontRegistry for the current theme
-     */
-    public static FontRegistry getFontRegistry() {
-        return getCurrentTheme().getFontRegistry();
-    }
-
     public static Font getFont(String symbolicName) {
-        return getFontRegistry().get(symbolicName);
-    }
-
-    /**
-     * Color registered to the plugin may be obtained with the Eclipse themeing
-     * functionality. Thus colors are editable by the user via
-     * Preferences->General->Appearance->Colors and Fonts
-     *
-     * @return the ColorRegistry for the current theme
-     */
-    public static ColorRegistry getColorRegistry() {
-        return getCurrentTheme().getColorRegistry();
+        return FontResources.getFont(symbolicName);
     }
 
     public static Color getColor(String symbolicName) {
-        return getColorRegistry().get(symbolicName);
+        return ColorResources.getColor(symbolicName);
     }
 
-    public static IStatus executeOperation(final AbstractPostOperation operation) {
+    public static IStatus executeOperation(final AbstractPostOperation operation, UISynchronize sync) {
         if (getOperationHistory() == null) {
             throw new IllegalArgumentException(
                     "There is no operation history for this context");
@@ -235,21 +130,17 @@ public abstract class AbstractUtility {
         final IAdaptable uiInfoAdapter = WorkspaceUndoUtil
                 .getUIInfoAdapter(getShell());
 
-        IRunnableWithProgress runnable = new IRunnableWithProgress() {
-
-            @Override
-            public void run(IProgressMonitor monitor)
-                    throws InvocationTargetException, InterruptedException {
+        Job job = Job.create(operation.getLabel(), (ICoreRunnable) monitor -> {
+            sync.syncExec(() -> {
                 String operationlabel = operation.getLabel();
                 monitor.beginTask(operationlabel, 100);
                 IStatus status = Status.CANCEL_STATUS;
                 try {
                     operation.addContext(IOperationHistory.GLOBAL_UNDO_CONTEXT);
-                    status = getOperationHistory().execute(operation, monitor,
-                            uiInfoAdapter);
+                    status = operation.execute(monitor, uiInfoAdapter);
                 } catch (ExecutionException e) {
 
-                    MessagingUtils.operationDialog(this, e, TaxeditorStorePlugin.PLUGIN_ID, operationlabel, null);
+                    MessagingUtils.operationDialog(AbstractUtility.class, e, TaxeditorStorePlugin.PLUGIN_ID, operationlabel, null);
 
                 } finally {
                     monitor.done();
@@ -258,33 +149,30 @@ public abstract class AbstractUtility {
                 String statusString = status.equals(Status.OK_STATUS) ? "completed"
                         : "cancelled";
                 setStatusLine(operationlabel + " " + statusString + ".");
-
-            }
-        };
+                IPostOperationEnabled postOperationEnabled = operation
+                        .getPostOperationEnabled();
+                if (postOperationEnabled != null) {
+                    postOperationEnabled.onComplete();
+                }
+            });
+        });
 
         try {
-            runInUI(runnable, null);
+            job.setUser(true);
+            job.schedule();
         } catch (Exception e) {
-            MessagingUtils.messageDialog("Error executing operation", AbstractUtility.class, "An error occured while executing " + operation.getLabel(), e);
+            MessagingUtils.messageDialog("Error executing operation", AbstractUtility.class, "An error occurred while executing " + operation.getLabel(), e);
         }
 
-        IPostOperationEnabled postOperationEnabled = operation
-                .getPostOperationEnabled();
-        if (postOperationEnabled != null) {
-            postOperationEnabled.onComplete();
-        }
         return Status.OK_STATUS;
     }
 
-    public static IStatus executeOperation(final AbstractOperation operation, final RemotingCdmHandlerE4 handler) {
-        return executeOperation_internal(operation, handler);
-    }
-
-    public static IStatus executeOperation(final AbstractOperation operation, final RemotingCdmHandler handler) {
-        return executeOperation_internal(operation, handler);
+    public static IStatus executeOperation(final AbstractOperation operation, final RemotingCdmHandlerE4 handler, UISynchronize sync) {
+        return executeOperation_internal(operation, handler, sync);
     }
 
-    private static IStatus executeOperation_internal(final AbstractOperation operation, final Object handler) {
+    private static IStatus executeOperation_internal(final AbstractOperation operation, final RemotingCdmHandlerE4 handler,
+            UISynchronize sync) {
         if (getOperationHistory() == null) {
             throw new IllegalArgumentException(
                     "There is no operation history for this context");
@@ -293,26 +181,19 @@ public abstract class AbstractUtility {
         final IAdaptable uiInfoAdapter = WorkspaceUndoUtil
                 .getUIInfoAdapter(getShell());
 
-        IRunnableWithProgress runnable = new IRunnableWithProgress() {
 
-            @Override
-            public void run(IProgressMonitor monitor)
-                    throws InvocationTargetException, InterruptedException {
+        Job job = Job.create(operation.getLabel(), (ICoreRunnable) monitor -> {
+            sync.syncExec(() -> {
                 String operationlabel = operation.getLabel();
                 monitor.beginTask(operationlabel, 100);
                 IStatus status = Status.CANCEL_STATUS;
                 try {
                     operation.addContext(IOperationHistory.GLOBAL_UNDO_CONTEXT);
-                    status = getOperationHistory().execute(operation, monitor,
+                    status = operation.execute(monitor,
                             uiInfoAdapter);
-                    if(handler instanceof RemotingCdmHandler) {
-                        ((RemotingCdmHandler) handler).postOperation(status);
-                    }
-                    else if(handler instanceof RemotingCdmHandlerE4) {
-                        ((RemotingCdmHandlerE4) handler).postOperation(status);
-                    }
+                    handler.postOperation(status);
                 } catch (ExecutionException e) {
-                    MessagingUtils.operationDialog(this, e, TaxeditorStorePlugin.PLUGIN_ID, operationlabel, null);
+                    MessagingUtils.operationDialog(AbstractUtility.class, e, TaxeditorStorePlugin.PLUGIN_ID, operationlabel, null);
                 } finally {
                     monitor.done();
                 }
@@ -320,14 +201,14 @@ public abstract class AbstractUtility {
                 String statusString = status.equals(Status.OK_STATUS) ? "completed"
                         : "cancelled";
                 setStatusLine(operationlabel + " " + statusString + ".");
-
-            }
-        };
+            });
+        });
 
         try {
-            runInUI(runnable, null);
+            job.setUser(true);
+            sync.syncExec(()->job.schedule());
         } catch (Exception e) {
-            MessagingUtils.messageDialog("Error executing operation", AbstractUtility.class, "An error occured while executing " + operation.getLabel(), e);
+            MessagingUtils.messageDialog("Error executing operation", AbstractUtility.class, "An error occurred while executing " + operation.getLabel(), e);
         }
 
         return Status.OK_STATUS;
@@ -356,10 +237,10 @@ public abstract class AbstractUtility {
             // get the remoting monitor the first time to make sure that the
             // operation is valid
             final IProgressMonitorService progressMonitorService = CdmApplicationState.getCurrentAppConfig().getProgressMonitorService();
-            final IRemotingProgressMonitor firstRemotingMonitor = progressMonitorService.getRemotingMonitor(uuid);
-            if(firstRemotingMonitor == null) {
-                throw new IllegalStateException("Remoting progress monitor is null");
-            }
+//            final IRemotingProgressMonitor firstRemotingMonitor = progressMonitorService.getRemotingMonitor(uuid);
+//            if(firstRemotingMonitor == null) {
+//                throw new IllegalStateException("Remoting progress monitor is null");
+//            }
 
             Job job = new Job(label) {
 
@@ -440,7 +321,7 @@ public abstract class AbstractUtility {
                                                ZipOutputStream zos = new ZipOutputStream(stream);
                                                for (String key: keySet){
                                                byte[] fileData = resultMap.get(key);
-                                               ZipEntry entry = new ZipEntry( key + fileEnding);
+                                               ZipEntry entry = new ZipEntry( key);
                                                                                zos.putNextEntry(entry);
                                                                                zos.write(fileData);
                                                                                zos.closeEntry();
@@ -484,7 +365,7 @@ public abstract class AbstractUtility {
         } catch (Exception e) {
             MessagingUtils.errorDialog("Error executing operation",
                     AbstractUtility.class,
-                    "An error occured while executing " + label,
+                    "An error occurred while executing " + label,
                     TaxeditorStorePlugin.PLUGIN_ID,
                     e,
                     true);
@@ -582,42 +463,6 @@ public abstract class AbstractUtility {
         newMonitor.worked(steps);
     }
 
-    /**
-     * Present a progress dialog to the user. This dialog will block the UI
-     *
-     * @param runnable
-     *            an implementation of {@link IRunnableWithProgress}
-     * @throws java.lang.InterruptedException
-     *             if any.
-     * @throws java.lang.reflect.InvocationTargetException
-     *             if any.
-     */
-    public static void busyCursorWhile(IRunnableWithProgress runnable)
-            throws InvocationTargetException, InterruptedException {
-        getProgressService().busyCursorWhile(runnable);
-    }
-
-    public static void runInUI(IRunnableWithProgress runnable,
-            ISchedulingRule rule) throws InvocationTargetException,
-            InterruptedException {
-        getProgressService().runInUI(getWorkbenchWindow(), runnable, rule);
-    }
-
-    public static void run(boolean fork, boolean cancelable,
-            IRunnableWithProgress runnable) throws InvocationTargetException,
-            InterruptedException {
-        getProgressService().run(fork, cancelable, runnable);
-    }
-
-    public static IProgressService getProgressService() {
-        IWorkbench workbench = PlatformUI.getWorkbench();
-        return workbench.getProgressService();
-    }
-
-    public static IWorkbenchSiteProgressService getProgressService2() {
-        return (IWorkbenchSiteProgressService) getService(IWorkbenchSiteProgressService.class);
-    }
-
     public static String getPluginId() {
         return "eu.taxeditor";
     }
@@ -631,31 +476,23 @@ public abstract class AbstractUtility {
         return null;
     }
 
-    public static DetailsViewPart getDetailsView() {
-        return (DetailsViewPart) getView(DetailsViewPart.ID, false);
-    }
-
-    public static void refreshDetailsViewer() {
-        if (getDetailsView() != null) {
-            ((AbstractCdmDataViewer) getDetailsView().getViewer()).refresh();
+    public static DetailsPartE4 getDetailsView(EPartService partService) {
+        MPart part = partService.findPart("eu.etaxonomy.taxeditor.view.e4.details.DetailsPartE4");
+        if(part!=null){
+            return (DetailsPartE4) part.getObject();
         }
+        return null;
     }
 
-    public static void reflowDetailsViewer() {
-        if (getDetailsView() != null) {
-            ((AbstractCdmDataViewer) getDetailsView().getViewer()).reflow();
+    public static void refreshDetailsViewer(EPartService partService) {
+        if (getDetailsView(partService) != null) {
+            ((AbstractCdmDataViewerE4) getDetailsView(partService).getViewer()).refresh();
         }
     }
 
-    public static SupplementalDataViewPart getSupplementalDataView() {
-        return (SupplementalDataViewPart) getView(SupplementalDataViewPart.ID,
-                false);
-    }
-
-    public static void reflowSupplementalViewer() {
-        if (getSupplementalDataView() != null) {
-            ((AbstractCdmDataViewer) getSupplementalDataView().getViewer())
-            .reflow();
+    public static void reflowDetailsViewer(EPartService partService) {
+        if (getDetailsView(partService) != null) {
+            ((AbstractCdmDataViewerE4) getDetailsView(partService).getViewer()).reflow();
         }
     }
 
@@ -808,37 +645,15 @@ public abstract class AbstractUtility {
         }
     }
 
-
-    public static void executeCommand(String commandId, Object source, String pluginId) {
-        IHandlerService handlerService = (IHandlerService) AbstractUtility.getService(IHandlerService.class);
-        Exception exception = null;
-        try {
-            handlerService.executeCommand(commandId, null);
-        } catch (ExecutionException e) {
-            exception = e;
-        } catch (NotDefinedException e) {
-            exception = e;
-        } catch (NotEnabledException e) {
-            exception = e;
-        } catch (NotHandledException e) {
-            exception = e;
-        } finally {
-            if(exception != null) {
-                MessagingUtils.errorDialog("Error executing command",
-                        source,
-                        "Could not execute command with id " + commandId ,
-                        pluginId,
-                        exception,
-                        true);
-            }
-        }
-    }
-
     public static Object getElementsFromSelectionChangedEvent(SelectionChangedEvent event) {
         IStructuredSelection selection = (IStructuredSelection) event.getSelection();
         Object selectionToSet = selection;
         if(selection.size() == 1){
             selectionToSet = selection.getFirstElement();
+            if (selectionToSet instanceof Object[]){
+                Object[] selectionArray = (Object[])selectionToSet;
+                selectionToSet = selectionArray;
+            }
         }
         else if(!selection.isEmpty()){
             selectionToSet = selection.toArray();
@@ -893,7 +708,11 @@ public abstract class AbstractUtility {
                     final StringBuilder reportSb = new StringBuilder();
                     // collect reports
 //                         for(String report : remotingMonitor.getResult()) {
+                    if (remotingMonitor.getResult() instanceof ExportResult) {
                         reportSb.append(((ExportResult)remotingMonitor.getResult()).createReport());
+                    }else if (remotingMonitor.getResult() instanceof UpdateResult){
+                        reportSb.append(((UpdateResult)remotingMonitor.getResult()).getExceptions().toString());
+                    }
 //                         }
                     if(!StringUtils.isBlank(reportSb.toString())) {
                         Display.getDefault().asyncExec(new Runnable() {
@@ -925,7 +744,7 @@ public abstract class AbstractUtility {
         } catch (Exception e) {
             MessagingUtils.errorDialog("Error executing operation",
                     AbstractUtility.class,
-                    "An error occured while executing " + label,
+                    "An error occurred while executing " + label,
                     TaxeditorStorePlugin.PLUGIN_ID,
                     e,
                     true);