org.pfsw.tools.cda.ui.plugin.export.spi

Class AModelExporterUIPlugin

java.lang.Object

org.pfsw.tools.cda.xpi.APluginImplementation

org.pfsw.tools.cda.ui.xpi.AActionPlugin

org.pfsw.tools.cda.ui.plugin.export.spi.AModelExporterUIPlugin

All Implemented Interfaces:

IPluginActionInfo, IPluginInfo

public abstract class AModelExporterUIPlugin
extends AActionPlugin

The purpose of this abstract exporter plugin is to provide default implementations of methods that may be overridden by subclasses. This is more stable in comparison to an interface, since adding new methods won't break already existing subclasses.

The purpose of subclasses is to create special exporter instances (which must be subclasses of AModelExporter) and to provide some meta data and GUI elements for integration into CDA application.

There are only two abstract methods that definitely must be implemented by each subclass.

• getId()
• createExporter()

All subclasses must implement a public non-argument constructor!

Field Summary

Fields inherited from interface org.pfsw.tools.cda.ui.xpi.IPluginActionInfo

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
AModelExporterUIPlugin()

Method Summary

Modifier and Type	Method and Description
abstract AModelExporter	createExporter(PluginConfiguration config) Returns a new instance of an exporter.
PluginConfiguration	getConfiguration(java.awt.Frame parent) Returns the configuration data that might be necessary to execute the plugin's functionality

Methods inherited from class org.pfsw.tools.cda.ui.xpi.AActionPlugin

getDisabledIconFilename, getEnabledIconFilename, getToolTipText

Methods inherited from class org.pfsw.tools.cda.xpi.APluginImplementation

getPluginId, setPluginId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pfsw.tools.cda.ui.xpi.IPluginActionInfo

getActionText

Methods inherited from interface org.pfsw.tools.cda.xpi.IPluginInfo

getPluginId, getPluginProvider, getPluginVersion

Constructor Detail

AModelExporterUIPlugin

public AModelExporterUIPlugin()

Method Detail

createExporter

public abstract AModelExporter createExporter(PluginConfiguration config)

Returns a new instance of an exporter.

If creation fails this method can just return null.

Parameters:

config - The configuration for the new exporter

getConfiguration

public PluginConfiguration getConfiguration(java.awt.Frame parent)

Returns the configuration data that might be necessary to execute the plugin's functionality

Parameters:

parent - The parent frame from which the plugin is used

Returns:

A configuration or null