Name

adams.flow.control.Inspect

Synopsis

Allows the user to inspect tokens with the specified viewer.
Inspection can be done interactively, allowing the user to drop tokens, or non-interactively, with the viewer updating whenever a token passes through.
Of course, this actor should only be used during development for debugging purposes as can slow down the execution significantly depending on how expensive the view generation is.

Additional information

Flow input/output:
- input: java.lang.Object
- output: java.lang.Object

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	Inspect

  
  
• 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	800
  minimum	1

  
  
• height
  

  The height of the dialog.

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

  
  
• x
  

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

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

  
  
• y
  

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

  command-line	-y <int>
  default	-1
  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

  
  
• panelProvider
  

  The actor for generating the viewer.

  command-line	-provider <adams.flow.sink.DisplayPanelProvider>
  default	adams.flow.sink.Display -display-type adams.flow.core.displaytype.Default -writer adams.data.io.output.NullWriter

  
  
• labelSkip
  

  The label to use for the skip button; let '_' precede the character that should trigger the button via 'Alt+<char>' (Windows/Linux).

  command-line	-label-skip <java.lang.String>
  default	_Skip

  
  
• labelAccept
  

  The label to use for the accept button; let '_' precede the character that should trigger the button via 'Alt+<char>' (Windows/Linux).

  command-line	-label-accept <java.lang.String>
  default	_Accept

  
  
• closeDialog
  

  If enabled, the dialog gets closed after the skip or accept button has been clicked.

  command-line	-close-dialog <boolean>
  default	false