Package adams.core.io

Class SimpleObjectToStringFilenameGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.io.AbstractFilenameGenerator

adams.core.io.SimpleObjectToStringFilenameGenerator

All Implemented Interfaces:

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

public class SimpleObjectToStringFilenameGenerator
extends AbstractFilenameGenerator

Simple generator that just turns the incoming object into a string using the 'toString()' method.

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

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
boolean	canHandleNullObject()	Returns whether we actually need an object to generate the filename.
protected String	doGenerate(Object obj)	Performs the actual generation of the filename.
String	globalInfo()	Returns a string describing the object.

Methods inherited from class adams.core.io.AbstractFilenameGenerator

check, generate, getQuickInfo

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, 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

Constructor Detail

SimpleObjectToStringFilenameGenerator

public SimpleObjectToStringFilenameGenerator()

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

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