Package adams.flow.transformer.mapfilter

Class RemoveByName

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.mapfilter.AbstractMapFilter

adams.flow.transformer.mapfilter.RemoveByName

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class RemoveByName
extends AbstractMapFilter

Filters the map by removing values which keys match the regular expression. The matching can be inverted.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Invert	whether to invert the matching sense.
protected BaseRegExp	m_RegExp	the regular expression that the names must match.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected Map	doFilterMap(Map map)	Filters the map.
boolean	getInvert()	Returns whether to invert the matching sense.
BaseRegExp	getRegExp()	Returns the regular expression to match the keys against.
String	globalInfo()	Returns a string describing the object.
String	invertTipText()	Returns the tip text for this property.
String	regExpTipText()	Returns the tip text for this property.
void	setInvert(boolean value)	Sets whether to invert the matching sense.
void	setRegExp(BaseRegExp value)	Sets the regular expression to match the keys against.

Methods inherited from class adams.flow.transformer.mapfilter.AbstractMapFilter

check, filterMap

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.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_RegExp

protected BaseRegExp m_RegExp

the regular expression that the names must match.

m_Invert

protected boolean m_Invert

whether to invert the matching sense.

Constructor Detail

RemoveByName

public RemoveByName()

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

setRegExp

public void setRegExp(BaseRegExp value)

Sets the regular expression to match the keys against.

Parameters:

value - the regular expression

getRegExp

public BaseRegExp getRegExp()

Returns the regular expression to match the keys against.

Returns:

the regular 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.

setInvert

public void setInvert(boolean value)

Sets whether to invert the matching sense.

Parameters:

value - true if inverting matching sense

getInvert

public boolean getInvert()

Returns whether to invert the matching sense.

Returns:

true if matching sense is inverted

invertTipText

public String invertTipText()

Returns the tip text for this property.

Returns:

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

doFilterMap

protected Map doFilterMap(Map map)

Filters the map.

Specified by:

doFilterMap in class AbstractMapFilter

Parameters:

map - the map to filter

Returns:

the filtered map