Name

adams.flow.transformer.SpreadSheetRowToTimeseries

Synopsis

Turns a spreadsheet row into a timeseries.
Columns for timestamps and values are extracted using the regular expressions, the timestamp columns are optional.

Additional information

Flow input/output:
- input: adams.data.spreadsheet.SpreadSheet
- output: adams.data.timeseries.Timeseries

Options

• loggingLevel
  

  The logging level for outputting errors and debugging output.

  command-line	-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST>
  default	WARNING
  min-user-mode	Expert

  
  
• name
  

  The name of the actor.

  command-line	-name <java.lang.String>
  default	SpreadSheetRowToTimeseries

  
  
• annotations
  

  The annotations to attach to this actor.

  command-line	-annotation <adams.core.base.BaseAnnotation>
  default

  
  
• skip
  

  If set to true, transformation is skipped and the input token is just forwarded as it is.

  command-line	-skip <boolean>
  default	false

  
  
• stopFlowOnError
  

  If set to true, the flow execution at this level gets stopped in case this actor encounters an error; the error gets propagated; useful for critical actors.

  command-line	-stop-flow-on-error <boolean>
  default	false
  min-user-mode	Expert

  
  
• silent
  

  If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well.

  command-line	-silent <boolean>
  default	false
  min-user-mode	Expert

  
  
• outputArray
  

  If enabled, outputs an array of Timeseries objects rather than one-by-one.

  command-line	-output-array <boolean>
  default	false

  
  
• columnID
  

  The (optional) column storing the ID for a timeseries.

  command-line	-column-id <adams.data.spreadsheet.SpreadSheetColumnIndex>
  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; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.

  
  
• dataRange
  

  The range of columns to use for generating the timeseries.

  command-line	-data-range <adams.data.spreadsheet.SpreadSheetColumnRange>
  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; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.

  
  
• regExpTimestamp
  

  The regular expression for matching the columns that contain the timestamps for the data points.

  command-line	-regexp-timestamp <adams.core.base.BaseRegExp>
  default	Timestamp-.*
  more	https://docs.oracle.com/javase/tutorial/essential/regex/
  	https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html

  
  
• regExpValue
  

  The regular expression for matching the columns that contain the values of the data points.

  command-line	-regexp-value <adams.core.base.BaseRegExp>
  default	Value-.*
  more	https://docs.oracle.com/javase/tutorial/essential/regex/
  	https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html