org.ojai.store.cdc

Interface ChangeDataRecord

All Superinterfaces:

Iterable<KeyValue<FieldPath,ChangeNode>>

@API.Public
 @API.NotThreadSafe
public interface ChangeDataRecord
extends Iterable<KeyValue<FieldPath,ChangeNode>>

This interface encapsulates an atomic set of change operations that were performed to a single Document in the source DocumentStore.

Method Summary

Modifier and Type	Method and Description
Value	getId() Returns the "_id" field of the Document associated with this ChangeData notification.
long	getOpTimestamp() Returns the logical time of the data.
ChangeDataReader	getReader() Returns a new ChangeDataReader for this change data record.
long	getServerTimestamp() Returns the server timestamp of this change data record as number of milliseconds since Unix epoch. This is set to -1 if ChangeDataRecordType is RECORD_UPDATE.
ChangeDataRecordType	getType() Returns the ChangeDataRecordType associated with this change data record.
Iterator<KeyValue<FieldPath,ChangeNode>>	iterator() Returns an iterator over a set of ChangeNodes which are part of this change data record.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getId

Value getId()

Returns the "_id" field of the Document associated with this ChangeData notification.

getType

ChangeDataRecordType getType()

Returns the ChangeDataRecordType associated with this change data record.

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 server timestamp of this change data record as number of milliseconds since Unix epoch.
This is set to -1 if ChangeDataRecordType is RECORD_UPDATE.

iterator

Iterator<KeyValue<FieldPath,ChangeNode>> iterator()

Returns an iterator over a set of ChangeNodes which are part of this change data record.

Specified by:

iterator in interface Iterable<KeyValue<FieldPath,ChangeNode>>

getReader

ChangeDataReader getReader()

Returns a new ChangeDataReader for this change data record.