Package adams.data.djl.outputdirgenerator

Class VariableDir

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.djl.outputdirgenerator.AbstractOutputDirGenerator

adams.data.djl.outputdirgenerator.VariableDir

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

public class VariableDir
extends AbstractOutputDirGenerator

Expands any variables in the supplied string and returns that as directory.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.core.base.BaseString	m_OutputDir	the text to use as dir.

Fields inherited from class adams.data.djl.outputdirgenerator.AbstractOutputDirGenerator

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
VariableDir()	Default constructor.
VariableDir(adams.core.base.BaseString dir)	Instantiates the generator and sets the dir to use.
VariableDir(String dir)	Instantiates the generator and sets the dir to use.

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
adams.core.io.PlaceholderDirectory	generate()	Generates the output directory.
adams.core.base.BaseString	getOutputDir()	Gets the output dir.
String	globalInfo()	Returns a string describing the object.
String	outputDirTipText()	Returns the tip text for this property.
protected boolean	requiresFlowContext()	Returns whether flow context is required.
void	setOutputDir(adams.core.base.BaseString value)	Sets the output dir.

Methods inherited from class adams.data.djl.outputdirgenerator.AbstractOutputDirGenerator

getFlowContext, getQuickInfo, 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_OutputDir

protected adams.core.base.BaseString m_OutputDir

the text to use as dir.

Constructor Detail

VariableDir

public VariableDir()

Default constructor.

VariableDir

public VariableDir(String dir)

Instantiates the generator and sets the dir to use.

Parameters:

dir - the dir to use

VariableDir

public VariableDir(adams.core.base.BaseString dir)

Instantiates the generator and sets the dir to use.

Parameters:

dir - the dir 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

setOutputDir

public void setOutputDir(adams.core.base.BaseString value)

Sets the output dir.

Parameters:

value - the dir

getOutputDir

public adams.core.base.BaseString getOutputDir()

Gets the output dir.

Returns:

the dir

outputDirTipText

public String outputDirTipText()

Returns the tip text for this property.

Returns:

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

requiresFlowContext

protected boolean requiresFlowContext()

Returns whether flow context is required.

Overrides:

requiresFlowContext in class AbstractOutputDirGenerator

Returns:

true if required

generate

public adams.core.io.PlaceholderDirectory generate()

Generates the output directory.

Returns:

the directory