Package adams.flow.transformer

Class TimeseriesFileReader

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.AbstractDataContainerFileReader<Timeseries>

adams.flow.transformer.TimeseriesFileReader

All Implemented Interfaces:

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

public class TimeseriesFileReader
extends AbstractDataContainerFileReader<Timeseries>

Loads a file/directory containing spectrums from disk with a specified reader and passes them on.

Input/output:
- accepts:

   java.lang.String

- generates:

   knir.data.spectrum.Timeseries

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: TimeseriesFileReader
 

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

-reader <knir.data.input.AbstractTimeseriesReader [options]> (property: reader)
         The reader to use for importing the spectrums.
         default: knir.data.input.SimpleTimeseriesReader -input .
 

Default options for knir.data.input.SimpleTimeseriesReader (-reader/reader):

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

-input <java.io.File> (property: input)
         The file to read and turn into a spectrum.
         default: .
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.flow.transformer.AbstractDataContainerFileReader

BACKUP_CONTAINERS, m_Containers, m_OutputArray, m_Reader

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

Method Summary

Modifier and Type	Method	Description
protected AbstractDataContainerReader	getDefaultReader()	Returns the default reader to use.
protected Class	getItemClass()	Returns the base class of the items.
String	globalInfo()	Returns a string describing the object.

Methods inherited from class adams.flow.transformer.AbstractDataContainerFileReader

accepts, backupState, cleanUp, defineOptions, doExecute, generates, getOutputArray, getQuickInfo, getReader, hasPendingOutput, output, outputArrayTipText, pruneBackup, readerTipText, reset, restoreState, setOutputArray, setReader, stopExecution

Methods inherited from class adams.flow.transformer.AbstractTransformer

currentInput, execute, hasInput, input, postExecute, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, 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, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, 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

compareTo, destroy, equals, execute, 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, toCommandLine, variableChanged, wrapUp

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

TimeseriesFileReader

public TimeseriesFileReader()

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

getDefaultReader

protected AbstractDataContainerReader getDefaultReader()

Returns the default reader to use.

Specified by:

getDefaultReader in class AbstractDataContainerFileReader<Timeseries>

Returns:

the default reader

getItemClass

protected Class getItemClass()

Returns the base class of the items.

Specified by:

getItemClass in class AbstractDataContainerFileReader<Timeseries>

Returns:

the class