adams.flow.transformer.SpreadSheetDifference

Name

adams.flow.transformer.SpreadSheetDifference

Synopsis

Computes the difference of the numeric cells between two spreadsheets.
The values of the second spreadsheet are subtracted from the first one.
If no 'key' columns are defined, the current order of rows is used for comparison.

Additional information

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

adams.flow.transformer.SpreadSheetDifference is deprecated!
Use instead: adams.flow.transformer.multispreadsheetoperation.Difference

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 SpreadSheetDifference

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 empty the row index is used instead; 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.

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.

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

command-line	`-name <java.lang.String>`
default	`SpreadSheetDifference`

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

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

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

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.