DocumentReader (OJAI Core Library for Java v. 3.0)

All Known Implementing Classes:

DocumentReaderBase, DocumentReaderWithProjection
```
@API.Public
 @API.NotThreadSafe
public interface DocumentReader
```

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class DocumentReader.EventType

Nested Classes
Modifier and Type	Interface and Description
`static class`	`DocumentReader.EventType`

Method Summary

All Methods Instance Methods Abstract Methods
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.

- Method Detail
  - next
```
DocumentReader.EventType next()
```
    Moves the DocumentReader to the next node and returns the node type as EventType.
    
    Returns:
    
    the EventType for the current node or null if the reader is past the end of the document
    
    Throws:
    
    DecodingException - if the document is malformed or incomplete.
  - getCurrentEvent
```
DocumentReader.EventType getCurrentEvent()
```
    Returns:
    
    the event emitted by the last call to next()
  - skipChildren
```
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.
    For all other events, this is a NO-OP.
    
    Returns:
    
    this for chaining
  - inMap
```
boolean inMap()
```
    Returns:
    
    true while traversing a Map, false if traversing an Array
  - getFieldName
```
String getFieldName()
```
    Returns:
    
    the name of the current field, null for the top level Document
    
    Throws:
    
    IllegalStateException - if the reader is not traversing a Map
  - getArrayIndex
```
int getArrayIndex()
```
    Returns:
    
    the index of the current element in the Array
    
    Throws:
    
    IllegalStateException - if the reader is not traversing an Array
  - getByte
```
byte getByte()
```
    Returns:
    
    the byte value of the current node
    
    Throws:
    
    TypeException - if the current EventType is not BYTE
  - getShort
```
short getShort()
```
    Returns:
    
    the byte value of the current node
    
    Throws:
    
    TypeException - if the current EventType is not SHORT.
  - getInt
```
int getInt()
```
    Returns:
    
    the int value of the current node
    
    Throws:
    
    TypeException - if the current EventType is not INT
  - getLong
```
long getLong()
```
    Returns:
    
    the long value of the current node
    
    Throws:
    
    TypeException - if the current EventType is not LONG
  - getFloat
```
float getFloat()
```
    Returns:
    
    the float value of the current node
    
    Throws:
    
    TypeException - if the current EventType is not FLOAT
  - getDouble
```
double getDouble()
```
    Returns:
    
    the double value of the current node
    
    Throws:
    
    TypeException - if the current EventType is not DOUBLE
  - getDecimal
```
BigDecimal getDecimal()
```
    Returns:
    
    the BigDecimal value of the current node
    
    Throws:
    
    TypeException - if the current EventType is not DECIMAL
  - getDecimalPrecision
```
int getDecimalPrecision()
```
    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.
    
    Returns:
    
    the precision of current DECIMAL node
    
    Throws:
    
    TypeException - if the current EventType is not DECIMAL
  - getDecimalScale
```
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.
    
    Returns:
    
    the scale of current DECIMAL node
    
    Throws:
    
    TypeException - if the current EventType is not DECIMAL
  - getDecimalValueAsInt
```
int getDecimalValueAsInt()
```
    Returns an int whose value is the unscaled value of this DECIMAL.
    
    Returns:
    
    the unscaled value of current DECIMAL node
    
    Throws:
    
    TypeException - if the current EventType is not DECIMAL
    
    RangeException - if the precision of the decimal number is greater than 9
  - getDecimalValueAsLong
```
long getDecimalValueAsLong()
```
    Returns a long whose value is the unscaled value of this DECIMAL.
    
    Returns:
    
    the unscaled value of current DECIMAL node
    
    Throws:
    
    TypeException - if the current EventType is not DECIMAL
    
    RangeException - if the precision of the decimal number is greater than 18
  - getDecimalValueAsBytes
```
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.
    
    Returns:
    
    a byte array containing the two's complement representation of current DECIMAL node
  - getBoolean
```
boolean getBoolean()
```
    Returns:
    
    the boolean value of the current node
    
    Throws:
    
    TypeException - if the current EventType is not BOOLEAN
  - getString
```
String getString()
```
    Returns:
    
    the String value of the current node
    
    Throws:
    
    TypeException - if the current EventType is not STRING
  - getTimestampLong
```
long getTimestampLong()
```
    Returns:
    
    the Timestamp value of the current node as a long representing the number of milliseconds since epoch
    
    Throws:
    
    TypeException - if the current EventType is not TIMESTAMP
  - getTimestamp
```
OTimestamp getTimestamp()
```
    Returns:
    
    the Timestamp value of the current node
    
    Throws:
    
    TypeException - if the current EventType is not TIMESTAMP
  - getDateInt
```
int getDateInt()
```
    Returns:
    
    the Date value of the current node as an int representing the number of DAYS since epoch
    
    Throws:
    
    TypeException - if the current EventType is not DATE
  - getDate
```
ODate getDate()
```
    Returns:
    
    the Date value of the current node
    
    Throws:
    
    TypeException - if the current EventType is not DATE
  - getTimeInt
```
int getTimeInt()
```
    Returns:
    
    the Time value of the current node as an int representing the number of milliseconds since midnight.
    
    Throws:
    
    TypeException - if the current EventType is not TIME
  - getTime
```
OTime getTime()
```
    Returns:
    
    the Time value of the current node
    
    Throws:
    
    TypeException - if the current EventType is not TIME
  - getInterval
```
OInterval getInterval()
```
    Returns:
    
    the Interval value of the current node
    
    Throws:
    
    TypeException - if the current EventType is not INTERVAL
  - getIntervalDays
```
int getIntervalDays()
```
  - getIntervalMillis
```
long getIntervalMillis()
```
  - getBinary
```
ByteBuffer getBinary()
```
    Returns:
    
    the ByteBuffer value of the current node
    
    Throws:
    
    TypeException - if the current EventType is not BINARY

Interface DocumentReader

Nested Class Summary

Method Summary

Method Detail

next

getCurrentEvent

skipChildren

inMap

getFieldName

getArrayIndex

getByte

getShort

getInt

getLong

getFloat

getDouble

getDecimal

getDecimalPrecision

getDecimalScale

getDecimalValueAsInt

getDecimalValueAsLong

getDecimalValueAsBytes

getBoolean

getString

getTimestampLong

getTimestamp

getDateInt

getDate

getTimeInt

getTime

getInterval

getIntervalDays

getIntervalMillis

getBinary