Package adams.flow.transformer.mongodbfinddocuments.filter

Class AbstractMongoDbKeyValueDocumentFilter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.mongodbfinddocuments.filter.AbstractMongoDbDocumentFilter

adams.flow.transformer.mongodbfinddocuments.filter.AbstractMongoDbKeyValueDocumentFilter

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, MongoDbDocumentFilter, Serializable

Direct Known Subclasses:

Equal, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, NotEqual

public abstract class AbstractMongoDbKeyValueDocumentFilter
extends AbstractMongoDbDocumentFilter

Ancestor for filters that use a key-value pair.

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 key.
protected String	m_Value	the value.
protected adams.data.conversion.ConversionFromString	m_ValueConversion	the value conversion.

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

Method Summary

Modifier and Type	Method	Description
protected String	check()	Checks setup before configuring filter.
void	defineOptions()	Adds options to the internal list of options.
String	getKey()	Returns the key for the filter.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	getValue()	Returns the value for the filter.
adams.data.conversion.ConversionFromString	getValueConversion()	Returns the conversion for turning the value string into the actual type.
String	keyTipText()	Returns the tip text for this property.
void	setKey(String value)	Sets the key for the filter.
void	setValue(String value)	Sets the value for the filter.
void	setValueConversion(adams.data.conversion.ConversionFromString value)	Sets the conversion for turning the value string into the actual type.
String	valueConversionTipText()	Returns the tip text for this property.
String	valueTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.mongodbfinddocuments.filter.AbstractMongoDbDocumentFilter

configure, doConfigure

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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.

m_Value

protected String m_Value

the value.

m_ValueConversion

protected adams.data.conversion.ConversionFromString m_ValueConversion

the value conversion.

Constructor Detail

AbstractMongoDbKeyValueDocumentFilter

public AbstractMongoDbKeyValueDocumentFilter()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

setKey

public void setKey(String value)

Sets the key for the filter.

Parameters:

value - the key

getKey

public String getKey()

Returns the key for the filter.

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.

setValue

public void setValue(String value)

Sets the value for the filter.

Parameters:

value - the value

getValue

public String getValue()

Returns the value for the filter.

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.

setValueConversion

public void setValueConversion(adams.data.conversion.ConversionFromString value)

Sets the conversion for turning the value string into the actual type.

Parameters:

value - the conversion

getValueConversion

public adams.data.conversion.ConversionFromString getValueConversion()

Returns the conversion for turning the value string into the actual type.

Returns:

the conversion

valueConversionTipText

public String valueConversionTipText()

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 adams.core.QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractMongoDbDocumentFilter

Returns:

null if no info available, otherwise short string

check

protected String check()

Checks setup before configuring filter.

Overrides:

check in class AbstractMongoDbDocumentFilter

Returns:

null if OK, otherwise error message