Package adams.flow.source.valuedefinition

Class DefaultValueDefinition

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.source.valuedefinition.AbstractValueDefinition

adams.flow.source.valuedefinition.DefaultValueDefinition

All Implemented Interfaces:

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

public class DefaultValueDefinition
extends AbstractValueDefinition
implements ForwardSlashSupporter

Combines name, type and default value for a single value.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

EnterManyValues, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_DefaultValue	the default value (string representation).
protected PropertiesParameterPanel.PropertyType	m_Type	the type of the value.
protected boolean	m_UseForwardSlashes	whether to output forward slashes.

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

Method Summary

Modifier and Type	Method	Description
boolean	addToPanel(PropertiesParameterPanel panel)	Adds the value to the panel.
boolean	canBeRestored()	Returns whether this definition can be restored from a restoration file.
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.
PropertiesParameterPanel.PropertyType	getType()	Returns the type of the value.
boolean	getUseForwardSlashes()	Returns whether to use forward slashes in the output.
String	globalInfo()	Returns a string describing the object.
String	headlessInteraction()	Prompts the user to enter a value in headless mode and returns it.
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	setType(PropertiesParameterPanel.PropertyType value)	Sets the type of the value.
void	setUseForwardSlashes(boolean value)	Sets whether to use forward slashes in the output.
String	typeTipText()	Returns the tip text for this property.
String	useForwardSlashesTipText()	Returns the tip text for this property.

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

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_Type

protected PropertiesParameterPanel.PropertyType m_Type

the type of the value.

m_DefaultValue

protected String m_DefaultValue

the default value (string representation).

m_UseForwardSlashes

protected boolean m_UseForwardSlashes

whether to output forward slashes.

Constructor Detail

DefaultValueDefinition

public DefaultValueDefinition()

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

setType

public void setType(PropertiesParameterPanel.PropertyType value)

Sets the type of the value.

Parameters:

value - the type

getType

public PropertiesParameterPanel.PropertyType getType()

Returns the type of the value.

Specified by:

getType in class AbstractValueDefinition

Returns:

the type

typeTipText

public String typeTipText()

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.

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

setUseForwardSlashes

public void setUseForwardSlashes(boolean value)

Sets whether to use forward slashes in the output.

Specified by:

setUseForwardSlashes in interface ForwardSlashSupporter

Parameters:

value - if true then use forward slashes

getUseForwardSlashes

public boolean getUseForwardSlashes()

Returns whether to use forward slashes in the output.

Specified by:

getUseForwardSlashes in interface ForwardSlashSupporter

Returns:

true if forward slashes are used

useForwardSlashesTipText

public String useForwardSlashesTipText()

Returns the tip text for this property.

Specified by:

useForwardSlashesTipText in interface ForwardSlashSupporter

Returns:

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

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

canBeRestored

public boolean canBeRestored()

Returns whether this definition can be restored from a restoration file.

Overrides:

canBeRestored in class AbstractValueDefinition

Returns:

true if can be restored