org.ojai.util

Class DocumentReaderWithProjection

java.lang.Object

org.ojai.util.DocumentReaderWithProjection

All Implemented Interfaces:

DocumentReader

@API.Public
public class DocumentReaderWithProjection
extends Object
implements DocumentReader

An implementation of DocumentReader interface which can be used to project a sub-set of fields

Nested Class Summary

Nested classes/interfaces inherited from interface org.ojai.DocumentReader

DocumentReader.EventType

Constructor Summary

Constructors

Constructor and Description
DocumentReaderWithProjection(DocumentReader reader, FieldProjector projection)

Method Summary

Modifier and Type	Method and Description
int	getArrayIndex()
ByteBuffer	getBinary()
boolean	getBoolean()
byte	getByte()
DocumentReader.EventType	getCurrentEvent()
ODate	getDate()
int	getDateInt()
BigDecimal	getDecimal()
int	getDecimalPrecision() Returns the precision of the current DECIMAL node.
int	getDecimalScale() Returns the scale of the current DECIMAL node.
ByteBuffer	getDecimalValueAsBytes() Returns a ByteBuffer containing the two's complement representation of the current DECIMAL node.
int	getDecimalValueAsInt() Returns an int whose value is the unscaled value of this DECIMAL.
long	getDecimalValueAsLong() Returns a long whose value is the unscaled value of this DECIMAL.
double	getDouble()
String	getFieldName()
float	getFloat()
int	getInt()
OInterval	getInterval()
int	getIntervalDays()
long	getIntervalMillis()
long	getLong()
short	getShort()
String	getString()
OTime	getTime()
int	getTimeInt()
OTimestamp	getTimestamp()
long	getTimestampLong()
boolean	inMap()
DocumentReader.EventType	next() Moves the DocumentReader to the next node and returns the node type as EventType.
DocumentReader	skipChildren() When called after DocumentReader.EventType.START_MAP or DocumentReader.EventType.START_ARRAY event, moves this DocumentReader to the corresponding DocumentReader.EventType.END_MAP or DocumentReader.EventType.END_ARRAY, skipping the entire sub-tree.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentReaderWithProjection

public DocumentReaderWithProjection(@API.NonNullable
                                    DocumentReader reader,
                                    @API.NonNullable
                                    FieldProjector projection)

Method Detail

next

public DocumentReader.EventType next()

Description copied from interface: DocumentReader

Moves the DocumentReader to the next node and returns the node type as EventType.

Specified by:

next in interface DocumentReader

Returns:

the EventType for the current node or null if the reader is past the end of the document

skipChildren

public DocumentReader skipChildren()

Description copied from interface: DocumentReader

When called after DocumentReader.EventType.START_MAP or DocumentReader.EventType.START_ARRAY event, moves this DocumentReader to the corresponding DocumentReader.EventType.END_MAP or DocumentReader.EventType.END_ARRAY, skipping the entire sub-tree.

For all other events, this is a NO-OP.

Specified by:

skipChildren in interface DocumentReader

Returns:

this for chaining

inMap

public boolean inMap()

Specified by:

inMap in interface DocumentReader

Returns:

true while traversing a Map, false if traversing an Array

getFieldName

public String getFieldName()

Specified by:

getFieldName in interface DocumentReader

Returns:

the name of the current field, null for the top level Document

getArrayIndex

public int getArrayIndex()

Specified by:

getArrayIndex in interface DocumentReader

Returns:

the index of the current element in the Array

getByte

public byte getByte()

Specified by:

getByte in interface DocumentReader

Returns:

the byte value of the current node

getShort

public short getShort()

Specified by:

getShort in interface DocumentReader

Returns:

the byte value of the current node

getInt

public int getInt()

Specified by:

getInt in interface DocumentReader

Returns:

the int value of the current node

getLong

public long getLong()

Specified by:

getLong in interface DocumentReader

Returns:

the long value of the current node

getFloat

public float getFloat()

Specified by:

getFloat in interface DocumentReader

Returns:

the float value of the current node

getDouble

public double getDouble()

Specified by:

getDouble in interface DocumentReader

Returns:

the double value of the current node

getDecimal

public BigDecimal getDecimal()

Specified by:

getDecimal in interface DocumentReader

Returns:

the BigDecimal value of the current node

getDecimalPrecision

public int getDecimalPrecision()

Description copied from interface: DocumentReader

Returns the precision of the current DECIMAL node. (The precision is the number of digits in the unscaled value.)

The precision of a zero value is 1.

Specified by:

getDecimalPrecision in interface DocumentReader

Returns:

the precision of current DECIMAL node

getDecimalScale

public int getDecimalScale()

Description copied from interface: DocumentReader

Returns the scale of the current DECIMAL node. If the returned value is zero or positive, the scale is the number of digits to the right of the decimal point. If negative, the unscaled value of the number is multiplied by ten to the power of the negation of the scale. For example, a scale of -3 means the unscaled value is multiplied by 1000.

Specified by:

getDecimalScale in interface DocumentReader

Returns:

the scale of current DECIMAL node

getDecimalValueAsInt

public int getDecimalValueAsInt()

Description copied from interface: DocumentReader

Returns an int whose value is the unscaled value of this DECIMAL.

Specified by:

getDecimalValueAsInt in interface DocumentReader

Returns:

the unscaled value of current DECIMAL node

getDecimalValueAsLong

public long getDecimalValueAsLong()

Description copied from interface: DocumentReader

Returns a long whose value is the unscaled value of this DECIMAL.

Specified by:

getDecimalValueAsLong in interface DocumentReader

Returns:

the unscaled value of current DECIMAL node

getDecimalValueAsBytes

public ByteBuffer getDecimalValueAsBytes()

Description copied from interface: DocumentReader

Returns a ByteBuffer containing the two's complement representation of the current DECIMAL node. The byte array will be in big-endian byte order: the most significant byte is in the zeroth element. The array will contain the minimum number of bytes required to represent this DECIMAL, including one sign bit.

Specified by:

getDecimalValueAsBytes in interface DocumentReader

Returns:

a byte array containing the two's complement representation of current DECIMAL node

getBoolean

public boolean getBoolean()

Specified by:

getBoolean in interface DocumentReader

Returns:

the boolean value of the current node

getString

public String getString()

Specified by:

getString in interface DocumentReader

Returns:

the String value of the current node

getTimestampLong

public long getTimestampLong()

Specified by:

getTimestampLong in interface DocumentReader

Returns:

the Timestamp value of the current node as a long representing the number of milliseconds since epoch

getTimestamp

public OTimestamp getTimestamp()

Specified by:

getTimestamp in interface DocumentReader

Returns:

the Timestamp value of the current node

getDateInt

public int getDateInt()

Specified by:

getDateInt in interface DocumentReader

Returns:

the Date value of the current node as an int representing the number of DAYS since epoch

getDate

public ODate getDate()

Specified by:

getDate in interface DocumentReader

Returns:

the Date value of the current node

getTimeInt

public int getTimeInt()

Specified by:

getTimeInt in interface DocumentReader

Returns:

the Time value of the current node as an int representing the number of milliseconds since midnight.

getTime

public OTime getTime()

Specified by:

getTime in interface DocumentReader

Returns:

the Time value of the current node

getInterval

public OInterval getInterval()

Specified by:

getInterval in interface DocumentReader

Returns:

the Interval value of the current node

getIntervalDays

public int getIntervalDays()

Specified by:

getIntervalDays in interface DocumentReader

getIntervalMillis

public long getIntervalMillis()

Specified by:

getIntervalMillis in interface DocumentReader

getBinary

public ByteBuffer getBinary()

Specified by:

getBinary in interface DocumentReader

Returns:

the ByteBuffer value of the current node

getCurrentEvent

public DocumentReader.EventType getCurrentEvent()

Specified by:

getCurrentEvent in interface DocumentReader

Returns:

the event emitted by the last call to DocumentReader.next()