org.openptk.plugin
Class Plugin

java.lang.Object
  org.openptk.common.Component
      org.openptk.plugin.Plugin

All Implemented Interfaces:

java.lang.Comparable<org.openptk.common.ComponentIF>, org.openptk.common.ComponentIF, PluginIF

public abstract class Plugin
extends org.openptk.common.Component
implements PluginIF

Author:

Scott Fehrman, Sun Microsystems, Inc.

Field Summary

Fields inherited from interface org.openptk.common.ComponentIF

EXECUTE_BEGIN, EXECUTE_END, PROP_OPENPTK_HOME, PROP_OPENPTK_TEMP, SORT_BEGIN, SORT_END

Constructor Summary

Plugin()

Method Summary

abstract StructureIF	execute(StructureIF structure)
void	handleError(java.lang.String msg)
void	shutdown()
void	startup()

Methods inherited from class org.openptk.common.Component

compareTo, copy, getAttribute, getAttributes, getAttributesNames, getAttributesSize, getCategory, getCategoryAsString, getDebugLevel, getDebugLevelAsInt, getDebugLevelAsString, getDescription, getProperties, getPropertiesSize, getProperty, getSortValue, getState, getStateAsString, getStatus, getTimeStamp, getTimeStampNames, getTimeStamps, getUniqueId, getUniqueIdType, isDebug, isError, isTimeStamp, setAttribute, setAttributes, setCategory, setDebug, setDebugLevel, setDescription, setError, setProperties, setProperty, setSortValue, setState, setState, setStatus, setTimeStamp, setTimeStamp, setUniqueId, setUniqueId, setUniqueId, setUniqueId, toString, useTimeStamp

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openptk.common.ComponentIF

copy, getAttribute, getAttributes, getAttributesNames, getAttributesSize, getCategory, getCategoryAsString, getDebugLevel, getDebugLevelAsInt, getDebugLevelAsString, getDescription, getProperties, getPropertiesSize, getProperty, getSortValue, getState, getStateAsString, getStatus, getTimeStamp, getTimeStampNames, getTimeStamps, getUniqueId, getUniqueIdType, isDebug, isError, isTimeStamp, setAttribute, setAttributes, setCategory, setDebug, setDebugLevel, setDescription, setError, setProperties, setProperty, setSortValue, setState, setState, setStatus, setTimeStamp, setTimeStamp, setUniqueId, setUniqueId, setUniqueId, setUniqueId, useTimeStamp

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

Plugin

public Plugin()

Method Detail

execute

public abstract StructureIF execute(StructureIF structure)
                             throws PluginException

Specified by:

execute in interface PluginIF

Parameters:

structure -

Returns:

StructureIF

Throws:

PluginException

handleError

public void handleError(java.lang.String msg)
                 throws PluginException

Parameters:

msg -

Throws:

PluginException

shutdown

public void shutdown()
              throws PluginException

Specified by:

shutdown in interface PluginIF

Throws:

PluginException

startup

public void startup()
             throws PluginException

Specified by:

startup in interface PluginIF

Throws:

PluginException