public abstract class AModelExporter extends AModelObjectVisitor implements IPluginInfo
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PARAM_OUTPUT_FILENAME
Defines the parameter name of the configuration setting for the
initialize() method that specifies the filename to which the
output must be written.
|
Constructor and Description |
---|
AModelExporter() |
Modifier and Type | Method and Description |
---|---|
void |
abortExport()
This method gets called if the export must be aborted due to user interrupt
or any exception that occurred during export execution.
|
boolean |
finishExport()
This method gets called after all data has been passed to the exporter
and so far no exception or cancellation occurred.
|
java.lang.String |
getPluginId()
Returns the exporte's id
|
abstract boolean |
initialize(PluginConfiguration config)
Initialize the exporter with external configuration data.
|
boolean |
prepareExport()
This method is called to initiate an export.
|
void |
setId(java.lang.String id)
Returns the exporte's id
|
finishContainer, finishContext, finishModelObject, finishNamespace, finishType, startContainer, startContext, startModelObject, startNamespace, startType
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getPluginProvider, getPluginVersion
public static final java.lang.String PARAM_OUTPUT_FILENAME
public abstract boolean initialize(PluginConfiguration config)
The data provided with this config object can be a filename or a database URL with user id and password or whatever is necessary to enable the specific exporter to do its work.
config
- The configuration to be used for initializationpublic boolean prepareExport()
public boolean finishExport()
The default application returns true.
public void abortExport()
The default implementation here is doing nothing.
public java.lang.String getPluginId()
getPluginId
in interface IPluginInfo
public void setId(java.lang.String id)