CountText

CountText 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: Counts various metrics on incoming text. The requested results will be recorded as attributes. The resulting flowfile will not have its content modified.
Tags: character, count, line, text, word
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Call Immediate Adjustment
If true, the counter will be updated immediately, without regard to whether the ProcessSession is commit or rolled back;otherwise, the counter will be incremented only if and when the ProcessSession is committed.
Display Name

Call Immediate Adjustment

Description

If true, the counter will be updated immediately, without regard to whether the ProcessSession is commit or rolled back;otherwise, the counter will be incremented only if and when the ProcessSession is committed.

API Name

ajust-immediately

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Character Encoding
Specifies a character encoding to use.
Display Name

Character Encoding

Description

Specifies a character encoding to use.

API Name

character-encoding

Default Value

UTF-8

Allowable Values
- ISO-8859-1
- UTF-8
- UTF-16
- UTF-16LE
- UTF-16BE
- US-ASCII
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Split Words on Symbols
If enabled, the word count will identify strings separated by common logical delimiters [ _ - . ] as independent words (ex. split-words-on-symbols = 4 words).
Display Name

Split Words on Symbols

Description

If enabled, the word count will identify strings separated by common logical delimiters [ _ - . ] as independent words (ex. split-words-on-symbols = 4 words).

API Name

split-words-on-symbols

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Count Characters
If enabled, will count the number of characters (including whitespace and symbols, but not including newlines and carriage returns) present in the incoming text.
Display Name

Count Characters

Description

If enabled, will count the number of characters (including whitespace and symbols, but not including newlines and carriage returns) present in the incoming text.

API Name

text-character-count

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Count Lines
If enabled, will count the number of lines present in the incoming text.
Display Name

Count Lines

Description

If enabled, will count the number of lines present in the incoming text.

API Name

text-line-count

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Count Non-Empty Lines
If enabled, will count the number of lines that contain a non-whitespace character present in the incoming text.
Display Name

Count Non-Empty Lines

Description

If enabled, will count the number of lines that contain a non-whitespace character present in the incoming text.

API Name

text-line-nonempty-count

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Count Words
If enabled, will count the number of words (alphanumeric character groups bounded by whitespace) present in the incoming text. Common logical delimiters [_-.] do not bound a word unless 'Split Words on Symbols' is true.
Display Name

Count Words

Description

If enabled, will count the number of words (alphanumeric character groups bounded by whitespace) present in the incoming text. Common logical delimiters [_-.] do not bound a word unless 'Split Words on Symbols' is true.

API Name

text-word-count

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Relationships

Name	Description
failure	If the flowfile text cannot be counted for some reason, the original file will be routed to this destination and nothing will be routed elsewhere
success	The flowfile contains the original content with one or more attributes added containing the respective counts

Writes Attributes

Name	Description
text.line.count	The number of lines of text present in the FlowFile content
text.line.nonempty.count	The number of lines of text (with at least one non-whitespace character) present in the original FlowFile
text.word.count	The number of words present in the original FlowFile
text.character.count	The number of characters (given the specified character encoding) present in the original FlowFile