Name

adams.flow.transformer.SpreadSheetAggregate

Synopsis

Aggregates rows (min, max, avg, etc) in a spreadsheet using key columns.
All numeric columns in the specified aggregrate range (excluding the key columns) get aggregated. For each of the specified aggregates a new column is generated.
If no key column(s) provided, the complete spreadsheet is used for aggregation.
Missing cells get ignored.
COUNT doesn't need any numeric columns (leave 'aggregateColumns' empty if there are no numeric columns).
Note: A single non-numeric cell makes a column a non-numeric one!

Additional information

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

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	SpreadSheetAggregate

  
  
• 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

  
  
• keyColumns
  

  The columns to use as keys for identifying rows in the spreadsheets; if left empty, all rows are used.

  command-line	-key-columns <adams.data.spreadsheet.SpreadSheetColumnRange>
  default
  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.

  
  
• aggregateColumns
  

  The columns to aggregate (only numeric ones will be used).

  command-line	-aggregate-columns <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.

  
  
• aggregates
  

  The aggregates to calculate and introduce as columns.

  command-line	-aggregate <COUNT|SUM|MIN|MAX|RANGE|AVERAGE|MEDIAN|STDEV|STDEVP|INTERQUARTILE|QUARTILE25|QUARTILE75> [-aggregate ...]
  default	SUM