org.ojai

Class FieldPath

java.lang.Object

org.ojai.FieldPath

All Implemented Interfaces:

Comparable<FieldPath>, Iterable<FieldSegment>, Expression, JsonString

@API.Public
 @API.Immutable
public final class FieldPath
extends Object
implements Comparable<FieldPath>, Iterable<FieldSegment>, Expression

Immutable class for representing a field path.

Field Summary

Fields

Modifier and Type	Field and Description
static FieldPath	EMPTY

Constructor Summary

Constructors

Constructor and Description
FieldPath(FieldSegment.NameSegment root) For Antlr parser's use only.

Method Summary

Modifier and Type	Method and Description
String	asJsonString()
String	asJsonString(JsonOptions options)
String	asPathString() Returns the String representation of this field path, quoting only those name segments which were parsed from a quoted identifier.
String	asPathString(boolean quote)
FieldPath	cloneAfterAncestor(FieldPath ancestor)
FieldPath	cloneWithNewChild(FieldSegment childSegment)
FieldPath	cloneWithNewChild(int index)
FieldPath	cloneWithNewChild(String childSegment)
FieldPath	cloneWithNewParent(String parentSegment)
int	compareTo(FieldPath other) Compares two FieldPath segment by segment from left to right.
boolean	equals(Object obj)
String	getName()
FieldSegment	getRootSegment()
int	hashCode()
boolean	isAtOrAbove(FieldPath other)
boolean	isAtOrBelow(FieldPath other)
Iterator<FieldSegment>	iterator()
static FieldPath	parseFrom(String fieldPath) Use this method to translate a String into FieldPath.
FieldSegment	segmentAfterAncestor(FieldPath ancestor)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

EMPTY

public static final FieldPath EMPTY

Constructor Detail

FieldPath

@API.Internal
public FieldPath(FieldSegment.NameSegment root)

For Antlr parser's use only.

Method Detail

parseFrom

public static FieldPath parseFrom(@API.NonNullable
                                  String fieldPath)

Use this method to translate a String into FieldPath.

Parameters:

fieldPath - the String to parse

Returns:

an immutable instance of FieldPath parsed from the input string

Throws:

NullPointerException - if the input string is null

IllegalArgumentException - if the input string has syntax error

iterator

public Iterator<FieldSegment> iterator()

Specified by:

iterator in interface Iterable<FieldSegment>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(FieldPath other)

Compares two FieldPath segment by segment from left to right. Named segments are compared lexicographically while indexed segments are compared based on their index value. For same position in a FieldPath, a name segment is considered greater than the indexed segment.

Specified by:

compareTo in interface Comparable<FieldPath>

Returns:

the value 0 if the specified FieldPath is equal to this FieldPath; a value less than 0 if this FieldPath is smaller than the specified FieldPath; and a value greater than 0 if this FieldPath is greater than the specified FieldPath

asPathString

public String asPathString()

Returns the String representation of this field path, quoting only those name segments which were parsed from a quoted identifier.

Returns:

The String representation of this FieldPath.

asPathString

public String asPathString(boolean quote)

getRootSegment

public FieldSegment getRootSegment()

cloneWithNewParent

public FieldPath cloneWithNewParent(String parentSegment)

Returns:

a FieldPath with the specified name segment as the parent of the this FieldPath

cloneWithNewChild

public FieldPath cloneWithNewChild(String childSegment)

Returns:

a FieldPath with the specified name segment added as the child of the leaf of this FieldPath

cloneWithNewChild

public FieldPath cloneWithNewChild(int index)

Returns:

a FieldPath with the specified index segment added as the child of the leaf of this FieldPath

cloneWithNewChild

public FieldPath cloneWithNewChild(FieldSegment childSegment)

Returns:

a FieldPath with specified added as the child of the leaf of this FieldPath

cloneAfterAncestor

public FieldPath cloneAfterAncestor(FieldPath ancestor)

Returns:

a sub-segment of this FieldPath starting after the specified ancestor. For example, if the current FieldPath is "a.b.c.d" and the specified ancestor is "a.b", will return "c.d".
If the ancestor is same as this, will return EMPTY. If the ancestor is not an actual ancestor, will return null.

isAtOrBelow

public boolean isAtOrBelow(FieldPath other)

Returns:

true if the other FieldPath is same or a child of this

isAtOrAbove

public boolean isAtOrAbove(FieldPath other)

Returns:

true if the other FieldPath is same or parent of this

segmentAfterAncestor

public FieldSegment segmentAfterAncestor(FieldPath ancestor)

Returns:

the root segment of the child if FieldPath contains ancestor entirely, returns if field and ancestor are identical field paths or returns if field and ancestor have a difference of at least one field or its type.

asJsonString

public String asJsonString()

Specified by:

asJsonString in interface JsonString

Returns:

this OJAI object serialized as JSON string using the default options

asJsonString

public String asJsonString(JsonOptions options)

Specified by:

asJsonString in interface JsonString

Returns:

this OJAI object serialized as JSON string using the specified options

getName

public String getName()

Specified by:

getName in interface Expression

Returns:

name of this expression