Package adams.data.image.transformer

Class AbstractScript

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.image.AbstractImageTransformer<BufferedImageContainer>

adams.data.image.transformer.AbstractBufferedImageTransformer

adams.data.image.transformer.AbstractScript

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ImageTransformer<BufferedImageContainer>, AdditionalOptionsHandler, FlowContextHandler, Serializable, Comparable

public abstract class AbstractScript
extends AbstractBufferedImageTransformer
implements AdditionalOptionsHandler

Ancestor for JAI transformer scripts.

Scripts of scripting languages like Jython or Groovy need to be derived from this class.

Version:

$Revision: 7619 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AdditionalOptions	m_AdditionalOptions	for storing the additional options.

Fields inherited from class adams.data.image.AbstractImageTransformer

m_FlowContext

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractScript()

Method Summary

Modifier and Type	Method	Description
BufferedImageContainer[]	doTransform(BufferedImageContainer img)	Performs the actual transforming of the image.
AdditionalOptions	getAdditionalOptions()	Returns the value associated with the (additional) option.
protected void	initialize()	Initializes the members.
abstract BufferedImageContainer[]	performTransform(BufferedImageContainer img)	Performs the actual transforming of the image.
void	setAdditionalOptions(AdditionalOptions options)	Sets the additional options.

Methods inherited from class adams.data.image.transformer.AbstractBufferedImageTransformer

forCommandLine, forName, getTransformations

Methods inherited from class adams.data.image.AbstractImageTransformer

checkImage, cleanUp, compareTo, destroy, equals, getFlowContext, getQuickInfo, setFlowContext, shallowCopy, shallowCopy, transform

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Field Detail

m_AdditionalOptions

protected AdditionalOptions m_AdditionalOptions

for storing the additional options.

Constructor Detail

AbstractScript

public AbstractScript()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractImageTransformer<BufferedImageContainer>

setAdditionalOptions

public void setAdditionalOptions(AdditionalOptions options)

Sets the additional options.

Specified by:

setAdditionalOptions in interface AdditionalOptionsHandler

Parameters:

options - the options (name <->value relation)

getAdditionalOptions

public AdditionalOptions getAdditionalOptions()

Returns the value associated with the (additional) option.

Specified by:

getAdditionalOptions in interface AdditionalOptionsHandler

Returns:

the options (name <->value relation)

performTransform

public abstract BufferedImageContainer[] performTransform(BufferedImageContainer img)

Performs the actual transforming of the image.

Parameters:

img - the image to transform (can be modified, since it is a copy)

Returns:

the generated image(s)

doTransform

public BufferedImageContainer[] doTransform(BufferedImageContainer img)

Performs the actual transforming of the image.

Specified by:

doTransform in class AbstractImageTransformer<BufferedImageContainer>

Parameters:

img - the image to transform (can be modified, since it is a copy)

Returns:

the generated image(s)