org.pfsw.tools.cda.core.export

Class ModelExportEngine

java.lang.Object

org.pfsw.tools.cda.core.export.ModelExportEngine

public class ModelExportEngine
extends java.lang.Object

The single instance holds a registry of all plugged-in model exporter factories. It also provides the functionality to actually export the model or part of it utilizing a particular exporter.

Method Summary

Modifier and Type	Method and Description
boolean	export(AModelObject modelObject, AModelExporter exporter) Exports the given model object and returns true if the export was successful.
boolean	export(AModelObject modelObject, IProgressMonitor progressMonitor, AModelExporter exporter) Exports the given model object and returns true if the export was successful.
static ModelExportEngine	instance() Returns the only instance this class supports (design pattern "Singleton")

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

instance

public static ModelExportEngine instance()

Returns the only instance this class supports (design pattern "Singleton")

export

public boolean export(AModelObject modelObject,
                      AModelExporter exporter)
               throws java.lang.Exception

Exports the given model object and returns true if the export was successful.

Parameters:

modelObject - The object of the mode at which to start the export (must not be null).

exporter - The actual exporter that gets called for each element to write it to its destination (must not be null).

Returns:

true if the export has been executed completely (not aborted), otherwise false.

Throws:

java.lang.Exception - for any severe error that happens.

export

public boolean export(AModelObject modelObject,
                      IProgressMonitor progressMonitor,
                      AModelExporter exporter)
               throws java.lang.Exception

Exports the given model object and returns true if the export was successful. This method allows to monitor the progress of the export and even can be cancelled utilizing the progressMonitor.

Parameters:

modelObject - The object of the mode at which to start the export (must not be null).

progressMonitor - An object that can be used to track the progress and to abort the export processing (may be null).

exporter - The actual exporter that gets called for each element to write it to its destination (must not be null).

Returns:

true if the export has been executed completely (not aborted), otherwise false.

Throws:

java.lang.Exception - for any severe error that happens.