Package adams.data.objectfilter

Class AttachMetaData

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.objectfilter.AbstractObjectFilter

adams.data.objectfilter.AttachMetaData

All Implemented Interfaces:

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

public class AttachMetaData
extends AbstractObjectFilter

Attaches the specified meta-data value.

-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:
 

-data-type <STRING|NUMERIC|BOOLEAN|UNKNOWN> (property: dataType)
    The data type to use for the meta-data.
    default: STRING
 

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

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected DataType	m_DataType	the data type.
protected String	m_Key	the key name.
protected String	m_Value	the value (gets parsed according to data type).

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

Method Summary

Modifier and Type	Method	Description
String	dataTypeTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected LocatedObjects	doFilter(LocatedObjects objects)	Filters the image objects.
DataType	getDataType()	Returns the data type of the value.
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.
String	getValue()	Returns the meta-data value to add.
String	globalInfo()	Returns a string describing the object.
String	keyTipText()	Returns the tip text for this property.
void	setDataType(DataType value)	Sets the data type of the value.
void	setKey(String value)	Sets the key of the meta-data value to add.
void	setValue(String value)	Sets the meta-data value to add.
String	valueTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.objectfilter.AbstractObjectFilter

check, filter, getFlowContext, requiresFlowContext, setFlowContext

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, 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, 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_DataType

protected DataType m_DataType

the data type.

m_Value

protected String m_Value

the value (gets parsed according to data type).

Constructor Detail

AttachMetaData

public AttachMetaData()

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

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.

setDataType

public void setDataType(DataType value)

Sets the data type of the value.

Parameters:

value - the type

getDataType

public DataType getDataType()

Returns the data type of the value.

Returns:

the type

dataTypeTipText

public String dataTypeTipText()

Returns the tip text for this property.

Returns:

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

setValue

public void setValue(String value)

Sets the meta-data value to add.

Parameters:

value - the value

getValue

public String getValue()

Returns the meta-data value to add.

Returns:

the value

valueTipText

public String valueTipText()

Returns the tip text for this property.

Returns:

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

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

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