Description:

WARNING: This has been deprecated and will be removed in 0.2.0. Use ExtractText instead.

Tags:

deprecated

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

NameDefault ValueAllowable ValuesDescription
Character SetUTF-8The Character Set in which the file is encoded
Maximum Buffer Size1 MBSpecifies the maximum amount of data to buffer (per file) in order to apply the regular expressions. Files larger than the specified maximum will not be fully evaluated.
Enable Canonical Equivalencefalse
  • true
  • false
Indicates that two characters match only when their full canonical decompositions match.
Enable Case-insensitive Matchingfalse
  • true
  • false
Indicates that two characters match even if they are in a different case. Can also be specified via the embeded flag (?i).
Permit Whitespace and Comments in Patternfalse
  • true
  • false
In this mode, whitespace is ignored, and embedded comments starting with # are ignored until the end of a line. Can also be specified via the embeded flag (?x).
Enable DOTALL Modefalse
  • true
  • false
Indicates that the expression '.' should match any character, including a line terminator. Can also be specified via the embeded flag (?s).
Enable Literal Parsing of the Patternfalse
  • true
  • false
Indicates that Metacharacters and escape characters should be given no special meaning.
Enable Multiline Modefalse
  • true
  • false
Indicates that '^' and '$' should match just after and just before a line terminator or end of sequence, instead of only the begining or end of the entire input. Can also be specified via the embeded flag (?m).
Enable Unicode-aware Case Foldingfalse
  • true
  • false
When used with 'Enable Case-insensitive Matching', matches in a manner consistent with the Unicode Standard. Can also be specified via the embeded flag (?u).
Enable Unicode Predefined Character Classesfalse
  • true
  • false
Specifies conformance with the Unicode Technical Standard #18: Unicode Regular Expression Annex C: Compatibility Properties. Can also be specified via the embeded flag (?U).
Enable Unix Lines Modefalse
  • true
  • false
Indicates that only the ' ' line terminator is recognized int the behavior of '.', '^', and '$'. Can also be specified via the embeded flag (?d).

Dynamic Properties:

Dynamic Properties allow the user to specify both the name and value of a property.

NameValueDescription
A FlowFile attributeA regular expression with exactly one capturing groupWill update the specified FlowFile attribute with the group captured by the regular expression

Relationships:

NameDescription
matchedFlowFiles are routed to this relationship when the Regular Expression is successfully evaluated and the FlowFile is modified as a result
unmatchedFlowFiles are routed to this relationship when no provided Regular Expression matches the content of the FlowFile

Reads Attributes:

None specified.

Writes Attributes:

None specified.

See Also:

ExtractText