ChangeDataReader (OJAI Core Library for Java v. 3.0-mapr-1808)

All Superinterfaces:

Iterator<ChangeEvent>
```
@API.Public
 @API.NotThreadSafe
public interface ChangeDataReader
extends Iterator<ChangeEvent>
```
A parser that traverses over the individual change nodes in a ChangeDataRecord. It provides a cursor-like semantics which can be moved, one node at a time by invoking next().
The properties of individual change node. For example, data type, field name, field value, etc. can be retrieved using various methods of this interface.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getArrayIndex()`
`ByteBuffer`	`getBinary()`
`boolean`	`getBoolean()`
`byte`	`getByte()`
`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()`
`ByteBuffer`	`getFieldNameBytes()`
`float`	`getFloat()`
`int`	`getInt()`
`OInterval`	`getInterval()`
`long`	`getIntervalMillis()` Returns the value of this interval duration in milliseconds computed from individual fields.
`long`	`getLong()`
`ChangeOp`	`getOp()` Returns the `ChangeOp` of the current change node.
`long`	`getOpTimestamp()` Returns the logical time of the data.
`long`	`getServerTimestamp()`
`short`	`getShort()`
`String`	`getString()`
`OTime`	`getTime()`
`int`	`getTimeInt()`
`OTimestamp`	`getTimestamp()`
`long`	`getTimestampLong()`
`Value.Type`	`getType()`
`boolean`	`inArray()` If it returns true, the current field is in an array; otherwise, the current field is not in an array.
`boolean`	`inMap()` If it returns true, the current field is in a map; otherwise, the current field is not in a map.
`ChangeEvent`	`next()` Moves the cursor to the next change node and returns the `ChangeEvent` associated with the node.

Methods inherited from interface java.util.Iterator
forEachRemaining, hasNext, remove

- Method Detail
  - next
```
ChangeEvent next()
```
    Moves the cursor to the next change node and returns the ChangeEvent associated with the node.
    
    Specified by:
    
    next in interface Iterator<ChangeEvent>
  - getOp
```
ChangeOp getOp()
```
    Returns the ChangeOp of the current change node.
  - getFieldName
```
String getFieldName()
```
    Returns:
    
    the field name of the current change node
  - getFieldNameBytes
```
ByteBuffer getFieldNameBytes()
```
    Returns:
    
    the byte array equivalent of the field name of the current change node
  - getArrayIndex
```
int getArrayIndex()
```
    Returns:
    
    the index of the current node in an Array
  - inMap
```
boolean inMap()
```
    If it returns true, the current field is in a map; otherwise, the current field is not in a map.
    
    Returns:
    
    whether this node is in a Map. `true` for all top level fields
  - inArray
```
boolean inArray()
```
    If it returns true, the current field is in an array; otherwise, the current field is not in an array.
    
    Returns:
    
    whether this node is an Array
  - getType
```
Value.Type getType()
```
    Returns:
    
    the type of the OJAI Value of the current node
  - getOpTimestamp
```
long getOpTimestamp()
```
    Returns the logical time of the data. The version is the same as the timestamp when this operation occurs. For a multi-version DocumentStore, the version is specified by the user.
  - getServerTimestamp
```
long getServerTimestamp()
```
    Returns:
    
    the timestamp when the operation arrived on the server
  - 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
    
    org.w3c.dom.ranges.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
    
    org.w3c.dom.ranges.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
  - getIntervalMillis
```
long getIntervalMillis()
```
    Returns the value of this interval duration in milliseconds computed from individual fields. This value will be approximate if the months or years field of this interval is non-zero.
    
    Throws:
    
    TypeException - if the current EventType is not INTERVAL
  - getBinary
```
ByteBuffer getBinary()
```
    Returns:
    
    the ByteBuffer value of the current node
    
    Throws:
    
    TypeException - if the current EventType is not BINARY

Interface ChangeDataReader

Method Summary

Methods inherited from interface java.util.Iterator

Method Detail

next

getOp

getFieldName

getFieldNameBytes

getArrayIndex

inMap

inArray

getType

getOpTimestamp

getServerTimestamp

getByte

getShort

getInt

getLong

getFloat

getDouble

getDecimal

getDecimalPrecision

getDecimalScale

getDecimalValueAsInt

getDecimalValueAsLong

getDecimalValueAsBytes

getBoolean

getString

getTimestampLong

getTimestamp

getDateInt

getDate

getTimeInt

getTime

getInterval

getIntervalMillis

getBinary