3 * Copyright (C) 2007 EDIT
4 * European Distributed Institute of Taxonomy
5 * http://www.e-taxonomy.eu
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.
11 package eu
.etaxonomy
.taxeditor
.io
;
14 import java
.io
.InputStream
;
15 import java
.nio
.file
.Files
;
16 import java
.nio
.file
.Path
;
17 import java
.nio
.file
.Paths
;
18 import java
.util
.List
;
19 import java
.util
.UUID
;
21 import org
.apache
.commons
.io
.IOUtils
;
22 import org
.eclipse
.core
.runtime
.Assert
;
23 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
24 import org
.eclipse
.core
.runtime
.IStatus
;
25 import org
.eclipse
.core
.runtime
.Status
;
26 import org
.eclipse
.core
.runtime
.jobs
.Job
;
27 import org
.eclipse
.swt
.widgets
.Display
;
28 import org
.eclipse
.ui
.PlatformUI
;
30 import eu
.etaxonomy
.cdm
.api
.application
.CdmApplicationState
;
31 import eu
.etaxonomy
.cdm
.api
.application
.ICdmApplicationConfiguration
;
32 import eu
.etaxonomy
.cdm
.common
.monitor
.IRemotingProgressMonitor
;
33 import eu
.etaxonomy
.cdm
.io
.common
.CdmDefaultImport
;
34 import eu
.etaxonomy
.cdm
.io
.common
.IImportConfigurator
;
35 import eu
.etaxonomy
.cdm
.io
.common
.IImportConfigurator
.SOURCE_TYPE
;
36 import eu
.etaxonomy
.cdm
.io
.common
.ImportResult
;
37 import eu
.etaxonomy
.cdm
.io
.excel
.taxa
.NormalExplicitImportConfigurator
;
38 import eu
.etaxonomy
.cdm
.io
.jaxb
.JaxbImportConfigurator
;
39 import eu
.etaxonomy
.cdm
.io
.reference
.endnote
.in
.EndnoteImportConfigurator
;
40 import eu
.etaxonomy
.cdm
.io
.sdd
.in
.SDDImportConfigurator
;
41 import eu
.etaxonomy
.cdm
.io
.service
.IIOService
;
42 import eu
.etaxonomy
.cdm
.io
.specimen
.abcd206
.in
.Abcd206ImportConfigurator
;
43 import eu
.etaxonomy
.cdm
.io
.specimen
.excel
.in
.SpecimenCdmExcelImportConfigurator
;
44 import eu
.etaxonomy
.cdm
.io
.tcsxml
.in
.TcsXmlImportConfigurator
;
45 import eu
.etaxonomy
.taxeditor
.model
.AbstractUtility
;
46 import eu
.etaxonomy
.taxeditor
.model
.CdmProgressMonitorAdapter
;
47 import eu
.etaxonomy
.taxeditor
.model
.MessagingUtils
;
48 import eu
.etaxonomy
.taxeditor
.operation
.IPostMoniteredOperationEnabled
;
49 import eu
.etaxonomy
.taxeditor
.store
.CdmStore
;
50 import eu
.etaxonomy
.taxeditor
.store
.internal
.TaxeditorStorePlugin
;
51 import eu
.etaxonomy
.taxeditor
.ui
.dialog
.ReportTextDialog
;
55 * ImportHandler class.
59 * @created Sep 11, 2009
62 public class ImportManager
extends AbstractIOManager
<IImportConfigurator
> implements IPostMoniteredOperationEnabled
{
65 * @param applicationConfiguration
67 private ImportManager(ICdmApplicationConfiguration applicationConfiguration
) {
68 super(applicationConfiguration
);
76 * @param applicationConfiguration
78 * {@link eu.etaxonomy.cdm.api.application.CdmApplicationController}
80 * @return a {@link eu.etaxonomy.taxeditor.io.ImportManager} object.
82 public static ImportManager
NewInstance(
83 ICdmApplicationConfiguration applicationConfiguration
) {
84 return new ImportManager(applicationConfiguration
);
88 * Use when importing data into the current application context
91 * a {@link eu.etaxonomy.cdm.io.common.IImportConfigurator}
93 * @return a {@link org.eclipse.core.runtime.jobs.Job} object.
96 protected Job
createIOJob(final IImportConfigurator configurator
) {
97 Assert
.isNotNull(configurator
, "Configuration may not be null");
99 final Display display
= Display
.getDefault();
101 Job job
= new Job("Import: " + configurator
.getClass().getSimpleName()) {
104 protected IStatus
run(IProgressMonitor monitor
) {
105 monitor
.beginTask("Importing data", 100);
106 configurator
.setProgressMonitor(CdmProgressMonitorAdapter
107 .CreateSubMonitor(monitor
, 70));
111 CdmDefaultImport
<IImportConfigurator
> importer
= new CdmDefaultImport
<IImportConfigurator
>();
112 importer
.setCdmAppController(applicationConfiguration
);
114 ImportResult importResult
= null;
116 importResult
= importer
.invoke(configurator
);
119 } catch (RuntimeException e
) {
120 MessagingUtils
.messageDialog(
121 "Error importing data",
123 "An error occured while"
124 + "importing from source '"
125 + configurator
.getSourceNameString()
127 + "Please check error log for details.", e
);
134 final StringBuilder reportText
= new StringBuilder();
135 if(importResult
!=null){
136 List
<byte[]> reports
= importResult
.getReports();
137 for (byte[] bs
: reports
) {
138 reportText
.append(new String(bs
));
141 display
.asyncExec(new Runnable() {
145 // display reports with possibility to save
146 ReportTextDialog dialog
= new ReportTextDialog(PlatformUI
.getWorkbench().getActiveWorkbenchWindow().getShell());
147 dialog
.setTitle(configurator
.getClass().getSimpleName()+" Report");
148 dialog
.setReportText(reportText
.toString());
150 CdmStore
.getContextManager().notifyContextRefresh();
154 return Status
.OK_STATUS
;
162 public Job
createIOServiceJob(IImportConfigurator configurator
, InputStream is
, SOURCE_TYPE type
) {
165 return createIOServiceJob(configurator
, IOUtils
.toByteArray(is
), type
);
166 } catch (Exception e
) {
167 MessagingUtils
.errorDialog("Error importing input stream",
170 TaxeditorStorePlugin
.PLUGIN_ID
,
177 public Job
createIOServiceJob(IImportConfigurator configurator
, File importFile
, SOURCE_TYPE type
) {
178 Path path
= Paths
.get(importFile
.toURI());
180 return createIOServiceJob(configurator
, Files
.readAllBytes(path
), type
);
181 } catch (Exception e
) {
182 MessagingUtils
.errorDialog("Error importing file",
185 TaxeditorStorePlugin
.PLUGIN_ID
,
192 public Job
createIOServiceJob(final IImportConfigurator configurator
, final byte[] data
, final SOURCE_TYPE type
) {
193 Assert
.isNotNull(configurator
, "Configuration may not be null");
194 final Display display
= Display
.getDefault();
195 Job job
= new Job("Import: " + configurator
.getClass().getSimpleName()) {
198 protected IStatus
run(IProgressMonitor monitor
) {
199 monitor
.beginTask("Importing data", IProgressMonitor
.UNKNOWN
);
200 IIOService ioService
= CdmApplicationState
.getIOService();
202 ioService
.importData(configurator
, data
, type
);
206 display
.asyncExec(new Runnable() {
210 CdmStore
.getContextManager().notifyContextRefresh();
214 return Status
.OK_STATUS
;
222 public void runMoniteredOperation(IImportConfigurator configurator
, InputStream is
, SOURCE_TYPE type
) {
225 runMoniteredOperation(configurator
, IOUtils
.toByteArray(is
), type
);
226 } catch (Exception e
) {
227 MessagingUtils
.errorDialog("Error importing input stream",
230 TaxeditorStorePlugin
.PLUGIN_ID
,
237 public void runMoniteredOperation(IImportConfigurator configurator
, SOURCE_TYPE type
) {
238 byte[] data
= new byte[1];
240 runMoniteredOperation(configurator
, data
, type
);
241 } catch (Exception e
) {
242 MessagingUtils
.errorDialog("Error importing input stream",
245 TaxeditorStorePlugin
.PLUGIN_ID
,
252 public void runMoniteredOperation(IImportConfigurator configurator
, File importFile
, SOURCE_TYPE type
) {
253 Path path
= Paths
.get(importFile
.toURI());
255 runMoniteredOperation(configurator
, Files
.readAllBytes(path
), type
);
256 } catch (Exception e
) {
257 MessagingUtils
.errorDialog("Error importing input stream",
260 TaxeditorStorePlugin
.PLUGIN_ID
,
267 public void runMoniteredOperation(final IImportConfigurator configurator
, final byte[] data
, final SOURCE_TYPE type
) {
268 IIOService ioService
= CdmApplicationState
.getIOService();
269 final UUID uuid
= ioService
.monitImportData(configurator
, data
, type
);
270 Display
.getDefault().asyncExec(new Runnable() {
273 AbstractUtility
.executeMoniteredOperation("Import: " + configurator
.getClass().getSimpleName(),
284 private IImportConfigurator
getConfigurator(TYPE type
) {
285 Assert
.isNotNull(type
, "Type should not be null");
289 return JaxbImportConfigurator
.NewInstance(null, null);
291 return TcsXmlImportConfigurator
.NewInstance(null, null);
293 return EndnoteImportConfigurator
.NewInstance(null, null);
295 return NormalExplicitImportConfigurator
.NewInstance(null, null,
298 return Abcd206ImportConfigurator
.NewInstance(null, null);
300 return SDDImportConfigurator
.NewInstance(null, null);
301 case SpecimenCdmExcel
:
302 return SpecimenCdmExcelImportConfigurator
.NewInstance(null, null);
304 return Abcd206ImportConfigurator
.NewInstance(null, null);
306 MessagingUtils
.notImplementedMessage(this);
307 throw new IllegalArgumentException("Import not supported yet");
317 * @return a {@link eu.etaxonomy.cdm.io.jaxb.JaxbImportConfigurator} object.
319 public final JaxbImportConfigurator
JaxbConfigurator() {
320 return (JaxbImportConfigurator
) getConfigurator(TYPE
.Jaxb
);
328 * @return a {@link eu.etaxonomy.cdm.io.tcsxml.in.TcsXmlImportConfigurator}
331 public final TcsXmlImportConfigurator
TcsConfigurator() {
332 return (TcsXmlImportConfigurator
) getConfigurator(TYPE
.Tcs
);
337 * EndnoteConfigurator
341 * {@link eu.etaxonomy.cdm.io.reference.endnote.in.EndnoteImportConfigurator}
344 public final EndnoteImportConfigurator
EndnoteConfigurator() {
345 return (EndnoteImportConfigurator
) getConfigurator(TYPE
.Endnote
);
350 * NormalExplicitConfigurator
354 * {@link eu.etaxonomy.cdm.io.excel.taxa.NormalExplicitImportConfigurator}
357 public final NormalExplicitImportConfigurator
NormalExplicitConfigurator() {
358 return (NormalExplicitImportConfigurator
) getConfigurator(TYPE
.Excel_Taxa
);
366 * @return a {@link eu.etaxonomy.cdm.io.sdd.in.SDDImportConfigurator}
369 public final SDDImportConfigurator
SddConfigurator() {
370 return (SDDImportConfigurator
) getConfigurator(TYPE
.Sdd
);
379 * {@link eu.etaxonomy.cdm.io.specimen.abcd206.in.Abcd206ImportConfigurator}
382 public final Abcd206ImportConfigurator
AbcdConfigurator() {
383 return (Abcd206ImportConfigurator
) getConfigurator(TYPE
.Abcd
);
386 public SpecimenCdmExcelImportConfigurator
SpecimenCdmExcelImportConfigurator() {
387 return (SpecimenCdmExcelImportConfigurator
) getConfigurator(TYPE
.SpecimenCdmExcel
);
394 public void postOperation(IRemotingProgressMonitor monitor
) {
395 Display
.getDefault().asyncExec(new Runnable() {
399 CdmStore
.getContextManager().notifyContextRefresh();