Package adams.flow.source.valuedefinition

Class RegExpConstrainedStringDefinition

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.source.valuedefinition.AbstractValueDefinition

adams.flow.source.valuedefinition.RegExpConstrainedStringDefinition

All Implemented Interfaces:

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

public class RegExpConstrainedStringDefinition
extends AbstractValueDefinition

Definition for a string that is constrained by a regular expression.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_DefaultValue	the default value.
protected BaseRegExp	m_RegExp	the regular expression to use.

Fields inherited from class adams.flow.source.valuedefinition.AbstractValueDefinition

m_Display, m_Enabled, m_FlowContext, m_Help, m_Name

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

Method Summary

Modifier and Type	Method	Description
boolean	addToPanel(PropertiesParameterPanel panel)	Adds the value to the panel.
String	defaultValueTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
String	getDefaultValue()	Returns the default of the value.
String	getDefaultValueAsString()	Returns the default of the value as string.
BaseRegExp	getRegExp()	Returns the regular expression for constraining the input.
PropertiesParameterPanel.PropertyType	getType()	Returns the type of the value.
String	globalInfo()	Returns a string describing the object.
String	headlessInteraction()	Prompts the user to enter a value in headless mode and returns it.
String	regExpTipText()	Returns the tip text for this property.
protected boolean	requiresFlowContext()	Returns whether flow context is required.
void	setDefaultValue(String value)	Sets the default of the value.
void	setDefaultValueAsString(String value)	Sets the default value as string.
void	setRegExp(BaseRegExp value)	Sets the regular expression for constraining the input.

Methods inherited from class adams.flow.source.valuedefinition.AbstractValueDefinition

canBeRestored, check, displayTipText, enabledTipText, getDisplay, getEnabled, getFlowContext, getHelp, getName, helpTipText, nameTipText, setDisplay, setEnabled, setFlowContext, setHelp, setName

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 to use.

m_DefaultValue

protected String m_DefaultValue

the default value.

Constructor Detail

RegExpConstrainedStringDefinition

public RegExpConstrainedStringDefinition()

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 AbstractValueDefinition

setRegExp

public void setRegExp(BaseRegExp value)

Sets the regular expression for constraining the input.

Parameters:

value - the expression

getRegExp

public BaseRegExp getRegExp()

Returns the regular expression for constraining the input.

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.

setDefaultValue

public void setDefaultValue(String value)

Sets the default of the value.

Parameters:

value - the default

getDefaultValue

public String getDefaultValue()

Returns the default of the value.

Returns:

the default

defaultValueTipText

public String defaultValueTipText()

Returns the tip text for this property.

Returns:

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

getType

public PropertiesParameterPanel.PropertyType getType()

Returns the type of the value.

Specified by:

getType in class AbstractValueDefinition

Returns:

the type

setDefaultValueAsString

public void setDefaultValueAsString(String value)

Sets the default value as string.

Specified by:

setDefaultValueAsString in class AbstractValueDefinition

Parameters:

value - the default value

getDefaultValueAsString

public String getDefaultValueAsString()

Returns the default of the value as string.

Specified by:

getDefaultValueAsString in class AbstractValueDefinition

Returns:

the default

requiresFlowContext

protected boolean requiresFlowContext()

Returns whether flow context is required.

Specified by:

requiresFlowContext in class AbstractValueDefinition

Returns:

true if required

addToPanel

public boolean addToPanel(PropertiesParameterPanel panel)

Adds the value to the panel.

Specified by:

addToPanel in class AbstractValueDefinition

Parameters:

panel - the panel to add to

Returns:

true if successfully added

headlessInteraction

public String headlessInteraction()

Prompts the user to enter a value in headless mode and returns it.

Specified by:

headlessInteraction in class AbstractValueDefinition

Returns:

the entered value, null if canceled