Package adams.data.objectfilter

Class TransformMetaData

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.objectfilter.AbstractObjectFilter

adams.data.objectfilter.TransformMetaData

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ObjectFilter, FlowContextHandler, Serializable

public class TransformMetaData
extends AbstractObjectFilter

Transforms the specified meta-data using the referenced callable actor.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-key <java.lang.String> (property: key)
    The key of the meta-data value to add.
    default:
 

-transformer <adams.flow.core.CallableActorReference> (property: transformer)
    The callable transformer to apply to the located cells.
    default: unknown
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Actor	m_CallableActor	the callable actor.
protected CallableActorHelper	m_Helper	the helper class.
protected String	m_Key	the key name.
protected CallableActorReference	m_Transformer	the callable transformer to apply to the cells.

Fields inherited from class adams.data.objectfilter.AbstractObjectFilter

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
TransformMetaData()

Method Summary

Modifier and Type	Method	Description
protected String	check(LocatedObjects objects)	Hook method for checking the object list before processing it.
void	defineOptions()	Adds options to the internal list of options.
protected LocatedObjects	doFilter(LocatedObjects objects)	Filters the image objects.
protected Actor	findCallableActor()	Tries to find the callable actor referenced by its callable name.
String	getKey()	Returns the key of the meta-data value to add.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
CallableActorReference	getTransformer()	Returns the reference to the callable transformer.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
String	keyTipText()	Returns the tip text for this property.
protected void	reset()	Resets the scheme.
void	setKey(String value)	Sets the key of the meta-data value to add.
void	setTransformer(CallableActorReference value)	Sets the reference to the callable transformer.
protected String	setUpCallableActor()	Configures the callable actor.
String	transformerTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.objectfilter.AbstractObjectFilter

filter, getFlowContext, requiresFlowContext, setFlowContext

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Key

protected String m_Key

the key name.

m_Transformer

protected CallableActorReference m_Transformer

the callable transformer to apply to the cells.

m_Helper

protected CallableActorHelper m_Helper

the helper class.

m_CallableActor

protected Actor m_CallableActor

the callable actor.

Constructor Detail

TransformMetaData

public TransformMetaData()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOptionHandler

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractOptionHandler

setKey

public void setKey(String value)

Sets the key of the meta-data value to add.

Parameters:

value - the key

getKey

public String getKey()

Returns the key of the meta-data value to add.

Returns:

the name

keyTipText

public String keyTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setTransformer

public void setTransformer(CallableActorReference value)

Sets the reference to the callable transformer.

Parameters:

value - the reference

getTransformer

public CallableActorReference getTransformer()

Returns the reference to the callable transformer.

Returns:

the reference

transformerTipText

public String transformerTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

findCallableActor

protected Actor findCallableActor()

Tries to find the callable actor referenced by its callable name.

Returns:

the callable actor or null if not found

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractObjectFilter

Returns:

null if no info available, otherwise short string

setUpCallableActor

protected String setUpCallableActor()

Configures the callable actor.

Returns:

null if successful, otherwise error message

check

protected String check(LocatedObjects objects)

Hook method for checking the object list before processing it.

Overrides:

check in class AbstractObjectFilter

Parameters:

objects - the object list to check

Returns:

null if successful, otherwise error message

doFilter

protected LocatedObjects doFilter(LocatedObjects objects)

Filters the image objects.

Specified by:

doFilter in class AbstractObjectFilter

Parameters:

objects - the objects to filter

Returns:

the updated object list