Package adams.flow.transformer

Class TimeseriesFileWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.transformer.AbstractTransformer

adams.flow.transformer.AbstractDataContainerFileWriter<Timeseries>

adams.flow.transformer.TimeseriesFileWriter

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

public class TimeseriesFileWriter
extends AbstractDataContainerFileWriter<Timeseries>

Saves a spectrum to disk with the specified writer and passes the absolute filename on.
As filename/directory name (depending on the writer) the database ID of the spectrum is used (below the specified output directory).

Input/output:
- accepts:

   knir.data.spectrum.Timeseries

- generates:

   java.lang.String

Valid options are:

-D (property: debug)
         If set to true, scheme may output additional info to the console.
 

-name <java.lang.String> (property: name)
         The name of the actor.
         default: TimeseriesFileWriter
 

-annotation <knir.core.base.BaseString> [-annotation ...] (property: annotations)
         The annotations to attach to this actor.
 

-skip (property: skip)
         If set to true, transformation is skipped and the input token is just forwarded
          as it is.
 

-writer <knir.data.output.AbstractTimeseriesWriter [options]> (property: writer)
         The writer to use for saving the spectrums.
         default: knir.data.output.SimpleTimeseriesWriter -output /tmp/out.spec
 

-dir <java.io.File> (property: outputDir)
         The output directory for the spectrums.
         default: .
 

Default options for knir.data.output.SimpleTimeseriesWriter (-writer/writer):

-D (property: debug)
         If set to true, scheme may output additional info to the console.
 

-output <java.io.File> (property: output)
         The file to write the spectrum to.
         default: /tmp/out.spec
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.flow.transformer.AbstractDataContainerFileWriter

AbstractDataContainerFileWriter.FileNameGeneration

Field Summary

Fields inherited from class adams.flow.transformer.AbstractDataContainerFileWriter

m_FileNameGeneration, m_OutputDir, m_SuppliedFileName, m_Writer

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

Constructors

Constructor	Description
TimeseriesFileWriter()

Method Summary

Modifier and Type	Method	Description
protected Class	getDataContainerClass()	Returns the data container class in use.
protected AbstractDataContainerWriter<Timeseries>	getDefaultWriter()	Returns the default writer to use.
String	globalInfo()	Returns a string describing the object.

Methods inherited from class adams.flow.transformer.AbstractDataContainerFileWriter

accepts, defineOptions, doExecute, doWrite, fileNameGenerationTipText, generates, getDefaultExtension, getDefaultSuppliedFileName, getFileNameGeneration, getOutputDir, getQuickInfo, getSuppliedFileName, getWriter, outputDirTipText, setFileNameGeneration, setOutputDir, setSuppliedFileName, setWriter, suppliedFileNameTipText, writerTipText

Methods inherited from class adams.flow.transformer.AbstractTransformer

backupState, currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute, restoreState, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, preExecute, pruneBackup, pruneBackup, reset, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, destroy, equals, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Constructor Detail

TimeseriesFileWriter

public TimeseriesFileWriter()

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

getDefaultWriter

protected AbstractDataContainerWriter<Timeseries> getDefaultWriter()

Returns the default writer to use.

Specified by:

getDefaultWriter in class AbstractDataContainerFileWriter<Timeseries>

Returns:

the default writer

getDataContainerClass

protected Class getDataContainerClass()

Returns the data container class in use.

Specified by:

getDataContainerClass in class AbstractDataContainerFileWriter<Timeseries>

Returns:

the container class