Package adams.flow.transformer.appendarchive

Class StringObjectAppender

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.appendarchive.AbstractArchiveObjectAppender

adams.flow.transformer.appendarchive.StringObjectAppender

All Implemented Interfaces:

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

public class StringObjectAppender
extends AbstractArchiveObjectAppender

Adds text (ie strings) to the archive.

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

Method Summary

Modifier and Type	Method	Description
boolean	canProcess(Object obj)	Whether the appender can handle this particular object.
String	globalInfo()	Returns a string describing the object.
String	process(ArchiveManager manager, Object obj, String name)	Processes the given object.

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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Constructor Detail

StringObjectAppender

public StringObjectAppender()

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

canProcess

public boolean canProcess(Object obj)

Whether the appender can handle this particular object.

Parameters:

obj - the object to check

Returns:

true if the object can be handled

process

public String process(ArchiveManager manager,
                      Object obj,
                      String name)

Processes the given object.

Parameters:

manager - the context

obj - the object to process

name - the name to use in the archive

Returns:

null if successfully added, otherwise error message