Package adams.flow.transformer.generatefilebaseddataset

Class SimpleFileList

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.generatefilebaseddataset.AbstractFileBasedDatasetGeneration<String>

adams.flow.transformer.generatefilebaseddataset.SimpleFileList

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, FileWriter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class SimpleFileList
extends AbstractFileBasedDatasetGeneration<String>
implements FileWriter

Simply outputs the specified list of files in the container as a text file.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PlaceholderFile	m_OutputFile	the output file.
protected String	m_Value	the value in the container to use.

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

Method Summary

Modifier and Type	Method	Description
protected String	check(FileBasedDatasetContainer cont)	Performs checks on the container.
void	defineOptions()	Adds options to the internal list of options.
protected String	doGenerate(FileBasedDatasetContainer cont)	Generates the dataset.
Class	generates()	Returns the class that gets generated.
PlaceholderFile	getOutputFile()	Returns the output file.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	getValue()	Returns the name of the container value to save.
String	globalInfo()	Returns a string describing the object.
String	outputFileTipText()	Returns the tip text for this property.
protected String[]	requiredValues()	The keys of the values that need to be present in the container.
void	setOutputFile(PlaceholderFile value)	Sets the output file.
void	setValue(String value)	Sets the name of the container value to save.
String	valueTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.generatefilebaseddataset.AbstractFileBasedDatasetGeneration

generate

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_Value

protected String m_Value

the value in the container to use.

m_OutputFile

protected PlaceholderFile m_OutputFile

the output file.

Constructor Detail

SimpleFileList

public SimpleFileList()

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 AbstractOptionHandler

setValue

public void setValue(String value)

Sets the name of the container value to save.

Parameters:

value - the value

getValue

public String getValue()

Returns the name of the container value to save.

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.

setOutputFile

public void setOutputFile(PlaceholderFile value)

Sets the output file.

Specified by:

setOutputFile in interface FileWriter

Parameters:

value - the file

getOutputFile

public PlaceholderFile getOutputFile()

Returns the output file.

Specified by:

getOutputFile in interface FileWriter

Returns:

the file

outputFileTipText

public String outputFileTipText()

Returns the tip text for this property.

Specified by:

outputFileTipText in interface FileWriter

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 actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractFileBasedDatasetGeneration<String>

Returns:

null if no info available, otherwise short string

generates

public Class generates()

Returns the class that gets generated.

Specified by:

generates in class AbstractFileBasedDatasetGeneration<String>

Returns:

the generated class

requiredValues

protected String[] requiredValues()

The keys of the values that need to be present in the container.

Specified by:

requiredValues in class AbstractFileBasedDatasetGeneration<String>

Returns:

the keys

check

protected String check(FileBasedDatasetContainer cont)

Performs checks on the container.

Overrides:

check in class AbstractFileBasedDatasetGeneration<String>

Parameters:

cont - the container to check

Returns:

null if successful, otherwise error message

doGenerate

protected String doGenerate(FileBasedDatasetContainer cont)

Generates the dataset.

Specified by:

doGenerate in class AbstractFileBasedDatasetGeneration<String>

Parameters:

cont - the container to use

Returns:

the generated output