org.apache.nifi.record.path.paths

Class RecordPathSegment

java.lang.Object

org.apache.nifi.record.path.paths.RecordPathSegment

All Implemented Interfaces:

RecordPath

Direct Known Subclasses:

ArrayIndexPath, Base64Decode, Base64Encode, ChildFieldPath, Coalesce, Concat, Count, CurrentFieldPath, DescendantFieldPath, EscapeJson, FieldName, FilterFunction, Format, Hash, LiteralValuePath, MultiArrayIndexPath, MultiMapKeyPath, NoArgStringFunction, Padding, ParentPath, PredicatePath, Replace, ReplaceNull, ReplaceRegex, RootPath, SingularMapKeyPath, Substring, SubstringAfter, SubstringAfterLast, SubstringBefore, SubstringBeforeLast, ToBytes, ToDate, ToString, UnescapeJson, UUID5, WildcardChildPath, WildcardDescendantPath, WildcardIndexPath

public abstract class RecordPathSegment
extends Object
implements RecordPath

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	absolute
private RecordPathSegment	parentPath
private String	path

Constructor Summary

Constructors

Constructor and Description
RecordPathSegment(String path, RecordPathSegment parentPath, boolean absolute)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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.
abstract Stream<FieldValue>	evaluate(RecordPathEvaluationContext context)
(package private) RecordPathSegment	getParentPath()
String	getPath() Returns the textual representation of the RecordPath
int	hashCode()
boolean	isAbsolute() Indicates whether the RecordPath is an Absolute Path (starts with a '/' character) or a Relative Path (starts with a '.' character).
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.record.path.RecordPath

compile

Field Detail

path

private final String path

parentPath

private final RecordPathSegment parentPath

absolute

private final boolean absolute

Constructor Detail

RecordPathSegment

public RecordPathSegment(String path,
                         RecordPathSegment parentPath,
                         boolean absolute)

Method Detail

getPath

public String getPath()

Description copied from interface: RecordPath

Returns the textual representation of the RecordPath

Specified by:

getPath in interface RecordPath

Returns:

the textual representation of the RecordPath

getParentPath

RecordPathSegment getParentPath()

toString

public String toString()

Overrides:

toString in class Object

isAbsolute

public boolean isAbsolute()

Description copied from interface: RecordPath

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

Specified by:

isAbsolute in interface RecordPath

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

evaluate

public final RecordPathResult evaluate(Record record)

Description copied from interface: RecordPath

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

Specified by:

evaluate in interface RecordPath

Parameters:

record - the Record to evaluate

Returns:

a RecordPathResult that contains a FieldValue for each field that matches

evaluate

public final RecordPathResult evaluate(Record record,
                                       FieldValue contextNode)

Description copied from interface: RecordPath

Evaluates a RecordPath against the given context node. This allows a RecordPath to be evaluated against a Record via RecordPath.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.

Specified by:

evaluate in interface 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

evaluate

public abstract Stream<FieldValue> evaluate(RecordPathEvaluationContext context)