org.apache.nifi.record.path

Interface RecordPath

All Known Implementing Classes:

ArrayIndexPath, ChildFieldPath, Concat, CurrentFieldPath, DescendantFieldPath, FieldName, LiteralValuePath, MultiArrayIndexPath, MultiMapKeyPath, ParentPath, PredicatePath, RecordPathSegment, Replace, ReplaceNull, ReplaceRegex, RootPath, SingularMapKeyPath, Substring, SubstringAfter, SubstringAfterLast, SubstringBefore, SubstringBeforeLast, WildcardChildPath, WildcardDescendantPath, WildcardIndexPath

public interface RecordPath

Method Summary

Modifier and Type	Method and Description
static RecordPath	compile(java.lang.String path) Compiles a RecordPath from the given text
RecordPathResult	evaluate(Record record) Evaluates the RecordPath against the given Record, returning a RecordPathResult that contains a FieldValue for each field that matches
RecordPathResult	evaluate(Record record, FieldValue contextNode) Evaluates a RecordPath against the given context node.
java.lang.String	getPath() Returns the textual representation of the RecordPath
boolean	isAbsolute() Indicates whether the RecordPath is an Absolute Path (starts with a '/' character) or a Relative Path (starts with a '.' character).

Method Detail

getPath

java.lang.String getPath()

Returns the textual representation of the RecordPath

Returns:

the textual representation of the RecordPath

evaluate

RecordPathResult evaluate(Record record)

Evaluates the RecordPath against the given Record, returning a RecordPathResult that contains a FieldValue for each field that matches

Parameters:

record - the Record to evaluate

Returns:

a RecordPathResult that contains a FieldValue for each field that matches

evaluate

RecordPathResult evaluate(Record record,
                          FieldValue contextNode)

Evaluates a RecordPath against the given context node. This allows a RecordPath to be evaluated against a Record via evaluate(Record) and then have a Relative RecordPath evaluated against the results. This method will throw an Exception if this RecordPath is an Absolute RecordPath.

Parameters:

record - the Record to evaluate

contextNode - the context node that represents where in the Record the 'current node' or 'context node' is

Returns:

a RecordPathResult that contains a FieldValue for each field that matches

isAbsolute

boolean isAbsolute()

Indicates whether the RecordPath is an Absolute Path (starts with a '/' character) or a Relative Path (starts with a '.' character).

Returns:

true if the RecordPath is an Absolute Path, false if the RecordPath is a Relative Path

compile

static RecordPath compile(java.lang.String path)
                   throws RecordPathException

Compiles a RecordPath from the given text

Parameters:

path - the textual representation of the RecordPath

Returns:

the compiled RecordPath

Throws:

RecordPathException - if the given text is not a valid RecordPath