com.mapr.db.ojai

Class DBDocumentReader

java.lang.Object

com.mapr.db.ojai.DBDocumentReader

All Implemented Interfaces:

DBDocumentReaderBase, org.ojai.DocumentReader

@API.Internal
public class DBDocumentReader
extends Object
implements DBDocumentReaderBase

Nested Class Summary

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

org.ojai.DocumentReader.EventType

Constructor Summary

Constructors

Constructor and Description
DBDocumentReader(Map<Integer,ByteBuffer> data, Map<org.ojai.FieldPath,Integer> pathMap, KeyValue _id, boolean excludeId)

Method Summary

Methods

Modifier and Type	Method and Description
int	getArrayIndex()
ByteBuffer	getBinary()
boolean	getBoolean()
byte	getByte()
ControlInfo	getControlInfo() Retrieves control information, such as create/delete/append, associated with the current key-value pair being parsed.
org.ojai.types.ODate	getDate()
int	getDateInt()
BigDecimal	getDecimal()
int	getDecimalPrecision() Returns the precision of 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()
org.ojai.Value	getId()
int	getInt()
org.ojai.types.OInterval	getInterval()
int	getIntervalDays()
long	getIntervalMillis()
long	getLong()
short	getShort()
String	getString()
org.ojai.types.OTime	getTime()
int	getTimeInt()
org.ojai.types.OTimestamp	getTimestamp()
long	getTimestampLong()
boolean	inMap()
org.ojai.DocumentReader.EventType	next() Moves the RecordReader to the next node and returns the node type as EventType.

Methods inherited from class java.lang.Object

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

Constructor Detail

DBDocumentReader

public DBDocumentReader(Map<Integer,ByteBuffer> data,
                Map<org.ojai.FieldPath,Integer> pathMap,
                KeyValue _id,
                boolean excludeId)

Method Detail

next

public org.ojai.DocumentReader.EventType next()

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

Specified by:

next in interface org.ojai.DocumentReader

Returns:

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

getFieldName

public String getFieldName()

Specified by:

getFieldName in interface org.ojai.DocumentReader

Returns:

the name of the current field

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not FIELD_NAME

getByte

public byte getByte()

Specified by:

getByte in interface org.ojai.DocumentReader

Returns:

the byte value of the current node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not BYTE

getShort

public short getShort()

Specified by:

getShort in interface org.ojai.DocumentReader

Returns:

the byte value of the current node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not SHORT

getLong

public long getLong()

Specified by:

getLong in interface org.ojai.DocumentReader

Returns:

the long value of the current node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not LONG

getInt

public int getInt()

Specified by:

getInt in interface org.ojai.DocumentReader

Returns:

the int value of the current node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not INT

getFloat

public float getFloat()

Specified by:

getFloat in interface org.ojai.DocumentReader

Returns:

the float value of the current node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not FLOAT

getDouble

public double getDouble()

Specified by:

getDouble in interface org.ojai.DocumentReader

Returns:

the double value of the current node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not DOUBLE

getDecimal

public BigDecimal getDecimal()

Specified by:

getDecimal in interface org.ojai.DocumentReader

Returns:

the BigDecimal value of the current node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not DECIMAL

getDecimalPrecision

public int getDecimalPrecision()

Returns the precision of 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 org.ojai.DocumentReader

Returns:

the precision of current DECIMAL node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not DECIMAL

getDecimalScale

public int getDecimalScale()

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 org.ojai.DocumentReader

Returns:

the scale of current DECIMAL node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not DECIMAL

getDecimalValueAsInt

public int getDecimalValueAsInt()

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

Specified by:

getDecimalValueAsInt in interface org.ojai.DocumentReader

Returns:

the unscaled value of current DECIMAL node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not DECIMAL

org.w3c.dom.ranges.RangeException - if the precision of the decimal number is greater than 9

getDecimalValueAsLong

public long getDecimalValueAsLong()

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

Specified by:

getDecimalValueAsLong in interface org.ojai.DocumentReader

Returns:

the unscaled value of current DECIMAL node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not DECIMAL

org.w3c.dom.ranges.RangeException - if the precision of the decimal number is greater than 18

getDecimalValueAsBytes

public ByteBuffer getDecimalValueAsBytes()

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 org.ojai.DocumentReader

Returns:

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

getBoolean

public boolean getBoolean()

Specified by:

getBoolean in interface org.ojai.DocumentReader

Returns:

the boolean value of the current node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not BOOLEAN

getString

public String getString()

Specified by:

getString in interface org.ojai.DocumentReader

Returns:

the String value of the current node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not STRING

getTimestampLong

public long getTimestampLong()

Specified by:

getTimestampLong in interface org.ojai.DocumentReader

Returns:

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

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not TIMESTAMP

getTimestamp

public org.ojai.types.OTimestamp getTimestamp()

Specified by:

getTimestamp in interface org.ojai.DocumentReader

Returns:

the Timestamp value of the current node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not TIMESTAMP

getDateInt

public int getDateInt()

Specified by:

getDateInt in interface org.ojai.DocumentReader

Returns:

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

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not DATE

getDate

public org.ojai.types.ODate getDate()

Specified by:

getDate in interface org.ojai.DocumentReader

Returns:

the Date value of the current node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not DATE

getTimeInt

public int getTimeInt()

Specified by:

getTimeInt in interface org.ojai.DocumentReader

Returns:

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

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not TIME

getTime

public org.ojai.types.OTime getTime()

Specified by:

getTime in interface org.ojai.DocumentReader

Returns:

the Time value of the current node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not TIME

getInterval

public org.ojai.types.OInterval getInterval()

Specified by:

getInterval in interface org.ojai.DocumentReader

Returns:

the Interval value of the current node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not INTERVAL

getIntervalDays

public int getIntervalDays()

Specified by:

getIntervalDays in interface org.ojai.DocumentReader

getIntervalMillis

public long getIntervalMillis()

Specified by:

getIntervalMillis in interface org.ojai.DocumentReader

getBinary

public ByteBuffer getBinary()

Specified by:

getBinary in interface org.ojai.DocumentReader

Returns:

the ByteBuffer value of the current node

Throws:

org.ojai.exceptions.TypeException - if the current EventType is not BINARY

getControlInfo

public ControlInfo getControlInfo()

Description copied from interface: DBDocumentReaderBase

Retrieves control information, such as create/delete/append, associated with the current key-value pair being parsed.

Specified by:

getControlInfo in interface DBDocumentReaderBase

Returns:

the ControlInfo for the current key-value pair

getId

public org.ojai.Value getId()

Specified by:

getId in interface DBDocumentReaderBase

Returns:

The _id of the DBDocument of this DocumentReader.

inMap

public boolean inMap()

Specified by:

inMap in interface org.ojai.DocumentReader

getArrayIndex

public int getArrayIndex()

Specified by:

getArrayIndex in interface org.ojai.DocumentReader