taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/io/ExportHandler.java

   1 // $Id$
   2 /**
   3 * Copyright (C) 2007 EDIT
   4 * European Distributed Institute of Taxonomy
   5 * http://www.e-taxonomy.eu
   6 *
   7 * The contents of this file are subject to the Mozilla Public License Version 1.1
   8 * See LICENSE.TXT at the top of this package for the full license terms.
   9 */
  10
  11 package eu.etaxonomy.taxeditor.io;
  12
  13 import org.eclipse.core.runtime.Assert;
  14 import org.eclipse.core.runtime.IProgressMonitor;
  15 import org.eclipse.core.runtime.IStatus;
  16 import org.eclipse.core.runtime.Status;
  17 import org.eclipse.core.runtime.jobs.Job;
  18 import org.eclipse.swt.widgets.Display;
  19
  20 import eu.etaxonomy.cdm.api.application.CdmApplicationController;
  21 import eu.etaxonomy.cdm.api.conversation.IConversationEnabled;
  22 import eu.etaxonomy.cdm.io.common.CdmDefaultExport;
  23 import eu.etaxonomy.cdm.io.common.IExportConfigurator;
  24 import eu.etaxonomy.cdm.io.common.IIoConfigurator;
  25 import eu.etaxonomy.cdm.io.jaxb.JaxbExportConfigurator;
  26 import eu.etaxonomy.cdm.io.sdd.out.SDDExportConfigurator;
  27 import eu.etaxonomy.taxeditor.model.CdmProgressMonitorAdapter;
  28 import eu.etaxonomy.taxeditor.store.StoreUtil;
  29
  30 /**
  31  * <p>ExportHandler class.</p>
  32  *
  33  * @author n.hoffmann
  34  * @created Sep 11, 2009
  35  * @version 1.0
  36  */
  37 public class ExportHandler extends AbstractIOHandler<IExportConfigurator>{
  38
  39         /**
  40          *
  41          * @param applicationController
  42          */
  43         private ExportHandler(CdmApplicationController applicationController){
  44                 super(applicationController);
  45         }
  46
  47         /**
  48          * <p>NewInstance</p>
  49          *
  50          * @param applicationController a {@link eu.etaxonomy.cdm.api.application.CdmApplicationController} object.
  51          * @return a {@link eu.etaxonomy.taxeditor.io.ExportHandler} object.
  52          */
  53         public static ExportHandler NewInstance(CdmApplicationController applicationController){
  54                 return new ExportHandler(applicationController);
  55         }
  56
  57         /**
  58          * <p>createIOJob</p>
  59          *
  60          * @param configurator a {@link eu.etaxonomy.cdm.io.common.IExportConfigurator} object.
  61          * @return a {@link org.eclipse.core.runtime.jobs.Job} object.
  62          */
  63         protected Job createIOJob(final IExportConfigurator configurator){
  64
  65                 Assert.isNotNull(configurator, "Configuration may not be null");
  66
  67                 final Display display = Display.getCurrent();
  68
  69                 Job job = new Job("Export: " + configurator.getClass().getSimpleName()){
  70                         @Override
  71                         protected IStatus run(IProgressMonitor monitor) {
  72                                 monitor.beginTask("Exporting database. This will take some time.", 100);
  73                                 monitor.worked(10);
  74
  75                                 display.asyncExec(new Runnable() {
  76
  77                                         @Override
  78                                         public void run() {
  79                                                 // terminate any open transactions
  80                                                 IConversationEnabled activePart = (IConversationEnabled) StoreUtil.getActivePage().getActivePart();
  81                                                 activePart.getConversationHolder().commit(false);
  82                                         }
  83                                 });
  84
  85                                 monitor.worked(10);
  86
  87                                 CdmDefaultExport<IExportConfigurator> exporter = new CdmDefaultExport<IExportConfigurator>();
  88                                 configurator.setProgressMonitor(CdmProgressMonitorAdapter.CreateSubMonitor(monitor, 80));
  89                                 exporter.setCdmAppController(applicationController);
  90                                 monitor.worked(10);
  91
  92                                 try{
  93                                         exporter.invoke(configurator);
  94                                         monitor.worked(60);
  95                                 }catch(RuntimeException e){
  96                                         StoreUtil.errorDialog("Error exporting data", this, "An error occured while" +
  97                                                         "exporting to destination '" + configurator.getDestinationNameString() + "'.\n" +
  98                                                                         "Please check error log for details.", e);
  99                                 }
 100
 101                                 display.asyncExec(new Runnable() {
 102
 103                                         @Override
 104                                         public void run() {
 105                                                 // terminate any open transactions
 106                                                 IConversationEnabled activePart = (IConversationEnabled) StoreUtil.getActivePage().getActivePart();
 107                                                 // restarting transaction and committing it to trigger change listener
 108                                                 // TODO verify correct behaviour
 109                                                 activePart.getConversationHolder().startTransaction();
 110                                                 activePart.getConversationHolder().commit();
 111                                         }
 112                                 });
 113                                 monitor.worked(10);
 114
 115                                 return Status.OK_STATUS;
 116                         }
 117                 };
 118
 119                 return job;
 120         }
 121
 122         /**
 123          * @param jaxb
 124          * @return
 125          */
 126         private IIoConfigurator getConfigurator(TYPE type) {
 127                 Assert.isNotNull(type, "Type should not be null");
 128
 129                 switch (type){
 130                         case Jaxb:
 131                                 return JaxbExportConfigurator.NewInstance(null, null);
 132                         case Sdd:
 133                                 return SDDExportConfigurator.NewInstance(null, null, null);
 134                         default:
 135                                 StoreUtil.notImplementedMessage(this);
 136                                 throw new IllegalArgumentException("Export not supported yet");
 137                 }
 138         }
 139
 140         /**
 141          * <p>JaxbConfigurator</p>
 142          *
 143          * @return a {@link eu.etaxonomy.cdm.io.jaxb.JaxbExportConfigurator} object.
 144          */
 145         public final JaxbExportConfigurator JaxbConfigurator() { return (JaxbExportConfigurator) getConfigurator(TYPE.Jaxb);    }
 146
 147         /**
 148          * <p>SddConfigurator</p>
 149          *
 150          * @return a {@link eu.etaxonomy.cdm.io.sdd.out.SDDExportConfigurator} object.
 151          */
 152         public final SDDExportConfigurator SddConfigurator() { return (SDDExportConfigurator) getConfigurator(TYPE.Sdd); }
 153
 154 }