Package adams.data.objectfinder

Class ByMetaDataStringValue

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.objectfinder.AbstractObjectFinder

adams.data.objectfinder.ByMetaDataStringValue

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LenientModeSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ObjectFinder, ObjectPrefixHandler, Serializable

public class ByMetaDataStringValue
extends AbstractObjectFinder

Outputs the indices of objects where the specified regular expression matches the value associated with the given meta-data key.

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

-prefix <java.lang.String> (property: prefix)
    The report field prefix used in the report.
    default: Object.
 

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

-regexp <adams.core.base.BaseRegExp> (property: regExp)
    The regular expression that the meta-data value must match.
    default: .*
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Key	the meta-data key to inspect.
protected BaseRegExp	m_RegExp	the regular expression to match against the value.

Fields inherited from class adams.data.objectfinder.AbstractObjectFinder

m_Lenient, m_Prefix, m_ResetIndicesIfNecessary

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected int[]	doFind(LocatedObjects objects)	Performs the actual finding of the objects in the list.
String	getKey()	Returns the meta-data key to check.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
BaseRegExp	getRegExp()	Returns the regular expression to match the meta-data value against.
String	globalInfo()	Returns a string describing the object.
String	keyTipText()	Returns the tip text for this property.
String	regExpTipText()	Returns the tip text for this property.
void	setKey(String value)	Sets the meta-data key to check.
void	setRegExp(BaseRegExp value)	Sets the regular expression to match the meta-data value against.

Methods inherited from class adams.data.objectfinder.AbstractObjectFinder

check, filter, find, find, findObjects, findObjects, getLenient, getPrefix, getResetIndicesIfNecessary, lenientTipText, prefixTipText, resetIndicesIfNecessaryTipText, setLenient, setPrefix, setResetIndicesIfNecessary

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 meta-data key to inspect.

m_RegExp

protected BaseRegExp m_RegExp

the regular expression to match against the value.

Constructor Detail

ByMetaDataStringValue

public ByMetaDataStringValue()

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 AbstractObjectFinder

setKey

public void setKey(String value)

Sets the meta-data key to check.

Parameters:

value - the key

getKey

public String getKey()

Returns the meta-data key to check.

Returns:

the key

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.

setRegExp

public void setRegExp(BaseRegExp value)

Sets the regular expression to match the meta-data value against.

Parameters:

value - the expression

getRegExp

public BaseRegExp getRegExp()

Returns the regular expression to match the meta-data value against.

Returns:

the expression

regExpTipText

public String regExpTipText()

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 AbstractObjectFinder

Returns:

null if no info available, otherwise short string

doFind

protected int[] doFind(LocatedObjects objects)

Performs the actual finding of the objects in the list.

Specified by:

doFind in class AbstractObjectFinder

Parameters:

objects - the list of objects to process

Returns:

the indices