Name

adams.flow.transformer.SpreadSheetSelectSubset

Synopsis

Allows the user to select a subset of the incoming spreadsheet to be forwarded in the flow.

Additional information

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

Interactive actor information:
- supports interaction in headless mode: false

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	SpreadSheetSelectSubset

  
  
• 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

  
  
• shortTitle
  

  If enabled uses just the name for the title instead of the actor's full name.

  command-line	-short-title <boolean>
  default	false

  
  
• width
  

  The width of the dialog.

  command-line	-width <int>
  default	600
  minimum	1

  
  
• height
  

  The height of the dialog.

  command-line	-height <int>
  default	400
  minimum	1

  
  
• x
  

  The X position of the dialog (>=0: absolute, -1: left, -2: center, -3: right).

  command-line	-x <int>
  default	-2
  minimum	-3

  
  
• y
  

  The Y position of the dialog (>=0: absolute, -1: top, -2: center, -3: bottom).

  command-line	-y <int>
  default	-2
  minimum	-3

  
  
• stopFlowIfCanceled
  

  If enabled, the flow gets stopped in case the user cancels the dialog.

  command-line	-stop-if-canceled <boolean>
  default	false

  
  
• customStopMessage
  

  The custom stop message to use in case a user cancelation stops the flow (default is the full name of the actor)

  command-line	-custom-stop-message <java.lang.String>
  default

  
  
• stopMode
  

  The stop mode to use.

  command-line	-stop-mode <GLOBAL|STOP_RESTRICTOR>
  default	GLOBAL

  
  
• message
  

  The message to prompt the user with; variables get expanded prior to prompting user.

  command-line	-message <java.lang.String>
  default	Please make your selection

  
  
• allowSearch
  

  Whether to allow the user to search the list.

  command-line	-allow-search <boolean>
  default	false

  
  
• multiSelection
  

  Whether to allow the user to select multiple rows or just a single one.

  command-line	-multi-selection <boolean>
  default	true

  
  
• preview
  

  The preview to use for selected rows.

  command-line	-preview <adams.gui.core.spreadsheetpreview.AbstractSpreadSheetPreview>
  default	adams.gui.core.spreadsheetpreview.NullPreview