org.ojai

Class FieldSegment

java.lang.Object

org.ojai.FieldSegment

All Implemented Interfaces:

Comparable<FieldSegment>, JsonString

Direct Known Subclasses:

FieldSegment.IndexSegment, FieldSegment.NameSegment

@API.Public
 @API.Immutable
public abstract class FieldSegment
extends Object
implements Comparable<FieldSegment>, JsonString

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldSegment.IndexSegment
static class	FieldSegment.NameSegment
protected static class	FieldSegment.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected FieldSegment	child
static Comparator<FieldSegment>	FIELD_SEGMENT_COMPARATOR A Comparator that compares two FieldSegments solely on the segment value itself, excluding their child, if any.
protected int	hash
protected FieldSegment.Type	type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FieldSegment(FieldSegment child)

Method Summary

Modifier and Type	Method and Description
String	asPathString(boolean quote)
abstract FieldSegment	clone()
int	compareTo(FieldSegment other)
boolean	contains(FieldSegment otherSeg) Checks to see if another path is contained in this one.
boolean	equals(Object obj)
FieldSegment	getChild()
FieldSegment.IndexSegment	getIndexSegment()
FieldSegment.NameSegment	getNameSegment()
int	hashCode()
boolean	isArray()
boolean	isIndexed()
boolean	isLastPath()
boolean	isLeaf()
boolean	isMap()
boolean	isNamed()
protected abstract boolean	segmentEquals(FieldSegment other)
protected abstract int	segmentHashCode()
String	toString()
protected abstract StringBuilder	writeSegment(StringBuilder sb, boolean quoted)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojai.JsonString

asJsonString, asJsonString

Field Detail

FIELD_SEGMENT_COMPARATOR

@API.Public
public static final Comparator<FieldSegment> FIELD_SEGMENT_COMPARATOR

A Comparator that compares two FieldSegments solely on the segment value itself, excluding their child, if any.

child

protected final FieldSegment child

type

protected final FieldSegment.Type type

hash

protected int hash

Constructor Detail

FieldSegment

protected FieldSegment(FieldSegment child)

Method Detail

isMap

public boolean isMap()

Returns:

true if the current segment has a child and child.isNamed() is true

isArray

public boolean isArray()

Returns:

true if the current segment has a child and child.isIndexed() is true

isLeaf

public boolean isLeaf()

Returns:

true if the current segment has no child

isIndexed

public boolean isIndexed()

Returns:

true if the current segment is identified by an index

isNamed

public boolean isNamed()

Returns:

true if the current segment is identified by a name

clone

public abstract FieldSegment clone()

Overrides:

clone in class Object

getNameSegment

public FieldSegment.NameSegment getNameSegment()

getIndexSegment

public FieldSegment.IndexSegment getIndexSegment()

writeSegment

protected abstract StringBuilder writeSegment(StringBuilder sb,
                                              boolean quoted)

toString

public final String toString()

Overrides:

toString in class Object

asPathString

public final String asPathString(boolean quote)

isLastPath

public boolean isLastPath()

getChild

public FieldSegment getChild()

segmentHashCode

protected abstract int segmentHashCode()

segmentEquals

protected abstract boolean segmentEquals(FieldSegment other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(FieldSegment other)

Specified by:

compareTo in interface Comparable<FieldSegment>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

contains

public boolean contains(FieldSegment otherSeg)

Checks to see if another path is contained in this one. This is useful for 2 cases. The first is checking if the other is lower down in the tree, below this path. The other is if a path is actually contained above the current one. Examples: [a] . contains([a.b.c]) returns true [a.b.c] . contains([a]) returns true This behavior is used for cases like scanning json in an event based fashion, when we arrive at a node in a complex type, we will know the complete path back to the root. This method can be used to determine if we need the data below. This is true in both the cases where the column requested from the user is below the current node (in which case, we may ignore other nodes further down the tree, while keeping others). This is also the case if the requested path is further up the tree, if we know we are at position a.b.c and a.b was a requested column, we need to scan all of the data at and below the current a.b.c node.

Parameters:

otherSeg - Path segment to check if it is contained below this one

Returns:

is this a match