Package adams.data.djl.idgenerator

Class FixedID

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.djl.idgenerator.AbstractIDGenerator

adams.data.djl.idgenerator.FixedID

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, IDGenerator, adams.flow.core.FlowContextHandler, Serializable

public class FixedID
extends AbstractIDGenerator

Just uses the supplied ID.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_ID	the ID to use.

Fields inherited from class adams.data.djl.idgenerator.AbstractIDGenerator

m_FlowContext

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
FixedID()	Default constructor.
FixedID(String id)	Instantiates the generator and sets the ID to use.

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	generate()	Generates the ID.
String	getID()	Gets the ID/prefix for saving the model.
String	globalInfo()	Returns a string describing the object.
String	IDTipText()	Returns the tip text for this property.
void	setID(String value)	Sets the ID/prefix for saving the model.

Methods inherited from class adams.data.djl.idgenerator.AbstractIDGenerator

getFlowContext, getQuickInfo, requiresFlowContext, setFlowContext

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_ID

protected String m_ID

the ID to use.

Constructor Detail

FixedID

public FixedID()

Default constructor.

FixedID

public FixedID(String id)

Instantiates the generator and sets the ID to use.

Parameters:

id - the ID to use

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.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 adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

setID

public void setID(String value)

Sets the ID/prefix for saving the model.

Parameters:

value - the ID/prefix

getID

public String getID()

Gets the ID/prefix for saving the model.

Returns:

the ID/prefix

IDTipText

public String IDTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

generate

public String generate()

Generates the ID.

Returns:

the ID