Package adams.core.io

Class SimpleFilenameGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.io.AbstractFilenameGenerator

adams.core.io.AbstractFilenameGeneratorWithDirectory

adams.core.io.AbstractFilenameGeneratorWithExtension

adams.core.io.SimpleFilenameGenerator

All Implemented Interfaces:

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

Direct Known Subclasses:

TimestampFilenameGenerator

public class SimpleFilenameGenerator
extends AbstractFilenameGeneratorWithExtension

Simple generator that assembles filename based on output dir, prefix, current object (string representation), suffix and extension.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-dir <adams.core.io.PlaceholderDirectory> (property: directory)
    The parent directory of the generated filename.
    default: ${CWD}
 

-extension <java.lang.String> (property: extension)
    The extension to use (including the dot).
    default: 
 

-prefix <java.lang.String> (property: prefix)
    The prefix to use (before the object).
    default: 
 

-suffix <java.lang.String> (property: suffix)
    The suffix to use (after the object).
    default: 
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Prefix	the prefix to use.
protected String	m_Suffix	the suffix to use.

Fields inherited from class adams.core.io.AbstractFilenameGeneratorWithExtension

m_Extension

Fields inherited from class adams.core.io.AbstractFilenameGeneratorWithDirectory

m_Directory

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

Method Summary

Modifier and Type	Method	Description
boolean	canHandleNullObject()	Returns whether we actually need an object to generate the filename.
void	defineOptions()	Adds options to the internal list of options.
protected String	doGenerate(Object obj)	Performs the actual generation of the filename.
String	getPrefix()	Returns the prefix in use.
String	getSuffix()	Returns the suffix in use.
String	globalInfo()	Returns a string describing the object.
String	prefixTipText()	Returns the tip text for this property.
void	setPrefix(String value)	Sets the prefix to use.
void	setSuffix(String value)	Sets the suffix to use.
String	suffixTipText()	Returns the tip text for this property.

Methods inherited from class adams.core.io.AbstractFilenameGeneratorWithExtension

extensionTipText, getExtension, setExtension

Methods inherited from class adams.core.io.AbstractFilenameGeneratorWithDirectory

directoryTipText, getDirectory, setDirectory

Methods inherited from class adams.core.io.AbstractFilenameGenerator

check, generate, getQuickInfo

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_Prefix

protected String m_Prefix

the prefix to use.

m_Suffix

protected String m_Suffix

the suffix to use.

Constructor Detail

SimpleFilenameGenerator

public SimpleFilenameGenerator()

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 AbstractFilenameGeneratorWithExtension

setPrefix

public void setPrefix(String value)

Sets the prefix to use.

Parameters:

value - the prefix

getPrefix

public String getPrefix()

Returns the prefix in use.

Returns:

the prefix

prefixTipText

public String prefixTipText()

Returns the tip text for this property.

Returns:

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

setSuffix

public void setSuffix(String value)

Sets the suffix to use.

Parameters:

value - the suffix

getSuffix

public String getSuffix()

Returns the suffix in use.

Returns:

the suffix

suffixTipText

public String suffixTipText()

Returns the tip text for this property.

Returns:

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

canHandleNullObject

public boolean canHandleNullObject()

Returns whether we actually need an object to generate the filename.

Specified by:

canHandleNullObject in class AbstractFilenameGenerator

Returns:

true if object required

doGenerate

protected String doGenerate(Object obj)

Performs the actual generation of the filename.

Specified by:

doGenerate in class AbstractFilenameGenerator

Parameters:

obj - the object to generate the filename for

Returns:

the generated filename