Package adams.flow.transformer
Class SpreadSheetRowToTimeseries
-
- 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 SpreadSheetRowToTimeseries extends AbstractArrayProvider
Turns a spreadsheet row into a timeseries.
Columns for timestamps and values are extracted using the regular expressions, the timestamp columns are optional.
Input/output:
- accepts:
adams.data.spreadsheet.SpreadSheet
- generates:
adams.data.timeseries.Timeseries
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-name <java.lang.String> (property: name) The name of the actor. default: SpreadSheetRowToTimeseries
-annotation <adams.core.base.BaseAnnotation> (property: annotations) The annotations to attach to this actor. default:
-skip <boolean> (property: skip) If set to true, transformation is skipped and the input token is just forwarded as it is. default: false
-stop-flow-on-error <boolean> (property: stopFlowOnError) If set to true, the flow gets stopped in case this actor encounters an error; useful for critical actors. default: false
-output-array <boolean> (property: outputArray) If enabled, outputs an array of Timeseries objects rather than one-by-one. default: false
-column-id <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: columnID) The (optional) column storing the ID for a timeseries. default: 1 example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last
-data-range <adams.data.spreadsheet.SpreadSheetColumnRange> (property: dataRange) The range of columns to use for generating the timeseries. default: first-last example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last
-regexp-timestamp <adams.core.base.BaseRegExp> (property: regExpTimestamp) The regular expression for matching the columns that contain the timestamps for the data points. default: Timestamp-
-regexp-value <adams.core.base.BaseRegExp> (property: regExpValue) The regular expression for matching the columns that contain the values of the data points. default: Value-
- Version:
- $Revision: 8016 $
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected SpreadSheetColumnIndex
m_ColumnID
the column to use for grouping the timeseries.protected SpreadSheetColumnRange
m_DataRange
the range of columns to use for the timeseries.protected BaseRegExp
m_RegExpTimestamp
the regular expression for timestamp columns.protected BaseRegExp
m_RegExpValue
the regular expression for value columns.-
Fields inherited from class adams.flow.transformer.AbstractArrayProvider
BACKUP_INDEX, BACKUP_QUEUE, m_Index, m_OutputArray, m_Queue
-
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 SpreadSheetRowToTimeseries()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Class[]
accepts()
Returns the class that the consumer accepts.String
columnIDTipText()
Returns the tip text for this property.String
dataRangeTipText()
Returns the tip text for this property.void
defineOptions()
Adds options to the internal list of options.protected String
doExecute()
Executes the flow item.SpreadSheetColumnIndex
getColumnID()
Returns the index/name of the column to use for grouping the timeseries data points.SpreadSheetColumnRange
getDataRange()
Returns the range of columns to use for generating the timeseries.protected Class
getItemClass()
Returns the base class of the items.String
getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.BaseRegExp
getRegExpTimestamp()
Returns the regular expression for matching the timestamp columns.BaseRegExp
getRegExpValue()
Returns the regular expression for matching the timestamp columns.String
globalInfo()
Returns a string describing the object.String
outputArrayTipText()
Returns the tip text for this property.String
regExpTimestampTipText()
Returns the tip text for this property.String
regExpValueTipText()
Returns the tip text for this property.void
setColumnID(SpreadSheetColumnIndex value)
Sets the index/name of the column to use for grouping the timeseries data points.void
setDataRange(SpreadSheetColumnRange value)
Sets the range of columns to use for generating the timeseries.void
setRegExpTimestamp(BaseRegExp value)
Sets the regular expression for matching the timestamp columns.void
setRegExpValue(BaseRegExp value)
Sets the regular expression for matching the timestamp columns.-
Methods inherited from class adams.flow.transformer.AbstractArrayProvider
backupState, generates, getOutputArray, hasPendingOutput, output, preExecute, pruneBackup, reset, restoreState, setOutputArray, wrapUp
-
Methods inherited from class adams.flow.transformer.AbstractTransformer
currentInput, execute, hasInput, input, postExecute
-
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, pruneBackup, 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, 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, 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
-
-
-
-
Field Detail
-
m_ColumnID
protected SpreadSheetColumnIndex m_ColumnID
the column to use for grouping the timeseries.
-
m_DataRange
protected SpreadSheetColumnRange m_DataRange
the range of columns to use for the timeseries.
-
m_RegExpTimestamp
protected BaseRegExp m_RegExpTimestamp
the regular expression for timestamp columns.
-
m_RegExpValue
protected BaseRegExp m_RegExpValue
the regular expression for value columns.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Description copied from class:AbstractOptionHandler
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- 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 interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractArrayProvider
-
getQuickInfo
public String getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.- Specified by:
getQuickInfo
in interfaceActor
- Specified by:
getQuickInfo
in interfaceQuickInfoSupporter
- Overrides:
getQuickInfo
in classAbstractActor
- Returns:
- null if no info available, otherwise short string
-
setColumnID
public void setColumnID(SpreadSheetColumnIndex value)
Sets the index/name of the column to use for grouping the timeseries data points.- Parameters:
value
- the index/name
-
getColumnID
public SpreadSheetColumnIndex getColumnID()
Returns the index/name of the column to use for grouping the timeseries data points.- Returns:
- the index/name
-
columnIDTipText
public String columnIDTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setDataRange
public void setDataRange(SpreadSheetColumnRange value)
Sets the range of columns to use for generating the timeseries.- Parameters:
value
- the range
-
getDataRange
public SpreadSheetColumnRange getDataRange()
Returns the range of columns to use for generating the timeseries.- Returns:
- the range
-
dataRangeTipText
public String dataRangeTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setRegExpTimestamp
public void setRegExpTimestamp(BaseRegExp value)
Sets the regular expression for matching the timestamp columns.- Parameters:
value
- the expression
-
getRegExpTimestamp
public BaseRegExp getRegExpTimestamp()
Returns the regular expression for matching the timestamp columns.- Returns:
- the expression
-
regExpTimestampTipText
public String regExpTimestampTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setRegExpValue
public void setRegExpValue(BaseRegExp value)
Sets the regular expression for matching the timestamp columns.- Parameters:
value
- the expression
-
getRegExpValue
public BaseRegExp getRegExpValue()
Returns the regular expression for matching the timestamp columns.- Returns:
- the expression
-
regExpValueTipText
public String regExpValueTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
accepts
public Class[] accepts()
Returns the class that the consumer accepts.- Returns:
- the Class of objects that can be processed
-
getItemClass
protected Class getItemClass()
Returns the base class of the items.- Specified by:
getItemClass
in classAbstractArrayProvider
- Returns:
- the class
-
outputArrayTipText
public String outputArrayTipText()
Returns the tip text for this property.- Specified by:
outputArrayTipText
in interfaceArrayProvider
- Specified by:
outputArrayTipText
in interfaceArrayProvider
- Specified by:
outputArrayTipText
in classAbstractArrayProvider
- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
doExecute
protected String doExecute()
Executes the flow item.- Specified by:
doExecute
in classAbstractActor
- Returns:
- null if everything is fine, otherwise error message
-
-