ref #9541 new referencing objects implementation in TaxEditor
[taxeditor.git] / eu.etaxonomy.taxeditor.store / src / main / java / eu / etaxonomy / taxeditor / model / AbstractUtility.java
index abb9bf1ad7d2b49644d04a7d4992340f24f2f168..d88e763131b749ab982c4021ff1f276f8f59e715 100644 (file)
@@ -6,7 +6,6 @@
  * The contents of this file are subject to the Mozilla Public License Version 1.1
  * See LICENSE.TXT at the top of this package for the full license terms.
  */
-
 package eu.etaxonomy.taxeditor.model;
 
 import java.io.BufferedWriter;
@@ -18,6 +17,7 @@ import java.text.SimpleDateFormat;
 import java.util.ArrayList;
 import java.util.Calendar;
 import java.util.Collection;
+import java.util.HashSet;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
@@ -27,7 +27,7 @@ import java.util.UUID;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipOutputStream;
 
-import org.apache.commons.lang.StringUtils;
+import org.apache.commons.lang3.StringUtils;
 import org.apache.log4j.Logger;
 import org.eclipse.core.commands.ExecutionException;
 import org.eclipse.core.commands.operations.AbstractOperation;
@@ -39,6 +39,7 @@ 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.SubMonitor;
 import org.eclipse.core.runtime.SubProgressMonitor;
 import org.eclipse.core.runtime.jobs.Job;
 import org.eclipse.e4.ui.di.UISynchronize;
@@ -60,18 +61,23 @@ 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.hibernate.HibernateProxyHelper;
 import eu.etaxonomy.cdm.io.common.ExportDataWrapper;
 import eu.etaxonomy.cdm.io.common.ExportResult;
 import eu.etaxonomy.cdm.io.common.ExportResultType;
 import eu.etaxonomy.cdm.io.common.ExportType;
-import eu.etaxonomy.cdm.model.common.IEnumTerm;
+import eu.etaxonomy.cdm.model.common.CdmBase;
+import eu.etaxonomy.cdm.model.taxon.Synonym;
+import eu.etaxonomy.cdm.model.taxon.Taxon;
+import eu.etaxonomy.cdm.model.taxon.TaxonNode;
+import eu.etaxonomy.cdm.model.term.IEnumTerm;
 import eu.etaxonomy.taxeditor.event.EventUtility;
+import eu.etaxonomy.taxeditor.event.WorkbenchEventConstants;
 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.operation.e4.CdmHandlerE4;
 import eu.etaxonomy.taxeditor.store.CdmStore;
 import eu.etaxonomy.taxeditor.store.internal.TaxeditorStorePlugin;
 import eu.etaxonomy.taxeditor.ui.dialog.ReportTextDialog;
@@ -80,14 +86,12 @@ import eu.etaxonomy.taxeditor.view.e4.details.DetailsPartE4;
 import eu.etaxonomy.taxeditor.workbench.part.IE4SavablePart;
 
 /**
- *
  * @author n.hoffmann
  * @created 11.05.2009
- * @version 1.0
  */
 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;
@@ -110,6 +114,7 @@ public abstract class AbstractUtility {
         return TaxeditorStorePlugin.getDefault().getWorkbench();
     }
 
+    @SuppressWarnings("unchecked")
     public static Object getService(Class api) {
         return TaxeditorStorePlugin.getDefault().getWorkbench().getService(api);
     }
@@ -162,21 +167,17 @@ public abstract class AbstractUtility {
             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);
         }
 
         return Status.OK_STATUS;
     }
 
-    public static IStatus executeOperation(final AbstractOperation operation, final RemotingCdmHandlerE4 handler, UISynchronize sync) {
+    public static IStatus executeOperation(final AbstractOperation operation, final CdmHandlerE4 handler, UISynchronize sync) {
         return executeOperation_internal(operation, handler, sync);
     }
 
-    public static IStatus executeOperation(final AbstractOperation operation, final RemotingCdmHandler 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 CdmHandlerE4 handler,
             UISynchronize sync) {
         if (getOperationHistory() == null) {
             throw new IllegalArgumentException(
@@ -196,12 +197,7 @@ public abstract class AbstractUtility {
                     operation.addContext(IOperationHistory.GLOBAL_UNDO_CONTEXT);
                     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(AbstractUtility.class, e, TaxeditorStorePlugin.PLUGIN_ID, operationlabel, null);
                 } finally {
@@ -218,7 +214,7 @@ public abstract class AbstractUtility {
             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;
@@ -251,6 +247,9 @@ public abstract class AbstractUtility {
             if(firstRemotingMonitor == null) {
                 throw new IllegalStateException("Remoting progress monitor is null");
             }
+            if (firstRemotingMonitor.isDone()){
+                createExportResult(label, urlString, createZip, firstRemotingMonitor);
+            }
 
             Job job = new Job(label) {
 
@@ -258,7 +257,8 @@ public abstract class AbstractUtility {
                 @Override
                 public IStatus run(IProgressMonitor monitor) {
                     // run the monitor until the operation is finished
-                       monitor.beginTask("Start", 100);
+                    SubMonitor subMonitor = SubMonitor.convert(monitor, 100);
+                    //subMonitor.beginTask("Start", 100);
                     IRemotingProgressMonitor remotingMonitor;
                     try {
                         remotingMonitor = CdmStore.getProgressMonitorClientManager().pollMonitor(label,
@@ -266,100 +266,17 @@ public abstract class AbstractUtility {
                                 pollInterval,
                                 postOp,
                                 feedbackGenerator,
-                                monitor);
+                                subMonitor);
                     } catch (Exception ex) {
-                        return new Status(Status.ERROR, TaxeditorStorePlugin.PLUGIN_ID, "Operation Interrupted", ex);
-                    }
-                    final StringBuilder reportSb = new StringBuilder();
-                    if (remotingMonitor.getResult() instanceof ExportResult){
-                       ExportResult result = (ExportResult)remotingMonitor.getResult();
-
-                           reportSb.append(result.createReport());
-
-                           if(!StringUtils.isBlank(reportSb.toString())) {
-                               Display.getDefault().asyncExec(new Runnable() {
-                                   @Override
-                                   public void run() {
-                                       // display reports with possibility to save
-                                       ReportTextDialog dialog = new ReportTextDialog(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell());
-                                       dialog.setTitle(label + " Report");
-                                       dialog.setReportText(reportSb.toString());
-                                       dialog.open();
-                                   }
-                               });
-                           }
-
-                           if (urlString != null){
-                                ExportDataWrapper data = result.getExportData();
-                                try{
-                                    if (result.getExportData().getType().equals(ExportResultType.BYTE_ARRAY)){
-                                        byte[] exportData = (byte[])data.getExportData();
-                                        if(exportData != null){
-                                            File file = new File(urlString);
-                                            FileOutputStream stream = new FileOutputStream(file);
-                                            Writer out = new BufferedWriter(new OutputStreamWriter(
-                                                               stream, "UTF8"));
-
-                                               stream.write(exportData);
-                                           out.flush();
-                                           stream.close();
-                                        }
-                                    } else if (result.getExportData().getType().equals(ExportResultType.MAP_BYTE_ARRAY)){
-                                        Map<String, byte[]> resultMap = (Map<String, byte[]>)data.getExportData();
-                                        Set<String> keySet = resultMap.keySet();
-                                        SimpleDateFormat sdf = new SimpleDateFormat(DATE_FORMAT_NOW);
-                                        Calendar cal = Calendar.getInstance();
-                                        String fileEnding = ".csv";
-
-                                        if (createZip){
-                                                File file = new File(urlString+File.separator +  sdf.format(cal.getTime())+ ".zip");
-                                            FileOutputStream stream = new FileOutputStream(file);
-                                            ZipOutputStream zos = new ZipOutputStream(stream);
-                                            for (String key: keySet){
-                                               byte[] fileData = resultMap.get(key);
-                                               ZipEntry entry = new ZipEntry( key + fileEnding);
-                                                                               zos.putNextEntry(entry);
-                                                                               zos.write(fileData);
-                                                                               zos.closeEntry();
-                                            }
-                                            zos.close();
-                                        }else{
-                                               if(result.getExportType().equals(ExportType.DWCA)){
-
-                                               File file = new File(urlString);
-                                               FileOutputStream stream = new FileOutputStream(file);
-                                               ZipOutputStream zos = new ZipOutputStream(stream);
-                                               for (String key: keySet){
-                                               byte[] fileData = resultMap.get(key);
-                                               ZipEntry entry = new ZipEntry( key + fileEnding);
-                                                                               zos.putNextEntry(entry);
-                                                                               zos.write(fileData);
-                                                                               zos.closeEntry();
-                                                }
-                                                zos.close();
-                                             }else{
-                                                        for (String key: keySet){
-                                                                byte[] fileData = resultMap.get(key);
-                                                                File file = new File(urlString+File.separator + key + fileEnding);
-                                                        FileOutputStream stream = new FileOutputStream(file);
-                                                        Writer out = new BufferedWriter(new OutputStreamWriter(
-                                                                       stream, "UTF8"));
-                                                        stream.write(fileData);
-                                                        stream.close();
-                                                    }
-                                             }
-                                        }
-                                   }else{
-                                        logger.error("This kind of result data is not supported yet." + result.getExportData().getType().toString());
-                                    }
-                                } catch(Exception e){
-                                    logger.error(e.getStackTrace());
-                                }
-                           }
+                        return new Status(IStatus.ERROR, TaxeditorStorePlugin.PLUGIN_ID, "Operation Interrupted", ex);
                     }
+
+                    createExportResult(label, urlString, createZip, remotingMonitor);
                     return Status.OK_STATUS;
                 }
 
+
+
                 @Override
                 protected void canceling() {
                     CdmStore.getCurrentApplicationConfiguration().getProgressMonitorService().cancel(uuid);
@@ -369,13 +286,14 @@ public abstract class AbstractUtility {
             // configure the job
             job.setProperty(IProgressConstants.KEEP_PROPERTY, true);
             job.setUser(true);
+            job.setName(label);
             // schedule job
             job.schedule();
 
         } 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);
@@ -539,7 +457,7 @@ public abstract class AbstractUtility {
             if(depth>0){
                 indentString += "- ";
             }
-            result.put(node.term, indentString + node.term.getMessage());
+            result.put(node.term, indentString + node.term.getLabel());
             parseTermTree(node.children, result, depth);
         }
     }
@@ -651,7 +569,7 @@ public abstract class AbstractUtility {
 
         @Override
         public int compareTo(TermNode<T> that) {
-            return this.term.getMessage().compareTo(that.term.getMessage());
+            return this.term.getLabel().compareTo(that.term.getLabel());
         }
     }
 
@@ -682,7 +600,9 @@ public abstract class AbstractUtility {
             final int pollInterval,
             final boolean cancelable,
             final IPostMoniteredOperationEnabled postOp,
-            final IFeedbackGenerator feedbackGenerator) {
+            final IFeedbackGenerator feedbackGenerator,
+            final boolean showResult,
+            final boolean updateNavigator) {
 
        try{
                // get the remoting monitor the first time to make sure that the
@@ -692,14 +612,20 @@ public abstract class AbstractUtility {
             if(firstRemotingMonitor == null) {
                 throw new IllegalStateException("Remoting progress monitor is null");
             }
+            if (firstRemotingMonitor.isDone()){
+                createResult(label, showResult, firstRemotingMonitor);
+                Set<Taxon> taxaToUpdate = getTaxaToUpdate(firstRemotingMonitor);
+                updateNameEditors(taxaToUpdate);
+                return Status.OK_STATUS;
+            }
 
             Job job = new Job(label) {
-
-
                 @Override
                 public IStatus run(IProgressMonitor monitor) {
                     // run the monitor until the operation is finished
-                       monitor.beginTask("Start", 100);
+                    SubMonitor subMonitor = SubMonitor.convert(monitor, 100);
+
+
                     IRemotingProgressMonitor remotingMonitor;
                     try {
                         remotingMonitor = CdmStore.getProgressMonitorClientManager().pollMonitor(label,
@@ -707,34 +633,26 @@ public abstract class AbstractUtility {
                                 pollInterval,
                                 postOp,
                                 feedbackGenerator,
-                                monitor);
+                                subMonitor);
                     } catch (Exception ex) {
-                        return new Status(Status.ERROR, TaxeditorStorePlugin.PLUGIN_ID, "Operation Interrupted", ex);
+                        return new Status(IStatus.ERROR, TaxeditorStorePlugin.PLUGIN_ID, "Operation Interrupted", ex);
                     }
-                    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() {
-                            @Override
-                            public void run() {
-                                // display reports with possibility to save
-                                ReportTextDialog dialog = new ReportTextDialog(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell());
-                                dialog.setTitle(label + " Report");
-                                dialog.setReportText(reportSb.toString());
-                                dialog.open();
-                            }
-                        });
+                    createResult(label, showResult, remotingMonitor);
+                    Set<Taxon> taxaToUpdate = getTaxaToUpdate(remotingMonitor);
+                    updateNameEditors(taxaToUpdate);
+                    if (!taxaToUpdate.isEmpty() && updateNavigator){
+                        refreshNavigator();
                     }
                     return Status.OK_STATUS;
                 }
 
+                private void refreshNavigator() {
+                    EventUtility.postEvent(WorkbenchEventConstants.REFRESH_NAVIGATOR, true);
+                }
+
                 @Override
                 protected void canceling() {
                     CdmStore.getCurrentApplicationConfiguration().getProgressMonitorService().cancel(uuid);
@@ -743,6 +661,7 @@ public abstract class AbstractUtility {
 
             // configure the job
             job.setProperty(IProgressConstants.KEEP_PROPERTY, true);
+
             job.setUser(true);
             // schedule job
             job.schedule();
@@ -750,13 +669,169 @@ 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);
         }
 
         return Status.OK_STATUS;
+    }
+
+    private static Set<Taxon> getTaxaToUpdate(IRemotingProgressMonitor remotingMonitor) {
+        Set<Taxon> taxaToUpdate = new HashSet<>();
+        if (remotingMonitor.getResult() instanceof UpdateResult){
+            for (CdmBase object: ((UpdateResult)remotingMonitor.getResult()).getUpdatedObjects()){
+                Taxon taxon = null;
+
+                if (object instanceof Taxon){
+                    taxon = HibernateProxyHelper.deproxy(object, Taxon.class);
+                }else if (object instanceof Synonym){
+                    Synonym syn = HibernateProxyHelper.deproxy(object, Synonym.class);
+                    taxon = syn.getAcceptedTaxon();
+                }else if (object instanceof TaxonNode){
+                    taxon = ((TaxonNode)object).getTaxon() != null? ((TaxonNode)object).getTaxon():null;
+                }
+                if (taxon != null){
+                    taxaToUpdate.add(taxon);
+                }
+            }
+        }
+        return taxaToUpdate;
+    }
+    public static void createResult(String label, boolean showResult,
+            IRemotingProgressMonitor remotingMonitor) {
+        final StringBuilder reportSb = new StringBuilder();
+        if (remotingMonitor.getResult() instanceof ExportResult) {
+            reportSb.append(((ExportResult)remotingMonitor.getResult()).createReport());
+        }else if (remotingMonitor.getResult() instanceof UpdateResult){
+            if (((UpdateResult)remotingMonitor.getResult()).isOk()){
+                int count = ((UpdateResult)remotingMonitor.getResult()).getUpdatedObjects().size();
+                if (count == 0){
+                    count = ((UpdateResult)remotingMonitor.getResult()).getUpdatedCdmIds().size();
+                }
+
+                reportSb.append("Update successful. \n"+"Updated Objects: " +count);
+            }
+            if (!((UpdateResult)remotingMonitor.getResult()).getExceptions().isEmpty()){
+                reportSb.append(((UpdateResult)remotingMonitor.getResult()).getExceptions().toString());
+            }
+        }else if (remotingMonitor.getReports()!= null){
+            for (String o:remotingMonitor.getReports()){
+                reportSb.append(o);
+            }
+        }
+        if(showResult && !StringUtils.isBlank(reportSb.toString()) && reportSb.length() != 0) {
+            Display.getDefault().asyncExec(new Runnable() {
+                @Override
+                public void run() {
+                    // display reports with possibility to save
+                    ReportTextDialog dialog = new ReportTextDialog(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell());
+                    dialog.setTitle(label + " Report");
+                    dialog.setReportText(reportSb.toString());
+                    dialog.open();
+                }
+            });
         }
+    }
+
+    private static void createExportResult(final String label, String urlString, boolean createZip,
+            IRemotingProgressMonitor remotingMonitor) {
+
+        final StringBuilder reportSb = new StringBuilder();
+        if (remotingMonitor.getResult() instanceof ExportResult){
+            ExportResult result = (ExportResult)remotingMonitor.getResult();
+
+            reportSb.append(result.createReport());
+
+            if(!StringUtils.isBlank(reportSb.toString())) {
+                Display.getDefault().asyncExec(new Runnable() {
+                    @Override
+                    public void run() {
+                        // display reports with possibility to save
+                        ReportTextDialog dialog = new ReportTextDialog(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell());
+                        dialog.setTitle(label + " Report");
+                        dialog.setReportText(reportSb.toString());
+                        dialog.open();
+                    }
+                });
+            }
 
-}
+            if (urlString != null){
+                 ExportDataWrapper<?> data = result.getExportData();
+                 try{
+                     if (result.getExportData().getType().equals(ExportResultType.BYTE_ARRAY)){
+                         byte[] exportData = (byte[])data.getExportData();
+                         if(exportData != null){
+                             File file = new File(urlString);
+                             FileOutputStream stream = new FileOutputStream(file);
+                             Writer out = new BufferedWriter(new OutputStreamWriter(
+                                    stream, "UTF8"));
+
+                            stream.write(exportData);
+                            out.flush();
+                            stream.close();
+                         }
+                     } else if (result.getExportData().getType().equals(ExportResultType.MAP_BYTE_ARRAY)){
+                         Map<String, byte[]> resultMap = (Map<String, byte[]>)data.getExportData();
+                         Set<String> keySet = resultMap.keySet();
+                         SimpleDateFormat sdf = new SimpleDateFormat(DATE_FORMAT_NOW);
+                         Calendar cal = Calendar.getInstance();
+                         String fileEnding = ".csv";
+
+                         if (createZip){
+//                             File file = new File(urlString+File.separator +  sdf.format(cal.getTime())+ ".zip");
+                             File file = new File(urlString+ ".zip");
+                             FileOutputStream stream = new FileOutputStream(file);
+                             ZipOutputStream zos = new ZipOutputStream(stream);
+                             for (String key: keySet){
+                                byte[] fileData = resultMap.get(key);
+                                ZipEntry entry = new ZipEntry( key + fileEnding);
+                                zos.putNextEntry(entry);
+                                zos.write(fileData);
+                                zos.closeEntry();
+                             }
+                             zos.close();
+                         }else{
+                            if(result.getExportType().equals(ExportType.DWCA)){
+
+                                File file = new File(urlString);
+                                FileOutputStream stream = new FileOutputStream(file);
+                                ZipOutputStream zos = new ZipOutputStream(stream);
+                                for (String key: keySet){
+                                    byte[] fileData = resultMap.get(key);
+                                    ZipEntry entry = new ZipEntry( key);
+                                        zos.putNextEntry(entry);
+                                        zos.write(fileData);
+                                        zos.closeEntry();
+                                 }
+                                 zos.close();
+                              }else{
+                                 for (String key: keySet){
+                                     byte[] fileData = resultMap.get(key);
+                                     File file = new File(urlString+File.separator + key + fileEnding);
+                                     FileOutputStream stream = new FileOutputStream(file);
+                                     Writer out = new BufferedWriter(new OutputStreamWriter(
+                                            stream, "UTF8"));
+                                     stream.write(fileData);
+                                     stream.close();
+                                 }
+                              }
+                         }
+                    }else{
+                         logger.error("This kind of result data is not supported yet." + result.getExportData().getType().toString());
+                     }
+                 } catch(Exception e){
+                     logger.error(e.getStackTrace());
+                 }
+            }
+        }
+    }
+    public static void updateNameEditors(Set<Taxon> taxaToUpdate){
+        for (Taxon tax: taxaToUpdate){
+            if (tax != null){
+                EventUtility.postEvent(WorkbenchEventConstants.REFRESH_NAME_EDITOR, tax.getUuid());
+            }
+        }
+    }
+}
\ No newline at end of file