Name

adams.flow.transformer.SpreadSheetSort

Synopsis

Sorts the rows of the spreadsheet according to the selected column indices and sort order (ascending/descending).

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	SpreadSheetSort

  
  
• 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

  
  
• noCopy
  

  If enabled, no copy of the spreadsheet is created before processing it.

  command-line	-no-copy <boolean>
  default	false

  
  
• sortColumn
  

  The columns to use for sorting.

  command-line	-sort-column <adams.data.spreadsheet.SpreadSheetColumnIndex> [-sort-column ...]
  default	first
  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.

  
  
• sortOrder
  

  The order of sorting for the columns (true = ascending, false = descending).

  command-line	-sort-order <adams.core.base.BaseBoolean> [-sort-order ...]
  default	true

  
  
• unique
  

  If enabled, all duplicate rows (according to the sort setup) get dropped.

  command-line	-unique <boolean>
  default	false