Name

adams.flow.transformer.StringCut

Synopsis

Cuts out a part of a string. The cut can be either specified as a fixed character position or as a field from delimited columns.

Additional information

Flow input/output:
- input: java.lang.String, java.lang.String[]
- output: java.lang.String, java.lang.String[]

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	StringCut

  
  
• 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

  
  
• type
  

  Determines what type of cut to perform.

  command-line	-type <FIELD_DELIMITED|CHARACTER_POSITIONS>
  default	FIELD_DELIMITED

  
  
• fieldDelimiter
  

  The field delimiter to use; \t gets automatically converted into its character counterpart.

  command-line	-field-delimiter <java.lang.String>
  default	\\t

  
  
• fieldIndex
  

  The 1-based index of the field to cut from the string(s).

  command-line	-field-index <adams.core.Index>
  default	1
  example	An index is a number starting with 1; the following placeholders can be used as well: first, second, third, last_2, last_1, last

  
  
• characterStartPos
  

  The position of the first character to include in case fixed character positions are used.

  command-line	-char-start-pos <adams.core.Index>
  default	first
  example	An index is a number starting with 1; the following placeholders can be used as well: first, second, third, last_2, last_1, last

  
  
• characterEndPos
  

  The position of the last character to include in case fixed character positions are used.

  command-line	-char-end-pos <adams.core.Index>
  default	last
  example	An index is a number starting with 1; the following placeholders can be used as well: first, second, third, last_2, last_1, last