Skip navigation links
OJAI Core Library for Java v. 3.0
A B C D E F G H I J K L M N O P Q R S T U V W 

A

accepts(String) - Method in interface org.ojai.store.Driver
Returns true if this Driver supports the protocol specified in the URL.
add(boolean) - Method in interface org.ojai.DocumentBuilder
Adds a boolean value at the current index in the current array and advances the current index by 1.
add(String) - Method in interface org.ojai.DocumentBuilder
Adds a String value at the current index in the current array and advances the current index by 1.
add(byte) - Method in interface org.ojai.DocumentBuilder
Adds a byte value at the current index in the current array and advances the current index by 1.
add(short) - Method in interface org.ojai.DocumentBuilder
Adds a short value at the current index in the current array and advances the current index by 1.
add(int) - Method in interface org.ojai.DocumentBuilder
Adds an int value at the current index in the current array and advances the current index by 1.
add(long) - Method in interface org.ojai.DocumentBuilder
Adds a long value at the current index in the current array and advances the current index by 1.
add(float) - Method in interface org.ojai.DocumentBuilder
Adds a float value at the current index in the current array and advances the current index by 1.
add(double) - Method in interface org.ojai.DocumentBuilder
Adds a double value at the current index in the current array and advances the current index by 1.
add(BigDecimal) - Method in interface org.ojai.DocumentBuilder
Adds a BigDecimal value at the current index in the current array and advances the current index by 1.
add(byte[]) - Method in interface org.ojai.DocumentBuilder
Appends the byte array as a BINARY value to the current array.
add(byte[], int, int) - Method in interface org.ojai.DocumentBuilder
Appends the byte array bounded by offset and length as a BINARY value to the current array.
add(ByteBuffer) - Method in interface org.ojai.DocumentBuilder
Appends the ByteBuffer as a BINARY value to the current array.
add(Value) - Method in interface org.ojai.DocumentBuilder
Appends the Value to the current array.
add(Document) - Method in interface org.ojai.DocumentBuilder
Appends the Document to the current array.
add(OTime) - Method in interface org.ojai.DocumentBuilder
 
add(ODate) - Method in interface org.ojai.DocumentBuilder
 
add(OTimestamp) - Method in interface org.ojai.DocumentBuilder
 
add(OInterval) - Method in interface org.ojai.DocumentBuilder
 
addDate(int) - Method in interface org.ojai.DocumentBuilder
Appends the specified date value represented as the number of days since epoch to the current array.
addDecimal(long) - Method in interface org.ojai.DocumentBuilder
Adds a long number as a DECIMAL value at the current index in the current array and advances the current index by 1.
addDecimal(double) - Method in interface org.ojai.DocumentBuilder
Adds a double number as a DECIMAL value at the current index in the current array and advances the current index by 1.
addDecimal(int, int) - Method in interface org.ojai.DocumentBuilder
Adds an int unscaled value and an int scale as a DECIMAL value at the current index in the current array and advances the current index by 1.
addDecimal(long, int) - Method in interface org.ojai.DocumentBuilder
Adds an long unscaled value and an int scale as a DECIMAL value at the current index in the current array and advances the current index by 1.
addDecimal(byte[], int) - Method in interface org.ojai.DocumentBuilder
Adds a byte array containing the two's complement binary representation and an int scale as a DECIMAL value at the current index in the current array and advances the current index by 1.
addInterval(long) - Method in interface org.ojai.DocumentBuilder
 
addNewArray() - Method in interface org.ojai.DocumentBuilder
 
addNewMap() - Method in interface org.ojai.DocumentBuilder
 
addNull() - Method in interface org.ojai.DocumentBuilder
Appends a NULL value to the current array.
addTime(int) - Method in interface org.ojai.DocumentBuilder
Appends the specified time value represented as number of milliseconds since midnight to the current array.
addTimestamp(long) - Method in interface org.ojai.DocumentBuilder
 
and() - Method in interface org.ojai.store.QueryCondition
Begins a new AND compound condition block.
API - Class in org.ojai.annotation
 
API() - Constructor for class org.ojai.annotation.API
 
API.Evolving - Annotation Type in org.ojai.annotation
Annotate a class or method as an evolving API.
API.Factory - Annotation Type in org.ojai.annotation
Annotate a class to be a factory class containing only static methods.
API.Immutable - Annotation Type in org.ojai.annotation
Annotate a type to be immutable after construction.
API.ImmutableOnBuild - Annotation Type in org.ojai.annotation
Annotate a type to be immutable after its build() method is called.
API.Internal - Annotation Type in org.ojai.annotation
Annotate a class or method, even if marked as public with Java keyword, as internal.
API.Mutable - Annotation Type in org.ojai.annotation
Annotate a type to be mutable after construction.
API.NonNullable - Annotation Type in org.ojai.annotation
Annotate a class field, method parameter or return value as non-nullable, i.e.
API.NotThreadSafe - Annotation Type in org.ojai.annotation
Annotate a type to be not thread-safe.
API.Nullable - Annotation Type in org.ojai.annotation
Annotate a class field, method parameter or return value as nullable, i.e.
API.Public - Annotation Type in org.ojai.annotation
Annotate a class or method as a public API.
API.ThreadSafe - Annotation Type in org.ojai.annotation
Annotate a type to be thread-safe.
append(String, List<? extends Object>) - Method in interface org.ojai.store.DocumentMutation
Appends elements of the given list to an existing ARRAY at the given FieldPath.
append(FieldPath, List<? extends Object>) - Method in interface org.ojai.store.DocumentMutation
Appends elements of the given list to an existing ARRAY at the given FieldPath.
append(String, String) - Method in interface org.ojai.store.DocumentMutation
Appends the given string to an existing STRING at the given FieldPath.
append(FieldPath, String) - Method in interface org.ojai.store.DocumentMutation
Appends the given string to an existing STRING at the given FieldPath.
append(String, byte[], int, int) - Method in interface org.ojai.store.DocumentMutation
Appends the given byte array to an existing BINARY value at the given FieldPath.
append(FieldPath, byte[], int, int) - Method in interface org.ojai.store.DocumentMutation
Appends the given byte array to an existing BINARY value at the given FieldPath.
append(String, byte[]) - Method in interface org.ojai.store.DocumentMutation
Appends the given byte array to an existing BINARY value at the given FieldPath.
append(FieldPath, byte[]) - Method in interface org.ojai.store.DocumentMutation
Appends the given byte array to an existing BINARY value at the given FieldPath.
append(String, ByteBuffer) - Method in interface org.ojai.store.DocumentMutation
Appends the given ByteBuffer to an existing BINARY value at the given FieldPath.
append(FieldPath, ByteBuffer) - Method in interface org.ojai.store.DocumentMutation
Appends the given ByteBuffer to an existing BINARY value at the given FieldPath.
asBoolean(Value) - Static method in class org.ojai.util.Values
 
asByte(Value) - Static method in class org.ojai.util.Values
 
asDecimal(Value) - Static method in class org.ojai.util.Values
 
asDouble(Value) - Static method in class org.ojai.util.Values
 
asFloat(Value) - Static method in class org.ojai.util.Values
 
asInt(Value) - Static method in class org.ojai.util.Values
 
asJsonString() - Method in class org.ojai.FieldPath
 
asJsonString(JsonOptions) - Method in class org.ojai.FieldPath
 
asJsonString() - Method in class org.ojai.FieldSegment.IndexSegment
 
asJsonString(JsonOptions) - Method in class org.ojai.FieldSegment.IndexSegment
 
asJsonString() - Method in class org.ojai.FieldSegment.NameSegment
 
asJsonString(JsonOptions) - Method in class org.ojai.FieldSegment.NameSegment
 
asJsonString() - Method in interface org.ojai.JsonString
 
asJsonString(JsonOptions) - Method in interface org.ojai.JsonString
 
asJsonString() - Method in class org.ojai.util.BaseFieldProjector
 
asJsonString(JsonOptions) - Method in class org.ojai.util.BaseFieldProjector
 
asJsonString(Value) - Static method in class org.ojai.util.Values
Converts a Value to its extended JSON representation.

The 7 intrinsic types,  null, boolean, string, long, double, array, and map , are represented in regular JSON.
asLong(Value) - Static method in class org.ojai.util.Values
 
asMap() - Method in interface org.ojai.Document
 
asNumber(Value) - Static method in class org.ojai.util.Values
 
asPathString() - Method in class org.ojai.FieldPath
Returns the String representation of this field path, quoting only those name segments which were parsed from a quoted identifier.
asPathString(boolean) - Method in class org.ojai.FieldPath
 
asPathString(boolean) - Method in class org.ojai.FieldSegment
 
asReader(String) - Method in class org.ojai.base.DocumentBase
 
asReader() - Method in interface org.ojai.Document
 
asReader(String) - Method in interface org.ojai.Document
 
asReader(FieldPath) - Method in interface org.ojai.Document
 
asReader() - Method in interface org.ojai.Value
Returns a DocumentReader over the current document.
asShort(Value) - Static method in class org.ojai.util.Values
 
asString(Value) - Static method in class org.ojai.util.Values
 
AuthenticationException - Exception in org.ojai.store.exceptions
An operation was requested without sufficient authentication.
AuthenticationException() - Constructor for exception org.ojai.store.exceptions.AuthenticationException
 
AuthenticationException(String, Throwable) - Constructor for exception org.ojai.store.exceptions.AuthenticationException
 
AuthenticationException(String) - Constructor for exception org.ojai.store.exceptions.AuthenticationException
 
AuthenticationException(Throwable) - Constructor for exception org.ojai.store.exceptions.AuthenticationException
 
AuthorizationException - Exception in org.ojai.store.exceptions
An operation was requested without sufficient permission.
AuthorizationException() - Constructor for exception org.ojai.store.exceptions.AuthorizationException
 
AuthorizationException(String, Throwable) - Constructor for exception org.ojai.store.exceptions.AuthorizationException
 
AuthorizationException(String) - Constructor for exception org.ojai.store.exceptions.AuthorizationException
 
AuthorizationException(Throwable) - Constructor for exception org.ojai.store.exceptions.AuthorizationException
 

B

BASE_URL - Static variable in class org.ojai.json.JsonConsts
 
BaseDelegate() - Constructor for class org.ojai.json.Events.BaseDelegate
 
BaseFieldProjector - Class in org.ojai.util
 
BaseFieldProjector(String...) - Constructor for class org.ojai.util.BaseFieldProjector
 
BaseFieldProjector(FieldPath...) - Constructor for class org.ojai.util.BaseFieldProjector
 
BaseFieldProjector(Collection<FieldPath>) - Constructor for class org.ojai.util.BaseFieldProjector
 
BaseFieldProjector(ProjectionTree) - Constructor for class org.ojai.util.BaseFieldProjector
 
BeanCodec - Class in org.ojai.beans
 
BeanCodec() - Constructor for class org.ojai.beans.BeanCodec
 
beginTrackingWrites() - Method in class org.ojai.store.base.ForwardingStore
 
beginTrackingWrites(String) - Method in class org.ojai.store.base.ForwardingStore
 
beginTrackingWrites() - Method in interface org.ojai.store.DocumentStore
Begins tracking the write operations performed through this instance of DocumentStore.
beginTrackingWrites(String) - Method in interface org.ojai.store.DocumentStore
Begins tracking the write operations performed through this instance of DocumentStore.
bor(DocumentReader, Queue<Events.EventDescriptor>) - Method in class org.ojai.json.Events.BaseDelegate
 
bor(DocumentReader, Queue<Events.EventDescriptor>) - Method in interface org.ojai.json.Events.Delegate
 
build() - Method in interface org.ojai.Buildable
Builds this object and makes it immutable.
build() - Method in interface org.ojai.store.Query
Builds this Query object and make it immutable.
build() - Method in interface org.ojai.store.QueryCondition
Closes all nested compound condition blocks.
Buildable - Interface in org.ojai
 

C

ChangeDataReader - Interface in org.ojai.store.cdc
A parser that traverses over the individual change nodes in a ChangeDataRecord.
ChangeDataRecord - Interface in org.ojai.store.cdc
This interface encapsulates an atomic set of change operations that were performed to a single Document in the source DocumentStore.
ChangeDataRecordType - Enum in org.ojai.store.cdc
This enumeration specifies the mode of change for a change data record.
ChangeEvent - Enum in org.ojai.store.cdc
This enumeration identifies the change event associated with the current change node.
ChangeNode - Interface in org.ojai.store.cdc
An encapsulation of a change to a single field in a Document.
ChangeOp - Enum in org.ojai.store.cdc
This enumeration identifies the change event associated with the current change node.
checkAndDelete(Value, QueryCondition) - Method in class org.ojai.store.base.ForwardingStore
 
checkAndDelete(String, QueryCondition) - Method in class org.ojai.store.base.ForwardingStore
 
checkAndDelete(String, QueryCondition) - Method in interface org.ojai.store.DocumentStore
Atomically evaluates the condition on given document and if the condition holds true for the document then it is atomically deleted.
checkAndDelete(Value, QueryCondition) - Method in interface org.ojai.store.DocumentStore
 
checkAndMutate(Value, QueryCondition, DocumentMutation) - Method in class org.ojai.store.base.ForwardingStore
 
checkAndMutate(String, QueryCondition, DocumentMutation) - Method in class org.ojai.store.base.ForwardingStore
 
checkAndMutate(String, QueryCondition, DocumentMutation) - Method in interface org.ojai.store.DocumentStore
checkAndMutate(Value, QueryCondition, DocumentMutation) - Method in interface org.ojai.store.DocumentStore
checkAndReplace(Value, QueryCondition, Document) - Method in class org.ojai.store.base.ForwardingStore
 
checkAndReplace(String, QueryCondition, Document) - Method in class org.ojai.store.base.ForwardingStore
 
checkAndReplace(String, QueryCondition, Document) - Method in interface org.ojai.store.DocumentStore
Atomically evaluates the condition on the given document and if the condition holds true for the document then it atomically replaces the document with the given document.
checkAndReplace(Value, QueryCondition, Document) - Method in interface org.ojai.store.DocumentStore
 
checkAndSetInUse() - Method in class org.ojai.base.DocumentStreamBase
Checks to see that the state is valid (open, not canceled or closed) for requesting data.
checkAndUpdate(String, QueryCondition, DocumentMutation) - Method in interface org.ojai.store.DocumentStore
Atomically evaluates the condition on a given document and if the condition holds true for the document then a mutation is applied on the document.
checkAndUpdate(Value, QueryCondition, DocumentMutation) - Method in interface org.ojai.store.DocumentStore
Atomically evaluates the condition on a given document and if the condition holds true for the document then a mutation is applied on the document.
checkOpen() - Method in class org.ojai.base.DocumentStreamBase
Checks to see if the stream is open or not.
child - Variable in class org.ojai.FieldSegment
 
clearTrackedWrites() - Method in class org.ojai.store.base.ForwardingStore
 
clearTrackedWrites() - Method in interface org.ojai.store.DocumentStore
Stops the writes tracking and clears any state on this DocumentStore instance.
clone() - Method in class org.ojai.FieldSegment
 
clone() - Method in class org.ojai.FieldSegment.IndexSegment
 
clone() - Method in class org.ojai.FieldSegment.NameSegment
 
clone() - Method in class org.ojai.json.JsonOptions
 
cloneAfterAncestor(FieldPath) - Method in class org.ojai.FieldPath
 
cloneWithNewChild(String) - Method in class org.ojai.FieldPath
 
cloneWithNewChild(int) - Method in class org.ojai.FieldPath
 
cloneWithNewChild(FieldSegment) - Method in class org.ojai.FieldPath
 
cloneWithNewParent(String) - Method in class org.ojai.FieldPath
 
cloneWithSharedProjectionTree() - Method in class org.ojai.util.BaseFieldProjector
Creates a lightweight clone of this FieldProjector with shared ProjectionTree.
cloneWithSharedProjectionTree() - Method in class org.ojai.util.FieldProjector
Creates a lightweight clone of this FieldProjector with shared ProjectionTree.
close() - Method in class org.ojai.base.DocumentStreamBase
Closes this DocumentStream.

If a derived class requires any closing steps, it should override DocumentStreamBase.closeDerived().

close() - Method in interface org.ojai.DocumentStream
Overridden to remove checked exception
close() - Method in class org.ojai.store.base.ForwardingStore
 
close() - Method in interface org.ojai.store.Connection
Closes this connection and releases any system resources associated with it.
close() - Method in interface org.ojai.store.DocumentStore
Override AutoCloseable.close() to avoid declaring a checked exception.
close() - Method in interface org.ojai.store.QueryCondition
Closes a compound condition block.
closeDerived() - Method in class org.ojai.base.DocumentStreamBase
Perform whatever steps the derived class requires for closing.
compact() - Method in class org.ojai.json.JsonOptions
 
compareTo(FieldPath) - Method in class org.ojai.FieldPath
Compares two FieldPath segment by segment from left to right.
compareTo(FieldSegment) - Method in class org.ojai.FieldSegment
 
compareTo(ODate) - Method in class org.ojai.types.ODate
 
compareTo(OTime) - Method in class org.ojai.types.OTime
 
compareTo(OTimestamp) - Method in class org.ojai.types.OTimestamp
 
condition(QueryCondition) - Method in interface org.ojai.store.QueryCondition
Appends the specified condition to the current condition block.
connect(String, Document) - Method in interface org.ojai.store.Driver
Establishes and returns a Connection to an OJAI data source.
Connection - Interface in org.ojai.store
A logical connection to an OJAI data source.
ConnectionException - Exception in org.ojai.store.exceptions
This class is the base class of all exceptions thrown from the Connection.
ConnectionException() - Constructor for exception org.ojai.store.exceptions.ConnectionException
Default constructor.
ConnectionException(String) - Constructor for exception org.ojai.store.exceptions.ConnectionException
Constructor.
ConnectionException(Throwable) - Constructor for exception org.ojai.store.exceptions.ConnectionException
Constructor taking another exception.
ConnectionException(String, Throwable) - Constructor for exception org.ojai.store.exceptions.ConnectionException
Constructor taking a message and another exception.
Constants - Class in org.ojai.util
 
Constants() - Constructor for class org.ojai.util.Constants
 
Container - Interface in org.ojai
A container of OJAI objects.
contains(FieldSegment) - Method in class org.ojai.FieldSegment
Checks to see if another path is contained in this one.
convertByteToBigDecimal(byte[], int) - Static method in class org.ojai.util.Decimals
 
convertIntToDecimal(int, int) - Static method in class org.ojai.util.Decimals
 
convertLongToDecimal(long, int) - Static method in class org.ojai.util.Decimals
 
createStore(String) - Method in interface org.ojai.store.Connection
Creates an OJAI DocumentStore specified by the given name or path and returns a handle.
createStore(String, Document) - Method in interface org.ojai.store.Connection
Creates an OJAI DocumentStore specified by the given name or path and returns a handle.
currentSegment - Variable in class org.ojai.util.BaseFieldProjector
 

D

Decimals - Class in org.ojai.util
Utility class with functions for data type conversions.
Decimals() - Constructor for class org.ojai.util.Decimals
 
decode(DocumentBuilder, Object) - Static method in class org.ojai.beans.BeanCodec
 
decodeCondition(T) - Method in interface org.ojai.OjaiCodec
Decodes an instance of <T> into an OJAI QueryCondition
decodeDocument(T) - Method in interface org.ojai.OjaiCodec
Decodes an instance of <T> into an OJAI Document
decodeMutation(T) - Method in interface org.ojai.OjaiCodec
Decodes an instance of <T> into an OJAI DocumentMutation
decodeQuery(T, Document) - Method in interface org.ojai.OjaiCodec
Decodes an instance of <T> into an OJAI Query
DecodingException - Exception in org.ojai.exceptions
Exception thrown by implementations if a failure occurs during deserialization of the document.
DecodingException() - Constructor for exception org.ojai.exceptions.DecodingException
 
DecodingException(String, Throwable) - Constructor for exception org.ojai.exceptions.DecodingException
 
DecodingException(String) - Constructor for exception org.ojai.exceptions.DecodingException
 
DecodingException(Throwable) - Constructor for exception org.ojai.exceptions.DecodingException
 
decrement(FieldPath, byte) - Method in interface org.ojai.store.DocumentMutation
Atomically decrements the given field (in dot separated notation) of the given row id.
decrement(String, byte) - Method in interface org.ojai.store.DocumentMutation
 
decrement(FieldPath, short) - Method in interface org.ojai.store.DocumentMutation
 
decrement(String, short) - Method in interface org.ojai.store.DocumentMutation
 
decrement(String, int) - Method in interface org.ojai.store.DocumentMutation
 
decrement(FieldPath, int) - Method in interface org.ojai.store.DocumentMutation
 
decrement(FieldPath, long) - Method in interface org.ojai.store.DocumentMutation
 
decrement(String, long) - Method in interface org.ojai.store.DocumentMutation
 
decrement(String, float) - Method in interface org.ojai.store.DocumentMutation
 
decrement(FieldPath, float) - Method in interface org.ojai.store.DocumentMutation
 
decrement(String, double) - Method in interface org.ojai.store.DocumentMutation
 
decrement(FieldPath, double) - Method in interface org.ojai.store.DocumentMutation
 
decrement(String, BigDecimal) - Method in interface org.ojai.store.DocumentMutation
 
decrement(FieldPath, BigDecimal) - Method in interface org.ojai.store.DocumentMutation
 
DEFAULT - Static variable in class org.ojai.json.JsonOptions
 
delete(String) - Method in class org.ojai.base.DocumentBase
 
delete(String) - Method in interface org.ojai.Document
Deletes the value at the specified FieldPath if it exists.
delete(FieldPath) - Method in interface org.ojai.Document
Deletes the value at the specified FieldPath if it exists.
delete(Value) - Method in class org.ojai.store.base.ForwardingStore
 
delete(String) - Method in class org.ojai.store.base.ForwardingStore
 
delete(Document) - Method in class org.ojai.store.base.ForwardingStore
 
delete(Document, FieldPath) - Method in class org.ojai.store.base.ForwardingStore
 
delete(Document, String) - Method in class org.ojai.store.base.ForwardingStore
 
delete(DocumentStream) - Method in class org.ojai.store.base.ForwardingStore
 
delete(DocumentStream, FieldPath) - Method in class org.ojai.store.base.ForwardingStore
 
delete(DocumentStream, String) - Method in class org.ojai.store.base.ForwardingStore
 
delete(String) - Method in interface org.ojai.store.DocumentMutation
Deletes the field at the given path.
delete(FieldPath) - Method in interface org.ojai.store.DocumentMutation
Deletes the field at the given path.
delete(String) - Method in interface org.ojai.store.DocumentStore
Deletes a document with the given id.
delete(Value) - Method in interface org.ojai.store.DocumentStore
 
delete(Document) - Method in interface org.ojai.store.DocumentStore
 
delete(Document, FieldPath) - Method in interface org.ojai.store.DocumentStore
 
delete(Document, String) - Method in interface org.ojai.store.DocumentStore
 
delete(DocumentStream) - Method in interface org.ojai.store.DocumentStore
Deletes a set of documents from the DocumentStore represented by the DocumentStream.
delete(DocumentStream, FieldPath) - Method in interface org.ojai.store.DocumentStore
 
delete(DocumentStream, String) - Method in interface org.ojai.store.DocumentStore
 
deleteStore(String) - Method in interface org.ojai.store.Connection
Deletes the OJAI DocumentStore specified by the given name or path.
Document - Interface in org.ojai
 
DOCUMENT_FIELD - Static variable in class org.ojai.DocumentConstants
FieldPath of the key used to refer the entire Document.
DOCUMENT_KEY - Static variable in class org.ojai.DocumentConstants
Name of the key used to refer the entire Document.
documentArrived(Document) - Method in interface org.ojai.DocumentListener
Called when a Document from the DocumentStream is available for consumption.
DocumentBase - Class in org.ojai.base
A template abstract class that implements the Document interface.
DocumentBase() - Constructor for class org.ojai.base.DocumentBase
 
DocumentBuilder - Interface in org.ojai
 
DocumentConstants - Class in org.ojai
 
DocumentConstants() - Constructor for class org.ojai.DocumentConstants
 
DocumentExistsException - Exception in org.ojai.store.exceptions
This exception is thrown if a Store operation fails if a Document already existed when none was expected for the operation to succeed.
DocumentExistsException() - Constructor for exception org.ojai.store.exceptions.DocumentExistsException
Default constructor.
DocumentExistsException(String) - Constructor for exception org.ojai.store.exceptions.DocumentExistsException
Constructor.
DocumentExistsException(Throwable) - Constructor for exception org.ojai.store.exceptions.DocumentExistsException
Constructor taking another exception.
DocumentExistsException(String, Throwable) - Constructor for exception org.ojai.store.exceptions.DocumentExistsException
Constructor taking a message and another exception.
DocumentListener - Interface in org.ojai
 
DocumentMutation - Interface in org.ojai.store
The DocumentMutation interface defines the APIs to perform mutation of a Document already stored in a DocumentStore.
DocumentNotFoundException - Exception in org.ojai.store.exceptions
This exception is thrown if a Store operation fails if a Document, which was expected to exist for the operation to succeed, could not be found.
DocumentNotFoundException() - Constructor for exception org.ojai.store.exceptions.DocumentNotFoundException
Default constructor.
DocumentNotFoundException(String) - Constructor for exception org.ojai.store.exceptions.DocumentNotFoundException
Constructor.
DocumentNotFoundException(Throwable) - Constructor for exception org.ojai.store.exceptions.DocumentNotFoundException
Constructor taking another exception.
DocumentNotFoundException(String, Throwable) - Constructor for exception org.ojai.store.exceptions.DocumentNotFoundException
Constructor taking a message and another exception.
DocumentReader - Interface in org.ojai
 
DocumentReader.EventType - Enum in org.ojai
 
DocumentReaderBase - Class in org.ojai.base
A template abstract class that implements the DocumentReader interface.
DocumentReaderBase() - Constructor for class org.ojai.base.DocumentReaderBase
 
documentReaders() - Method in class org.ojai.base.DocumentStreamBase
 
documentReaders() - Method in interface org.ojai.DocumentStream
Returns an Iterable over a set of DocumentReader.
DocumentReaders - Class in org.ojai.util
Helper class that provides utility methods to work with DocumentReader.
DocumentReaders() - Constructor for class org.ojai.util.DocumentReaders
 
documentReadersDerived() - Method in class org.ojai.base.DocumentStreamBase
 
DocumentReaderWithProjection - Class in org.ojai.util
An implementation of DocumentReader interface which can be used to project a sub-set of fields
DocumentReaderWithProjection(DocumentReader, FieldProjector) - Constructor for class org.ojai.util.DocumentReaderWithProjection
 
Documents - Class in org.ojai.util
This class contains utility methods for Document interface.
Documents() - Constructor for class org.ojai.util.Documents
 
DocumentStore - Interface in org.ojai.store
 
DocumentStream - Interface in org.ojai
A stream of documents.
DocumentStreamBase - Class in org.ojai.base
Abstract implementation of DocumentStream.
DocumentStreamBase() - Constructor for class org.ojai.base.DocumentStreamBase
 
done() - Method in class org.ojai.util.BaseFieldProjector
Returns true if ProjectionTree has visited all nodes
Driver - Interface in org.ojai.store
Entry point of an implementation of OJAI APIs.
DRIVER_NAME - Static variable in class org.ojai.json.JsonConsts
 
DriverManager - Class in org.ojai.store
A factory class to manage OJAI Drivers.
DriverManager() - Constructor for class org.ojai.store.DriverManager
 

E

elementAnd(String) - Method in interface org.ojai.store.QueryCondition
Begins a new element-wise AND compound condition block.
elementAnd(FieldPath) - Method in interface org.ojai.store.QueryCondition
Begins a new element-wise AND compound condition block.
ELEMENTS_ALL - Static variable in class org.ojai.DocumentConstants
Index segment indicating all elements in a list
empty() - Method in interface org.ojai.Container
Empties this container, removing all children.
empty() - Method in interface org.ojai.Document
Removes all of the entries from this document.
EMPTY - Static variable in class org.ojai.FieldPath
 
empty() - Method in interface org.ojai.store.DocumentMutation
Empties this DocumentMutation object.
EmptyDocumentStream - Class in org.ojai.util
A DocumentStream that returns no documents.
EmptyDocumentStream() - Constructor for class org.ojai.util.EmptyDocumentStream
 
EmptyQueryResult - Class in org.ojai.util
A QueryResult that returns no documents.
EmptyQueryResult() - Constructor for class org.ojai.util.EmptyQueryResult
 
encode(DocumentReader, Class<T>) - Static method in class org.ojai.beans.BeanCodec
 
encode(String, Class<T>) - Static method in class org.ojai.json.Json
 
encode(DocumentReader) - Static method in class org.ojai.util.DocumentReaders
Encodes values from the specified DocumentReader into a Java Map.
encode(DocumentReader) - Static method in class org.ojai.util.MapEncoder
Deprecated.
Encodes values from the specified DocumentReader into a Java Map.
encodeArray(DocumentReader) - Static method in class org.ojai.util.DocumentReaders
Encodes values from the specified DocumentReader into a Java Map.

This method should be called after consuming DocumentReader.EventType.START_ARRAY.

encodeCondition(QueryCondition) - Method in interface org.ojai.OjaiCodec
Encodes an OJAI QueryCondition into an instance of <T>
encodeDocument(Document) - Method in interface org.ojai.OjaiCodec
Encodes an OJAI Document into an instance of <T>
encodeMap(DocumentReader) - Static method in class org.ojai.util.DocumentReaders
Encodes values from the specified DocumentReader into a Java List.

The difference between this method and DocumentReaders.encode(DocumentReader) is that this should be called after consuming DocumentReader.EventType.START_MAP.

encodeMutation(DocumentMutation) - Method in interface org.ojai.OjaiCodec
Encodes an OJAI DocumentMutation into an instance of <T>
encodeQuery(Query) - Method in interface org.ojai.OjaiCodec
Encodes an OJAI Query into an instance of <T>
encodeValue(DocumentReader) - Static method in class org.ojai.util.DocumentReaders
Returns the corresponding Java Object for the current node in DocumentReader.
EncodingException - Exception in org.ojai.exceptions
Exception thrown by implementations if a failure occurs during serialization of the document.
EncodingException() - Constructor for exception org.ojai.exceptions.EncodingException
 
EncodingException(String, Throwable) - Constructor for exception org.ojai.exceptions.EncodingException
 
EncodingException(String) - Constructor for exception org.ojai.exceptions.EncodingException
 
EncodingException(Throwable) - Constructor for exception org.ojai.exceptions.EncodingException
 
endArray() - Method in interface org.ojai.DocumentBuilder
 
endMap() - Method in interface org.ojai.DocumentBuilder
 
endTrackingWrites() - Method in class org.ojai.store.base.ForwardingStore
 
endTrackingWrites() - Method in interface org.ojai.store.DocumentStore
Flushes any buffered writes operations for this DocumentStore and returns a writesContext which can be used to ensure that such writes are visible to ensuing queries.
eor(DocumentReader, Queue<Events.EventDescriptor>) - Method in class org.ojai.json.Events.BaseDelegate
 
eor(DocumentReader, Queue<Events.EventDescriptor>) - Method in interface org.ojai.json.Events.Delegate
 
eos() - Method in interface org.ojai.DocumentListener
Called when the end of the document stream is reached.
equals(Object) - Method in class org.ojai.FieldPath
 
equals(Object) - Method in class org.ojai.FieldSegment
 
equals(Object) - Method in interface org.ojai.store.Driver
Returns true if the other object is "equal to" this Driver.
equals(String, Map<String, ? extends Object>) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath equals the specified Map value.
equals(FieldPath, Map<String, ? extends Object>) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath equals the specified Map value.
equals(String, List<? extends Object>) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath equals the specified List value.
equals(FieldPath, List<? extends Object>) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath equals the specified List value.
equals(Object) - Method in class org.ojai.types.ODate
 
equals(Object) - Method in class org.ojai.types.OInterval
 
equals(Object) - Method in class org.ojai.types.OTime
 
equals(Object) - Method in class org.ojai.types.OTimestamp
 
equals(Document, Document) - Static method in class org.ojai.util.Documents
Compares two documents for equality.
escape(StringBuilder, boolean) - Method in class org.ojai.FieldSegment.NameSegment
 
EventDescriptor(DocumentReader.EventType) - Constructor for class org.ojai.json.Events.EventDescriptor
 
Events - Class in org.ojai.json
 
Events() - Constructor for class org.ojai.json.Events
 
Events.BaseDelegate - Class in org.ojai.json
 
Events.Delegate - Interface in org.ojai.json
 
Events.EventDescriptor - Class in org.ojai.json
 
exists(String) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests for existence of the specified FieldPath.
exists(FieldPath) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests for existence of the specified FieldPath.
ExpiredTokenException - Exception in org.ojai.store.exceptions
An operation was requested with and expired authentication token.
ExpiredTokenException() - Constructor for exception org.ojai.store.exceptions.ExpiredTokenException
 
ExpiredTokenException(String, Throwable) - Constructor for exception org.ojai.store.exceptions.ExpiredTokenException
 
ExpiredTokenException(String) - Constructor for exception org.ojai.store.exceptions.ExpiredTokenException
 
ExpiredTokenException(Throwable) - Constructor for exception org.ojai.store.exceptions.ExpiredTokenException
 
Expression - Interface in org.ojai
Represents an expression that can be used in a query.

F

failed(Exception) - Method in interface org.ojai.DocumentListener
Called when an Exception occurs while retrieving a Document.
FailedOp - Class in org.ojai.store.exceptions
This class is used to wrap a exception for stream processing that fails midway.
FailedOp(Document, Exception) - Constructor for class org.ojai.store.exceptions.FailedOp
 
FIELD_SEGMENT_COMPARATOR - Static variable in class org.ojai.FieldSegment
A Comparator that compares two FieldSegments solely on the segment value itself, excluding their child, if any.
FieldPath - Class in org.ojai
Immutable class for representing a field path.
FieldPath(FieldSegment.NameSegment) - Constructor for class org.ojai.FieldPath
For Antlr parser's use only.
FieldProjector - Class in org.ojai.util
A helper class, which maintains a projection tree built form the list of user specified FieldPaths and in association with a DocumentReader, determines which fields form the document reader are emitted to the applications.
FieldProjector(String...) - Constructor for class org.ojai.util.FieldProjector
 
FieldProjector(FieldPath...) - Constructor for class org.ojai.util.FieldProjector
 
FieldProjector(Collection<FieldPath>) - Constructor for class org.ojai.util.FieldProjector
 
FieldProjector(ProjectionTree) - Constructor for class org.ojai.util.FieldProjector
 
Fields - Class in org.ojai.util
 
Fields() - Constructor for class org.ojai.util.Fields
 
FieldSegment - Class in org.ojai
 
FieldSegment(FieldSegment) - Constructor for class org.ojai.FieldSegment
 
FieldSegment.IndexSegment - Class in org.ojai
 
FieldSegment.NameSegment - Class in org.ojai
 
FieldSegment.Type - Enum in org.ojai
 
find(Query) - Method in class org.ojai.store.base.ForwardingStore
 
find() - Method in class org.ojai.store.base.ForwardingStore
 
find(String...) - Method in class org.ojai.store.base.ForwardingStore
 
find(FieldPath...) - Method in class org.ojai.store.base.ForwardingStore
 
find(QueryCondition) - Method in class org.ojai.store.base.ForwardingStore
 
find(QueryCondition, String...) - Method in class org.ojai.store.base.ForwardingStore
 
find(QueryCondition, FieldPath...) - Method in class org.ojai.store.base.ForwardingStore
 
find(Query) - Method in interface org.ojai.store.DocumentStore
Executes the specified query on the DocumentStore and return a QueryResult.
find() - Method in interface org.ojai.store.DocumentStore
Executes a query to return all Documents in the DocumentStore.
find(String...) - Method in interface org.ojai.store.DocumentStore
Deprecated.
find(FieldPath...) - Method in interface org.ojai.store.DocumentStore
Deprecated.
find(QueryCondition) - Method in interface org.ojai.store.DocumentStore
Deprecated.
find(QueryCondition, String...) - Method in interface org.ojai.store.DocumentStore
Deprecated.
find(QueryCondition, FieldPath...) - Method in interface org.ojai.store.DocumentStore
Deprecated.
findById(Value, String...) - Method in class org.ojai.store.base.ForwardingStore
 
findById(Value, FieldPath...) - Method in class org.ojai.store.base.ForwardingStore
 
findById(Value, QueryCondition) - Method in class org.ojai.store.base.ForwardingStore
 
findById(Value, QueryCondition, String...) - Method in class org.ojai.store.base.ForwardingStore
 
findById(Value, QueryCondition, FieldPath...) - Method in class org.ojai.store.base.ForwardingStore
 
findById(String) - Method in class org.ojai.store.base.ForwardingStore
 
findById(Value) - Method in class org.ojai.store.base.ForwardingStore
 
findById(String, String...) - Method in class org.ojai.store.base.ForwardingStore
 
findById(String, FieldPath...) - Method in class org.ojai.store.base.ForwardingStore
 
findById(String, QueryCondition) - Method in class org.ojai.store.base.ForwardingStore
 
findById(String, QueryCondition, String...) - Method in class org.ojai.store.base.ForwardingStore
 
findById(String, QueryCondition, FieldPath...) - Method in class org.ojai.store.base.ForwardingStore
 
findById(String) - Method in interface org.ojai.store.DocumentStore
Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore.
findById(Value) - Method in interface org.ojai.store.DocumentStore
Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore.
findById(String, String...) - Method in interface org.ojai.store.DocumentStore
Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore.
findById(String, FieldPath...) - Method in interface org.ojai.store.DocumentStore
Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore.
findById(Value, String...) - Method in interface org.ojai.store.DocumentStore
Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore.
findById(Value, FieldPath...) - Method in interface org.ojai.store.DocumentStore
Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore.
findById(String, QueryCondition) - Method in interface org.ojai.store.DocumentStore
Returns the Document with the given `_id` if it matches the specified condition.
findById(Value, QueryCondition) - Method in interface org.ojai.store.DocumentStore
Returns the Document with the given `_id` if it matches the specified condition.
findById(String, QueryCondition, String...) - Method in interface org.ojai.store.DocumentStore
Returns the Document with the given `_id` if it matches the specified condition.
findById(String, QueryCondition, FieldPath...) - Method in interface org.ojai.store.DocumentStore
Returns the Document with the given `_id` if it matches the specified condition.
findById(Value, QueryCondition, String...) - Method in interface org.ojai.store.DocumentStore
Returns the Document with the given `_id` if it matches the specified condition.
findById(Value, QueryCondition, FieldPath...) - Method in interface org.ojai.store.DocumentStore
Returns the Document with the given `_id` if it matches the specified condition.
findQuery(Query) - Method in class org.ojai.store.base.ForwardingStore
 
findQuery(String) - Method in class org.ojai.store.base.ForwardingStore
 
findQuery(Query) - Method in interface org.ojai.store.DocumentStore
Deprecated.
findQuery(String) - Method in interface org.ojai.store.DocumentStore
Deprecated.
flush() - Method in class org.ojai.store.base.ForwardingStore
 
flush() - Method in interface org.ojai.store.DocumentStore
Flushes any buffered writes operations for this DocumentStore.
ForwardingStore - Class in org.ojai.store.base
An adapter implementation of DocumentStore interface which forwards the individual API calls to the wrapped Store object.
ForwardingStore(DocumentStore) - Constructor for class org.ojai.store.base.ForwardingStore
 
fromDaysSinceEpoch(int) - Static method in class org.ojai.types.ODate
Return an ODate instance from the specified number of days since epoch.
fromMillisOfDay(int) - Static method in class org.ojai.types.OTime
Return an OTime instance from the specified milliseconds since midnight.

G

getArrayIndex() - Method in interface org.ojai.DocumentReader
 
getArrayIndex() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getArrayIndex() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getBinary(String) - Method in class org.ojai.base.DocumentBase
 
getBinary(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a ByteBuffer object or null if the specified FieldPath does not exist in the document.
getBinary(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a ByteBuffer object or null if the specified FieldPath does not exist in the document.
getBinary() - Method in interface org.ojai.DocumentReader
 
getBinary() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getBinary() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the value as a ByteBuffer.
getBinary() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getBinary(Document, FieldPath, ByteBuffer) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a ByteBuffer object or the specified defaultValue if the specified FieldPath does not exist in the document.
getBinary(Document, String, ByteBuffer) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a ByteBuffer object or the specified defaultValue if the specified FieldPath does not exist in the document.
getBinary() - Method in interface org.ojai.Value
Returns the value as a ByteBuffer.
getBoolean(String) - Method in class org.ojai.base.DocumentBase
 
getBoolean(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a boolean.
getBoolean(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a boolean.
getBoolean() - Method in interface org.ojai.DocumentReader
 
getBoolean() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getBoolean() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the value as a boolean.
getBoolean() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getBoolean(Document, FieldPath, boolean) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a boolean or the specified defaultValue if the specified FieldPath does not exist in the document.
getBoolean(Document, String, boolean) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a boolean or the specified defaultValue if the specified FieldPath does not exist in the document.
getBoolean() - Method in interface org.ojai.Value
Returns the value as a boolean.
getBooleanObj(String) - Method in class org.ojai.base.DocumentBase
 
getBooleanObj(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a Boolean object or null if the specified FieldPath does not exist in the document.
getBooleanObj(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a Boolean object or null if the specified FieldPath does not exist in the document.
getByte(String) - Method in class org.ojai.base.DocumentBase
 
getByte(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a byte.
getByte(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a byte.
getByte() - Method in interface org.ojai.DocumentReader
 
getByte() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getByte() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the byte value of the current node.
getByte() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getByte(Document, FieldPath, byte) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a byte or the specified defaultValue if the specified FieldPath does not exist in the document.
getByte(Document, String, byte) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a byte or the specified defaultValue if the specified FieldPath does not exist in the document.
getByte() - Method in interface org.ojai.Value
Returns the value as a byte.
getByteObj(String) - Method in class org.ojai.base.DocumentBase
 
getByteObj(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a Byte object or null if the specified FieldPath does not exist in the document.
getByteObj(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a Byte object or null if the specified FieldPath does not exist in the document.
getChild() - Method in class org.ojai.FieldSegment
 
getCode() - Method in enum org.ojai.store.cdc.ChangeDataRecordType
Returns the numerical value of the enumeration.
getCode() - Method in enum org.ojai.store.cdc.ChangeEvent
Returns the numerical code of the enumeration.
getCode() - Method in enum org.ojai.store.cdc.ChangeOp
Returns the numerical code of the enumeration.
getCode() - Method in enum org.ojai.Value.Type
 
getConnection(String) - Static method in class org.ojai.store.DriverManager
Establishes and returns a Connection to an OJAI data source.
getConnection(String, Document) - Static method in class org.ojai.store.DriverManager
Establishes and returns a Connection to an OJAI data source.
getCurrentEvent() - Method in interface org.ojai.DocumentReader
 
getCurrentEvent() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getDate(String) - Method in class org.ojai.base.DocumentBase
 
getDate(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a ODate object or null if the specified FieldPath does not exist in the document.
getDate(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a ODate object or null if the specified FieldPath does not exist in the document.
getDate() - Method in interface org.ojai.DocumentReader
 
getDate() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getDate() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the value as a ODate object.
getDate() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getDate(Document, FieldPath, ODate) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a ODate or the specified defaultValue if the specified FieldPath does not exist in the document.
getDate(Document, String, ODate) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a ODate or the specified defaultValue if the specified FieldPath does not exist in the document.
getDate() - Method in interface org.ojai.Value
Returns the value as a ODate object.
getDateAsInt() - Method in interface org.ojai.store.cdc.ChangeNode
Returns a int representing the number of DAYS since Unix epoch.
getDateAsInt() - Method in interface org.ojai.Value
Returns a int representing the number of DAYS since Unix epoch.
getDateInt() - Method in interface org.ojai.DocumentReader
 
getDateInt() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getDateInt() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getDayOfMonth() - Method in class org.ojai.types.ODate
 
getDayOfMonth() - Method in class org.ojai.types.OTimestamp
 
getDays() - Method in class org.ojai.types.OInterval
 
getDecimal(String) - Method in class org.ojai.base.DocumentBase
 
getDecimal(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a BigDecimal object or null if the specified FieldPath does not exist in the document.
getDecimal(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a BigDecimal object or null if the specified FieldPath does not exist in the document.
getDecimal() - Method in interface org.ojai.DocumentReader
 
getDecimal() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getDecimal() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the value as a BigDecimal.
getDecimal() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getDecimal(Document, FieldPath, BigDecimal) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a BigDecimal or the specified defaultValue if the specified FieldPath does not exist in the document.
getDecimal(Document, String, BigDecimal) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a BigDecimal or the specified defaultValue if the specified FieldPath does not exist in the document.
getDecimal() - Method in interface org.ojai.Value
Returns the value as a BigDecimal.
getDecimalPrecision() - Method in interface org.ojai.DocumentReader
Returns the precision of the current DECIMAL node.
getDecimalPrecision() - Method in interface org.ojai.store.cdc.ChangeDataReader
Returns the precision of the current DECIMAL node.
getDecimalPrecision() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getDecimalScale() - Method in interface org.ojai.DocumentReader
Returns the scale of the current DECIMAL node.
getDecimalScale() - Method in interface org.ojai.store.cdc.ChangeDataReader
Returns the scale of the current DECIMAL node.
getDecimalScale() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getDecimalValueAsBytes() - Method in interface org.ojai.DocumentReader
Returns a ByteBuffer containing the two's complement representation of the current DECIMAL node.
getDecimalValueAsBytes() - Method in interface org.ojai.store.cdc.ChangeDataReader
Returns a ByteBuffer containing the two's complement representation of the current DECIMAL node.
getDecimalValueAsBytes() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getDecimalValueAsInt() - Method in interface org.ojai.DocumentReader
Returns an int whose value is the unscaled value of this DECIMAL.
getDecimalValueAsInt() - Method in interface org.ojai.store.cdc.ChangeDataReader
Returns an int whose value is the unscaled value of this DECIMAL.
getDecimalValueAsInt() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getDecimalValueAsLong() - Method in interface org.ojai.DocumentReader
Returns a long whose value is the unscaled value of this DECIMAL.
getDecimalValueAsLong() - Method in interface org.ojai.store.cdc.ChangeDataReader
Returns a long whose value is the unscaled value of this DECIMAL.
getDecimalValueAsLong() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getDocument() - Method in interface org.ojai.DocumentBuilder
 
getDocument() - Method in class org.ojai.store.exceptions.FailedOp
 
getDouble(String) - Method in class org.ojai.base.DocumentBase
 
getDouble(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a double.
getDouble(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a double.
getDouble() - Method in interface org.ojai.DocumentReader
 
getDouble() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getDouble() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the value as a double.
getDouble() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getDouble(Document, FieldPath, double) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a double or the specified defaultValue if the specified FieldPath does not exist in the document.
getDouble(Document, String, double) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a double or the specified defaultValue if the specified FieldPath does not exist in the document.
getDouble() - Method in interface org.ojai.Value
Returns the value as a double.
getDoubleObj(String) - Method in class org.ojai.base.DocumentBase
 
getDoubleObj(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a Double object or null if the specified FieldPath does not exist in the document.
getDoubleObj(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a Double object or null if the specified FieldPath does not exist in the document.
getDriver() - Method in interface org.ojai.store.Connection
Returns the OJAI Driver instance associated with this connection.
getDriver(String) - Static method in class org.ojai.store.DriverManager
Discovers and loads the OJAI Driver implementation which supported the specified URL.
getEventType() - Method in class org.ojai.json.Events.EventDescriptor
 
getEventTypeForType(Value.Type) - Static method in class org.ojai.util.Types
Returns the EventType for the specified Type.
getException() - Method in class org.ojai.store.exceptions.FailedOp
 
getFieldName() - Method in interface org.ojai.DocumentReader
 
getFieldName() - Method in class org.ojai.json.Events.EventDescriptor
 
getFieldName() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getFieldName() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getFieldNameBytes() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getFieldPath() - Method in class org.ojai.store.MutationOp
 
getFloat(String) - Method in class org.ojai.base.DocumentBase
 
getFloat(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a float.
getFloat(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a float.
getFloat() - Method in interface org.ojai.DocumentReader
 
getFloat() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getFloat() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the value as a float.
getFloat() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getFloat(Document, FieldPath, float) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a float or the specified defaultValue if the specified FieldPath does not exist in the document.
getFloat(Document, String, float) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a float or the specified defaultValue if the specified FieldPath does not exist in the document.
getFloat() - Method in interface org.ojai.Value
Returns the value as a float.
getFloatObj(String) - Method in class org.ojai.base.DocumentBase
 
getFloatObj(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a Float object or null if the specified FieldPath does not exist in the document.
getFloatObj(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a Float object or null if the specified FieldPath does not exist in the document.
getHour() - Method in class org.ojai.types.OTime
 
getHour() - Method in class org.ojai.types.OTimestamp
 
getId() - Method in interface org.ojai.Document
 
getId() - Method in interface org.ojai.store.cdc.ChangeDataRecord
Returns the "_id" field of the Document associated with this ChangeData notification.
getIdBinary() - Method in interface org.ojai.Document
 
getIdString() - Method in interface org.ojai.Document
 
getIndex() - Method in class org.ojai.FieldSegment.IndexSegment
 
getIndex() - Method in class org.ojai.json.Events.EventDescriptor
 
getIndexSegment() - Method in class org.ojai.FieldSegment
 
getIndexSegment() - Method in class org.ojai.FieldSegment.IndexSegment
 
getInt(String) - Method in class org.ojai.base.DocumentBase
 
getInt(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as an int.
getInt(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as an int.
getInt() - Method in interface org.ojai.DocumentReader
 
getInt() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getInt() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the value as an int.
getInt() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getInt(Document, FieldPath, int) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a int or the specified defaultValue if the specified FieldPath does not exist in the document.
getInt(Document, String, int) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a int or the specified defaultValue if the specified FieldPath does not exist in the document.
getInt() - Method in interface org.ojai.Value
Returns the value as an int.
getInterval(String) - Method in class org.ojai.base.DocumentBase
 
getInterval(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as an OInterval object or null if the specified FieldPath does not exist in the document.
getInterval(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as an OInterval object or null if the specified FieldPath does not exist in the document.
getInterval() - Method in interface org.ojai.DocumentReader
 
getInterval() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getInterval() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the value as an OInterval object.
getInterval() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getInterval(Document, FieldPath, OInterval) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a OInterval or the specified defaultValue if the specified FieldPath does not exist in the document.
getInterval(Document, String, OInterval) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a OInterval or the specified defaultValue if the specified FieldPath does not exist in the document.
getInterval() - Method in interface org.ojai.Value
Returns the value as a OInterval object.
getIntervalAsLong() - Method in interface org.ojai.store.cdc.ChangeNode
Returns a long representing interval duration in milliseconds.
getIntervalAsLong() - Method in interface org.ojai.Value
Returns a long representing interval duration in milliseconds.
getIntervalDays() - Method in interface org.ojai.DocumentReader
 
getIntervalDays() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getIntervalMillis() - Method in interface org.ojai.DocumentReader
 
getIntervalMillis() - Method in interface org.ojai.store.cdc.ChangeDataReader
Returns the value of this interval duration in milliseconds computed from individual fields.
getIntervalMillis() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getIntObj(String) - Method in class org.ojai.base.DocumentBase
 
getIntObj(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as an Integer object or null if the specified FieldPath does not exist in the document.
getIntObj(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as an Integer object or null if the specified FieldPath does not exist in the document.
getKey() - Method in interface org.ojai.KeyValue
Returns the key corresponding to this KeyValue.
getList(String) - Method in class org.ojai.base.DocumentBase
 
getList(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a List object or null if the specified FieldPath does not exist in the document.
getList(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a List object or null if the specified FieldPath does not exist in the document.
getList() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the value as a List<Object>.
getList(Document, FieldPath, List<Object>) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a List or the specified defaultValue if the specified FieldPath does not exist in the document.
getList(Document, String, List<Object>) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a List or the specified defaultValue if the specified FieldPath does not exist in the document.
getList() - Method in interface org.ojai.Value
Returns the value as a List<Object>.
getLong(String) - Method in class org.ojai.base.DocumentBase
 
getLong(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a long.
getLong(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a long.
getLong() - Method in interface org.ojai.DocumentReader
 
getLong() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getLong() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the value as a long.
getLong() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getLong(Document, FieldPath, long) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a long or the specified defaultValue if the specified FieldPath does not exist in the document.
getLong(Document, String, long) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a long or the specified defaultValue if the specified FieldPath does not exist in the document.
getLong() - Method in interface org.ojai.Value
Returns the value as a long.
getLongObj(String) - Method in class org.ojai.base.DocumentBase
 
getLongObj(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a Long object or null if the specified FieldPath does not exist in the document.
getLongObj(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a Long object or null if the specified FieldPath does not exist in the document.
getMap(String) - Method in class org.ojai.base.DocumentBase
 
getMap(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a Map object or null if the specified FieldPath does not exist in the document.
getMap(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a Map object or null if the specified FieldPath does not exist in the document.
getMap() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the value as a Map<String, Object>.
getMap(Document, FieldPath, Map<String, Object>) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a Map or the specified defaultValue if the specified FieldPath does not exist in the document.
getMap(Document, String, Map<String, Object>) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a Map or the specified defaultValue if the specified FieldPath does not exist in the document.
getMap() - Method in interface org.ojai.Value
Returns the value as a Map.
getMillis() - Method in class org.ojai.types.OTimestamp
 
getMilliSecond() - Method in class org.ojai.types.OTime
 
getMilliSecond() - Method in class org.ojai.types.OTimestamp
 
getMilliseconds() - Method in class org.ojai.types.OInterval
 
getMinute() - Method in class org.ojai.types.OTime
 
getMinute() - Method in class org.ojai.types.OTimestamp
 
getMonth() - Method in class org.ojai.types.ODate
 
getMonth() - Method in class org.ojai.types.OTimestamp
 
getMonths() - Method in class org.ojai.types.OInterval
 
getName() - Method in interface org.ojai.Expression
 
getName() - Method in class org.ojai.FieldPath
 
getName() - Method in class org.ojai.FieldSegment.NameSegment
 
getName() - Method in interface org.ojai.store.Driver
Returns a printable name for the OJAI Driver implementation
getNameSegment() - Method in class org.ojai.FieldSegment
 
getNameSegment() - Method in class org.ojai.FieldSegment.NameSegment
 
getObject() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the value as an Object of the underlying type.
getObject() - Method in interface org.ojai.Value
Returns the value as an Object of the underlying type.
getOp() - Method in interface org.ojai.store.cdc.ChangeDataReader
Returns the ChangeOp of the current change node.
getOp() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the ChangeOp of the current change node.
getOpTimestamp() - Method in interface org.ojai.store.cdc.ChangeDataReader
Returns the logical time of the data.
getOpTimestamp() - Method in interface org.ojai.store.cdc.ChangeDataRecord
Returns the logical time of the data.
getOpTimestamp() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the logical time of the data.
getOption(String) - Method in interface org.ojai.store.Query
Returns the value of the named query option.
getOpValue() - Method in class org.ojai.store.MutationOp
 
getQueryPlan() - Method in class org.ojai.base.QueryResultBase
 
getQueryPlan() - Method in interface org.ojai.store.QueryResult
Returns a query plan that was used for this QueryResults
getQueryPlan() - Method in class org.ojai.util.EmptyQueryResult
 
getReader() - Method in interface org.ojai.store.cdc.ChangeDataRecord
Returns a new ChangeDataReader for this change data record.
getRootSegment() - Method in class org.ojai.FieldPath
 
getSecond() - Method in class org.ojai.types.OTime
 
getSecond() - Method in class org.ojai.types.OTimestamp
 
getSeconds() - Method in class org.ojai.types.OInterval
 
getServerTimestamp() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getServerTimestamp() - Method in interface org.ojai.store.cdc.ChangeDataRecord
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.
getServerTimestamp() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the server timestamp of this change operation as number of milliseconds since Unix epoch.
getShort(String) - Method in class org.ojai.base.DocumentBase
 
getShort(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a short.
getShort(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a short.
getShort() - Method in interface org.ojai.DocumentReader
 
getShort() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getShort() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the value as a short.
getShort() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getShort(Document, FieldPath, short) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a short or the specified defaultValue if the specified FieldPath does not exist in the document.
getShort(Document, String, short) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a short or the specified defaultValue if the specified FieldPath does not exist in the document.
getShort() - Method in interface org.ojai.Value
Returns the value as a short.
getShortObj(String) - Method in class org.ojai.base.DocumentBase
 
getShortObj(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a Short object or null if the specified FieldPath does not exist in the document.
getShortObj(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a Short object or null if the specified FieldPath does not exist in the document.
getStore(String) - Method in interface org.ojai.store.Connection
Returns a handle to an OJAI DocumentStore specified by the given name or path.
getStore(String, Document) - Method in interface org.ojai.store.Connection
Returns a handle to an OJAI DocumentStore specified by the given name or path.
getString(String) - Method in class org.ojai.base.DocumentBase
 
getString(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a String object or null if the specified FieldPath does not exist in the document.
getString(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a String object or null if the specified FieldPath does not exist in the document.
getString() - Method in interface org.ojai.DocumentReader
 
getString() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getString() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the value as a String.
getString() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getString(Document, FieldPath, String) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a String or the specified defaultValue if the specified FieldPath does not exist in the document.
getString(Document, String, String) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a String or the specified defaultValue if the specified FieldPath does not exist in the document.
getString() - Method in interface org.ojai.Value
Returns the value as a String.
getTagName() - Method in enum org.ojai.store.QueryCondition.Op
 
getTagName() - Method in enum org.ojai.Value.Type
 
getTagNames() - Method in enum org.ojai.store.QueryCondition.Op
 
getTime(String) - Method in class org.ojai.base.DocumentBase
 
getTime(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a OTime object or null if the specified FieldPath does not exist in the document.
getTime(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a OTime object or null if the specified FieldPath does not exist in the document.
getTime() - Method in interface org.ojai.DocumentReader
 
getTime() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getTime() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the value as a OTime object.
getTime() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getTime(Document, FieldPath, OTime) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a OTime or the specified defaultValue if the specified FieldPath does not exist in the document.
getTime(Document, String, OTime) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a OTime or the specified defaultValue if the specified FieldPath does not exist in the document.
getTime() - Method in interface org.ojai.Value
Returns the value as a OTime object.
getTimeAsInt() - Method in interface org.ojai.store.cdc.ChangeNode
Returns an int representing the number of milliseconds since midnight.
getTimeAsInt() - Method in interface org.ojai.Value
Returns a int representing the number of milliseconds since midnight.
getTimeInMillis() - Method in class org.ojai.types.OInterval
Returns the value of this duration in milliseconds computed from individual fields.
getTimeInt() - Method in interface org.ojai.DocumentReader
 
getTimeInt() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getTimeInt() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getTimestamp(String) - Method in class org.ojai.base.DocumentBase
 
getTimestamp(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a OTimestamp object or null if the specified FieldPath does not exist in the document.
getTimestamp(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a OTimestamp object or null if the specified FieldPath does not exist in the document.
getTimestamp() - Method in interface org.ojai.DocumentReader
 
getTimestamp() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getTimestamp() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the value as a OTimestamp object.
getTimestamp() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getTimestamp(Document, FieldPath, OTimestamp) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a OTimestamp or the specified defaultValue if the specified FieldPath does not exist in the document.
getTimestamp(Document, String, OTimestamp) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a OTimestamp or the specified defaultValue if the specified FieldPath does not exist in the document.
getTimestamp() - Method in interface org.ojai.Value
Returns the value as a OTimestamp object.
getTimestampAsLong() - Method in interface org.ojai.store.cdc.ChangeNode
Returns a long value representing the number of milliseconds since epoch.
getTimestampAsLong() - Method in interface org.ojai.Value
Returns a long value representing the number of milliseconds since epoch.
getTimestampLong() - Method in interface org.ojai.DocumentReader
 
getTimestampLong() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getTimestampLong() - Method in class org.ojai.util.DocumentReaderWithProjection
 
getType() - Method in interface org.ojai.store.cdc.ChangeDataReader
 
getType() - Method in interface org.ojai.store.cdc.ChangeDataRecord
Returns the ChangeDataRecordType associated with this change data record.
getType() - Method in interface org.ojai.store.cdc.ChangeNode
Returns the type of the OJAI Value of the current node.
Returns null if ChangeOp is not SET or MERGE.
getType() - Method in class org.ojai.store.MutationOp
 
getType() - Method in interface org.ojai.Value
 
getTypeForEventType(DocumentReader.EventType) - Static method in class org.ojai.util.Types
Returns the Type for the specified EventType.
getTypeTag(Value) - Static method in class org.ojai.util.Types
 
getTypeTag(Value.Type) - Static method in class org.ojai.util.Types
 
getValue(String) - Method in class org.ojai.base.DocumentBase
 
getValue(String) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a Value object or null if the specified FieldPath does not exist in the document.
getValue(FieldPath) - Method in interface org.ojai.Document
Returns the value at the specified fieldPath as a Value object or null if the specified FieldPath does not exist in the document.
getValue() - Method in class org.ojai.json.Events.EventDescriptor
 
getValue() - Method in interface org.ojai.KeyValue
Returns the value corresponding to this KeyValue.
getValue() - Method in interface org.ojai.store.cdc.ChangeNode
Returns The OJAI Value of the current node.
getValue(Document, FieldPath, Value) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a Value or the specified defaultValue if the specified FieldPath does not exist in the document.
getValue(Document, String, Value) - Static method in class org.ojai.util.Documents
Returns the value at the specified fieldPath as a Value or the specified defaultValue if the specified FieldPath does not exist in the document.
getValueBuilder() - Static method in class org.ojai.json.Json
Returns a ValueBuilder object.
getValueBuilder() - Method in interface org.ojai.store.Connection
Returns a ValueBuilder object from this Connection.
getValueBuilder() - Method in interface org.ojai.store.Driver
Returns a ValueBuilder object from this Driver.
getYear() - Method in class org.ojai.types.ODate
 
getYear() - Method in class org.ojai.types.OTimestamp
 
getYears() - Method in class org.ojai.types.OInterval
 

H

hash - Variable in class org.ojai.FieldSegment
 
hashCode() - Method in class org.ojai.FieldPath
 
hashCode() - Method in class org.ojai.FieldSegment
 
hashCode() - Method in class org.ojai.types.ODate
 
hashCode() - Method in class org.ojai.types.OInterval
 
hashCode() - Method in class org.ojai.types.OTime
 
hashCode() - Method in class org.ojai.types.OTimestamp
 
hasIndex() - Method in class org.ojai.FieldSegment.IndexSegment
 

I

ID_FIELD - Static variable in class org.ojai.DocumentConstants
FieldPath of the key used to refer the id of a Document.
ID_KEY - Static variable in class org.ojai.DocumentConstants
Name of the key used to refer the id of a Document.
IllegalMutationException - Exception in org.ojai.store.exceptions
Thrown when a DocumentStore#update() requests a mutation which could structurally alter a Document without such intention.

For example, if DocumentMutation#set() is used to set a field to a scalar value but is currently a Map or array, the mutation is rejected.

Use DocumentMutation#setOrReplace() instead to force such mutation.

IllegalMutationException() - Constructor for exception org.ojai.store.exceptions.IllegalMutationException
 
IllegalMutationException(String) - Constructor for exception org.ojai.store.exceptions.IllegalMutationException
 
IllegalMutationException(Throwable) - Constructor for exception org.ojai.store.exceptions.IllegalMutationException
 
IllegalMutationException(String, Throwable) - Constructor for exception org.ojai.store.exceptions.IllegalMutationException
 
in(String, List<? extends Object>) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is equal to at least one of the values in the specified List.
in(FieldPath, List<? extends Object>) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is equal to at least one of the values in the specified List.
inArray() - Method in interface org.ojai.store.cdc.ChangeDataReader
If it returns true, the current field is in an array; otherwise, the current field is not in an array.
includeAllChildren - Variable in class org.ojai.util.BaseFieldProjector
This flag indicates that the current Field should be projected because its FieldPath is a descendant of one of the projected fields.
includeField - Variable in class org.ojai.util.BaseFieldProjector
This flag indicates that the current Field should be projected because its FieldPath is a "suffix" of the FieldPath of one of the projected fields.
increment(Value, String, byte) - Method in class org.ojai.store.base.ForwardingStore
 
increment(Value, String, short) - Method in class org.ojai.store.base.ForwardingStore
 
increment(Value, String, int) - Method in class org.ojai.store.base.ForwardingStore
 
increment(Value, String, long) - Method in class org.ojai.store.base.ForwardingStore
 
increment(Value, String, float) - Method in class org.ojai.store.base.ForwardingStore
 
increment(Value, String, double) - Method in class org.ojai.store.base.ForwardingStore
 
increment(Value, String, BigDecimal) - Method in class org.ojai.store.base.ForwardingStore
 
increment(String, String, byte) - Method in class org.ojai.store.base.ForwardingStore
 
increment(String, String, short) - Method in class org.ojai.store.base.ForwardingStore
 
increment(String, String, int) - Method in class org.ojai.store.base.ForwardingStore
 
increment(String, String, long) - Method in class org.ojai.store.base.ForwardingStore
 
increment(String, String, float) - Method in class org.ojai.store.base.ForwardingStore
 
increment(String, String, double) - Method in class org.ojai.store.base.ForwardingStore
 
increment(String, String, BigDecimal) - Method in class org.ojai.store.base.ForwardingStore
 
increment(FieldPath, byte) - Method in interface org.ojai.store.DocumentMutation
Atomically increment the existing value at given the FieldPath by the given value.
increment(String, byte) - Method in interface org.ojai.store.DocumentMutation
Atomically increment the existing value at given the FieldPath by the given value.
increment(FieldPath, short) - Method in interface org.ojai.store.DocumentMutation
Atomically increment the existing value at given the FieldPath by the given value.
increment(String, short) - Method in interface org.ojai.store.DocumentMutation
Atomically increment the existing value at given the FieldPath by the given value.
increment(String, int) - Method in interface org.ojai.store.DocumentMutation
Atomically increment the existing value at given the FieldPath by the given value.
increment(FieldPath, int) - Method in interface org.ojai.store.DocumentMutation
Atomically increment the existing value at given the FieldPath by the given value.
increment(FieldPath, long) - Method in interface org.ojai.store.DocumentMutation
Atomically increment the existing value at given the FieldPath by the given value.
increment(String, long) - Method in interface org.ojai.store.DocumentMutation
Atomically increment the existing value at given the FieldPath by the given value.
increment(String, float) - Method in interface org.ojai.store.DocumentMutation
Atomically increment the existing value at given the FieldPath by the given value.
increment(FieldPath, float) - Method in interface org.ojai.store.DocumentMutation
Atomically increment the field specified by the FieldPath by the given value.
increment(String, double) - Method in interface org.ojai.store.DocumentMutation
 
increment(FieldPath, double) - Method in interface org.ojai.store.DocumentMutation
Atomically increment the existing value at given the FieldPath by the given value.
increment(String, BigDecimal) - Method in interface org.ojai.store.DocumentMutation
Atomically increment the existing value at given the FieldPath by the given value.
increment(FieldPath, BigDecimal) - Method in interface org.ojai.store.DocumentMutation
Atomically increment the existing value at given the FieldPath by the given value.
increment(String, String, byte) - Method in interface org.ojai.store.DocumentStore
Atomically applies an increment to a given field (in dot separated notation) of the given document id.
increment(String, String, short) - Method in interface org.ojai.store.DocumentStore
 
increment(String, String, int) - Method in interface org.ojai.store.DocumentStore
 
increment(String, String, long) - Method in interface org.ojai.store.DocumentStore
 
increment(String, String, float) - Method in interface org.ojai.store.DocumentStore
 
increment(String, String, double) - Method in interface org.ojai.store.DocumentStore
 
increment(String, String, BigDecimal) - Method in interface org.ojai.store.DocumentStore
 
increment(Value, String, byte) - Method in interface org.ojai.store.DocumentStore
 
increment(Value, String, short) - Method in interface org.ojai.store.DocumentStore
 
increment(Value, String, int) - Method in interface org.ojai.store.DocumentStore
 
increment(Value, String, long) - Method in interface org.ojai.store.DocumentStore
 
increment(Value, String, float) - Method in interface org.ojai.store.DocumentStore
 
increment(Value, String, double) - Method in interface org.ojai.store.DocumentStore
 
increment(Value, String, BigDecimal) - Method in interface org.ojai.store.DocumentStore
 
IndexSegment(String, FieldSegment) - Constructor for class org.ojai.FieldSegment.IndexSegment
For Antlr parser's use only.
IndexSegment(int, FieldSegment) - Constructor for class org.ojai.FieldSegment.IndexSegment
 
inMap() - Method in interface org.ojai.DocumentReader
 
inMap() - Method in interface org.ojai.store.cdc.ChangeDataReader
If it returns true, the current field is in a map; otherwise, the current field is not in a map.
inMap() - Method in class org.ojai.util.DocumentReaderWithProjection
 
insert(Value, Document) - Method in class org.ojai.store.base.ForwardingStore
 
insert(String, Document) - Method in class org.ojai.store.base.ForwardingStore
 
insert(Document) - Method in class org.ojai.store.base.ForwardingStore
 
insert(Document, FieldPath) - Method in class org.ojai.store.base.ForwardingStore
 
insert(Document, String) - Method in class org.ojai.store.base.ForwardingStore
 
insert(DocumentStream) - Method in class org.ojai.store.base.ForwardingStore
 
insert(DocumentStream, FieldPath) - Method in class org.ojai.store.base.ForwardingStore
 
insert(DocumentStream, String) - Method in class org.ojai.store.base.ForwardingStore
 
insert(String, Document) - Method in interface org.ojai.store.DocumentStore
Inserts a document with the given id.
insert(Value, Document) - Method in interface org.ojai.store.DocumentStore
 
insert(Document) - Method in interface org.ojai.store.DocumentStore
 
insert(Document, FieldPath) - Method in interface org.ojai.store.DocumentStore
 
insert(Document, String) - Method in interface org.ojai.store.DocumentStore
 
insert(DocumentStream) - Method in interface org.ojai.store.DocumentStore
Inserts a set of documents represented by the DocumentStream into the DocumentStore.
insert(DocumentStream, FieldPath) - Method in interface org.ojai.store.DocumentStore
 
insert(DocumentStream, String) - Method in interface org.ojai.store.DocumentStore
 
insertOrReplace(Value, Document) - Method in class org.ojai.store.base.ForwardingStore
 
insertOrReplace(Document) - Method in class org.ojai.store.base.ForwardingStore
 
insertOrReplace(String, Document) - Method in class org.ojai.store.base.ForwardingStore
 
insertOrReplace(Document, FieldPath) - Method in class org.ojai.store.base.ForwardingStore
 
insertOrReplace(Document, String) - Method in class org.ojai.store.base.ForwardingStore
 
insertOrReplace(DocumentStream) - Method in class org.ojai.store.base.ForwardingStore
 
insertOrReplace(DocumentStream, FieldPath) - Method in class org.ojai.store.base.ForwardingStore
 
insertOrReplace(DocumentStream, String) - Method in class org.ojai.store.base.ForwardingStore
 
insertOrReplace(Document) - Method in interface org.ojai.store.DocumentStore
Inserts or replaces a new document in this DocumentStore.
insertOrReplace(String, Document) - Method in interface org.ojai.store.DocumentStore
Inserts or replaces a new document in this DocumentStore with the given _id.
insertOrReplace(Value, Document) - Method in interface org.ojai.store.DocumentStore
Inserts or replaces a new document in this DocumentStore with the given _id.
insertOrReplace(Document, FieldPath) - Method in interface org.ojai.store.DocumentStore
Inserts or replaces a new document in this DocumentStore with the value of the specified Field as the _id.
insertOrReplace(Document, String) - Method in interface org.ojai.store.DocumentStore
Inserts or replaces a new document in this DocumentStore with the value of the specified Field as the _id.
insertOrReplace(DocumentStream) - Method in interface org.ojai.store.DocumentStore
Inserts all documents from the specified DocumentStream into this DocumentStore.
insertOrReplace(DocumentStream, FieldPath) - Method in interface org.ojai.store.DocumentStore
Inserts all documents from the specified DocumentStream into this DocumentStore using the field specified by parameter fieldAsKey as the "_id" field.
insertOrReplace(DocumentStream, String) - Method in interface org.ojai.store.DocumentStore
Inserts all documents from the specified DocumentStream into this DocumentStore using the field specified by parameter fieldAsKey as the "_id" field.
is(String, QueryCondition.Op, boolean) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified boolean value.
is(FieldPath, QueryCondition.Op, boolean) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified boolean value.
is(String, QueryCondition.Op, String) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified String value.
is(FieldPath, QueryCondition.Op, String) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified String value.
is(String, QueryCondition.Op, byte) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified byte value.
is(FieldPath, QueryCondition.Op, byte) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified byte value.
is(String, QueryCondition.Op, short) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified short value.
is(FieldPath, QueryCondition.Op, short) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified short value.
is(String, QueryCondition.Op, int) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified int value.
is(FieldPath, QueryCondition.Op, int) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified int value.
is(String, QueryCondition.Op, long) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified long value.
is(FieldPath, QueryCondition.Op, long) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified long value.
is(String, QueryCondition.Op, float) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified float value.
is(FieldPath, QueryCondition.Op, float) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified float value.
is(String, QueryCondition.Op, double) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified double value.
is(FieldPath, QueryCondition.Op, double) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified double value.
is(String, QueryCondition.Op, BigDecimal) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified BigDecimal value.
is(FieldPath, QueryCondition.Op, BigDecimal) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified BigDecimal value.
is(String, QueryCondition.Op, ODate) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified Date value.
is(FieldPath, QueryCondition.Op, ODate) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified Date value.
is(String, QueryCondition.Op, OTime) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified Time value.
is(FieldPath, QueryCondition.Op, OTime) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified Time value.
is(String, QueryCondition.Op, OTimestamp) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified Timestamp value.
is(FieldPath, QueryCondition.Op, OTimestamp) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified Timestamp value.
is(String, QueryCondition.Op, OInterval) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified Interval value.
is(FieldPath, QueryCondition.Op, OInterval) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified Interval value.
is(String, QueryCondition.Op, ByteBuffer) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified ByteBuffer value.
is(FieldPath, QueryCondition.Op, ByteBuffer) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified ByteBuffer value.
isArray() - Method in class org.ojai.FieldSegment
 
isAtOrAbove(FieldPath) - Method in class org.ojai.FieldPath
 
isAtOrBelow(FieldPath) - Method in class org.ojai.FieldPath
 
isBuilt() - Method in interface org.ojai.Buildable
 
isClosed() - Method in class org.ojai.base.DocumentStreamBase
 
isDone() - Method in class org.ojai.util.BaseFieldProjector
Returns true if ProjectionTree has visited all nodes
isEmpty() - Method in interface org.ojai.Container
 
isExtendedType(Value) - Static method in class org.ojai.util.Types
 
isExtendedType(Value.Type) - Static method in class org.ojai.util.Types
 
isIndexed() - Method in class org.ojai.FieldSegment.IndexSegment
 
isIndexed() - Method in class org.ojai.FieldSegment
 
isIntrinsic() - Method in enum org.ojai.Value.Type
 
isLastPath() - Method in class org.ojai.FieldSegment
 
isLeaf() - Method in class org.ojai.FieldSegment
 
isMap() - Method in class org.ojai.FieldSegment
 
isNamed() - Method in class org.ojai.FieldSegment
 
isNamed() - Method in class org.ojai.FieldSegment.NameSegment
 
isNumeric() - Method in enum org.ojai.Value.Type
 
isPretty() - Method in class org.ojai.json.JsonOptions
 
isReadOnly() - Method in interface org.ojai.Container
 
isReadOnly() - Method in interface org.ojai.Document
Returns true if this Document does not support any write operations like set/delete etc.
isReadOnly() - Method in class org.ojai.store.base.ForwardingStore
 
isReadOnly() - Method in interface org.ojai.store.DocumentStore
Returns true if this Document store does not support any write operations like insert/update/delete, etc.
isScalar() - Method in enum org.ojai.Value.Type
 
isUsed - Variable in class org.ojai.base.DocumentStreamBase
Indicates that one of documentReaders(), iterator(), or streamTo() has been called.
isWithTags() - Method in class org.ojai.json.JsonOptions
 
iterator() - Method in class org.ojai.base.DocumentStreamBase
 
iterator() - Method in interface org.ojai.DocumentStream
Returns an iterator over a set of Document.
iterator() - Method in class org.ojai.FieldPath
 
iterator() - Method in interface org.ojai.store.cdc.ChangeDataRecord
Returns an iterator over a set of ChangeNodes which are part of this change data record.
iterator() - Method in exception org.ojai.store.exceptions.MultiOpException
 
iteratorDerived() - Method in class org.ojai.base.DocumentStreamBase
This is the only method deriving class MUST implement.
iteratorDerived() - Method in class org.ojai.util.EmptyDocumentStream
 

J

Json - Class in org.ojai.json
This class serves as a factory for a JSON implementation of all OJAI interfaces.
Json() - Constructor for class org.ojai.json.Json
 
JsonConsts - Class in org.ojai.json
 
JsonConsts() - Constructor for class org.ojai.json.JsonConsts
 
JsonOptions - Class in org.ojai.json
This class encapsulates various options to configure a JSON serializer for Documents.
JsonOptions() - Constructor for class org.ojai.json.JsonOptions
 
JsonString - Interface in org.ojai
 

K

KeyValue<KEY,VALUE> - Interface in org.ojai
 

L

lastSegment - Variable in class org.ojai.util.BaseFieldProjector
 
level - Variable in class org.ojai.util.BaseFieldProjector
 
like(String, String) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is a String and matches the specified SQL LIKE expression.
like(FieldPath, String) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is a String and matches the specified SQL LIKE expression.
like(String, String, Character) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is a String and matches the specified SQL LIKE expression optionally escaped with the specified escape character.
like(FieldPath, String, Character) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is a String and matches the specified SQL LIKE expression optionally escaped with the specified escape character.
LIMIT - Static variable in interface org.ojai.store.Query
OJAI field name for the Query.limit(long) operator
limit(long) - Method in interface org.ojai.store.Query
Restricts the maximum number of documents returned from this query to the specified value.
loadDocument(String) - Static method in class org.ojai.json.Json
Loads a JSON file as OJAI Document.
loadDocument(File) - Static method in class org.ojai.json.Json
Loads a JSON file as OJAI Document.

M

MapEncoder - Class in org.ojai.util
Deprecated.
Use methods from DocumentReaders class.
MapEncoder() - Constructor for class org.ojai.util.MapEncoder
Deprecated.
 
matches(String, String) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is a String and matches the specified regular expression.
matches(FieldPath, String) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is a String and matches the specified regular expression.
merge(String, Document) - Method in interface org.ojai.store.DocumentMutation
Merges the existing MAP at the given FieldPath with the specified Document.
merge(FieldPath, Document) - Method in interface org.ojai.store.DocumentMutation
Merges the existing MAP at the given FieldPath with the specified Document.
merge(String, Map<String, Object>) - Method in interface org.ojai.store.DocumentMutation
Merges the existing MAP at the given FieldPath with the specified Map.
merge(FieldPath, Map<String, Object>) - Method in interface org.ojai.store.DocumentMutation
Merges the existing MAP at the given FieldPath with the specified Map.
MILLISECONDSPERDAY - Static variable in class org.ojai.util.Constants
A long value equal to the number of milliseconds in a day.
MILLISECONDSPERHOUR - Static variable in class org.ojai.util.Constants
A long value equal to the number of milliseconds in an hour.
MILLISECONDSPERMINUTE - Static variable in class org.ojai.util.Constants
A long value equal to the number of milliseconds in a minute.
MILLISECONDSPERSECOND - Static variable in class org.ojai.util.Constants
A long value equal to the number of milliseconds in a second.
moveTo(DocumentReader.EventType) - Method in class org.ojai.util.BaseFieldProjector
This is the main algorithm that determine if the current DocumentReader or MutableFieldSegment node should be included or excluded based on the set of projected fields.
moveTo(MutableFieldSegment, DocumentReader.EventType) - Method in class org.ojai.util.BaseFieldProjector
To be used when input Document is not from a DocumentReader but provided externally as a MutableFieldSegment.
moveTo(DocumentReader.EventType) - Method in class org.ojai.util.FieldProjector
This is the main algorithm that determine if the current DocumentReader node should be included or excluded based on the set of projected fields.
MultiOpException - Exception in org.ojai.store.exceptions
This class is used to wrap an exception for stream processing that fails midway.
MultiOpException(List<FailedOp>) - Constructor for exception org.ojai.store.exceptions.MultiOpException
 
MultiOpException(Throwable, List<FailedOp>) - Constructor for exception org.ojai.store.exceptions.MultiOpException
 
MultiOpException(String, Throwable, List<FailedOp>) - Constructor for exception org.ojai.store.exceptions.MultiOpException
 
MUTATION - Static variable in interface org.ojai.store.DocumentMutation
OJAI field name for the DocumentMutation object.
MutationOp - Class in org.ojai.store
 
MutationOp() - Constructor for class org.ojai.store.MutationOp
 
MutationOp.Type - Enum in org.ojai.store
 

N

NameSegment(String, FieldSegment, boolean) - Constructor for class org.ojai.FieldSegment.NameSegment
For Antlr parser's use only.
newCondition() - Method in interface org.ojai.store.Connection
Creates and returns a new QueryCondition object.
newCondition() - Method in interface org.ojai.store.Driver
Creates and returns a new QueryCondition object.
newDocument() - Static method in class org.ojai.json.Json
Returns a new, empty Document.
newDocument(String) - Static method in class org.ojai.json.Json
Returns a Document built from the specified JSON string.
newDocument(Object) - Static method in class org.ojai.json.Json
Returns a new instance of a Document built from the specified Java bean.
newDocument(Map<String, T>) - Static method in class org.ojai.json.Json
Returns a new instance of a Document built from the specified Map.
newDocument() - Method in interface org.ojai.store.Connection
Creates and returns a new, empty instance of an OJAI Document.
newDocument(String) - Method in interface org.ojai.store.Connection
Returns a new instance of OJAI Document parsed from the specified JSON string.
newDocument(Map<String, Object>) - Method in interface org.ojai.store.Connection
Returns a new instance of Document constructed from the specified Map.
newDocument(Object) - Method in interface org.ojai.store.Connection
Returns a new instance of Document built from the specified Java bean.
newDocument() - Method in interface org.ojai.store.Driver
Creates and returns a new, empty instance of an OJAI Document.
newDocument(String) - Method in interface org.ojai.store.Driver
Returns a new instance of OJAI Document parsed from the specified JSON string.
newDocument(Map<String, Object>) - Method in interface org.ojai.store.Driver
Returns a new instance of Document constructed from the specified Map.
newDocument(Object) - Method in interface org.ojai.store.Driver
Returns a new instance of Document built from the specified Java bean.
newDocumentBuilder() - Static method in class org.ojai.json.Json
Returns a new instance of JSON DocumentBuilder.
newDocumentBuilder(JsonOptions) - Static method in class org.ojai.json.Json
Returns a new instance of JSON DocumentBuilder with the specified JsonOptions.
newDocumentBuilder() - Method in interface org.ojai.store.Connection
Returns a new DocumentBuilder object.
newDocumentBuilder() - Method in interface org.ojai.store.Driver
Returns a new DocumentBuilder object.
newDocumentReader(String) - Static method in class org.ojai.json.Json
Returns a new instance of the JSON DocumentReader.
newDocumentStream(InputStream) - Static method in class org.ojai.json.Json
Returns a new instance of JSON DocumentStream from the specified InputStream.
newDocumentStream(InputStream, Map<FieldPath, Value.Type>) - Static method in class org.ojai.json.Json
Returns a new instance of s JSON DocumentStream from the specified InputStream using the FieldPath => Type mapping to decode the JSON tokens from the stream.
newDocumentStream(InputStream, Events.Delegate) - Static method in class org.ojai.json.Json
 
newDocumentStream(FileSystem, String) - Static method in class org.ojai.json.Json
 
newDocumentStream(FileSystem, String, Map<FieldPath, Value.Type>) - Static method in class org.ojai.json.Json
 
newDocumentStream(FileSystem, String, Events.Delegate) - Static method in class org.ojai.json.Json
 
newMutation() - Method in interface org.ojai.store.Connection
Creates and returns a new DocumentMutation object.
newMutation() - Method in interface org.ojai.store.Driver
Creates and returns a new DocumentMutation object.
newNullValue() - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.NULL.
newQuery() - Method in interface org.ojai.store.Connection
Creates and returns a new Query object.
newQuery(String) - Method in interface org.ojai.store.Connection
Creates and returns a new Query object decoded from the supplied JSON String.
newQuery() - Method in interface org.ojai.store.Driver
Creates and returns a new Query object.
newQuery(String) - Method in interface org.ojai.store.Driver
Creates and returns a new Query object decoded from the supplied JSON String.
newValue(boolean) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.BOOLEAN from the specified boolean value.
newValue(String) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.STRING from the specified String.
newValue(byte) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.BYTE from the specified byte value.
newValue(short) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.SHORT from the specified short value.
newValue(int) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.INT from the specified integer value.
newValue(long) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.LONG from the specified long value.
newValue(float) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.FLOAT from the specified float value.
newValue(double) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.DOUBLE from the specified double value.
newValue(OTime) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.TIME from the specified OTime.
newValue(ODate) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.DATE from the specified ODate.
newValue(BigDecimal) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.DECIMAL from the specified BigDecimal.
newValue(OTimestamp) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.TIMESTAMP from the specified OTimestamp.
newValue(OInterval) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.INTERVAL from the specified OInterval.
newValue(ByteBuffer) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.BINARY from the specified ByteBuffer.
newValue(byte[]) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.BINARY from the specified byte array.
newValue(List<? extends Object>) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.ARRAY from the specified List.
newValue(Map<String, ? extends Object>) - Method in interface org.ojai.store.ValueBuilder
Returns a new Value of Value.Type.MAP from the specified Map.
next() - Method in interface org.ojai.DocumentReader
Moves the DocumentReader to the next node and returns the node type as EventType.
next() - Method in interface org.ojai.store.cdc.ChangeDataReader
Moves the cursor to the next change node and returns the ChangeEvent associated with the node.
next() - Method in class org.ojai.util.DocumentReaderWithProjection
 
notEquals(String, Map<String, ? extends Object>) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath does not equal the specified Map value.
notEquals(FieldPath, Map<String, ? extends Object>) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath does not equal the specified Map value.
notEquals(String, List<? extends Object>) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath does not equal the specified List value.
notEquals(FieldPath, List<? extends Object>) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath does not equal the specified List value.
notExists(String) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests for non-existence of the specified FieldPath.
notExists(FieldPath) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests for non-existence of the specified FieldPath.
notIn(String, List<? extends Object>) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is not equal to any of the values in the specified List.
notIn(FieldPath, List<? extends Object>) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is not equal to any of the values in the specified List.
notLike(String, String) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is a String and does not match the specified SQL LIKE expression.
notLike(FieldPath, String) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is a String and does not match the specified SQL LIKE expression.
notLike(String, String, Character) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is a String and does not match the specified SQL LIKE expression optionally escaped with the specified escape character.
notLike(FieldPath, String, Character) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is a String and does not match the specified SQL LIKE expression optionally escaped with the specified escape character.
notMatches(String, String) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is a String and does not match the specified regular expression.
notMatches(FieldPath, String) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is a String and does not match the specified regular expression.
notTypeOf(String, Value.Type) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is not of the specified Type.
notTypeOf(FieldPath, Value.Type) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is not of the specified Type.

O

ODate - Class in org.ojai.types
An immutable class which encapsulates an OJAI DATE type.
ODate(int, int, int) - Constructor for class org.ojai.types.ODate
Constructs an ODate instance set to the specified year, month and day of the month.
ODate(long) - Constructor for class org.ojai.types.ODate
Constructs an ODate instance from the milliseconds value since the Unix epoch.
ODate(Date) - Constructor for class org.ojai.types.ODate
Constructs an ODate instance from a java.util.Date using exactly the same field values.
OFFSET - Static variable in interface org.ojai.store.Query
OJAI field name for the Query.offset(long) operator
offset(long) - Method in interface org.ojai.store.Query
Zero (0) based index which specifies number of Documents to skip before returning any result.
OInterval - Class in org.ojai.types
An immutable class which encapsulates a time interval.
OInterval(long) - Constructor for class org.ojai.types.OInterval
 
OInterval(String) - Constructor for class org.ojai.types.OInterval
 
OInterval(int, int, int, int, int) - Constructor for class org.ojai.types.OInterval
 
OJAI_PROTOCOL_PATTERN - Static variable in class org.ojai.store.DriverManager
Pattern for OJAI Connection URLs.
OjaiCodec<T> - Interface in org.ojai
Implementation of this interface can be used to encode/decode OJAI Object to/from a target/source format <T>
OjaiException - Exception in org.ojai.exceptions
The parent class of all exceptions thrown from this library.
OjaiException() - Constructor for exception org.ojai.exceptions.OjaiException
 
OjaiException(String, Throwable) - Constructor for exception org.ojai.exceptions.OjaiException
 
OjaiException(String) - Constructor for exception org.ojai.exceptions.OjaiException
 
OjaiException(Throwable) - Constructor for exception org.ojai.exceptions.OjaiException
 
onFailure(Exception) - Method in interface org.ojai.store.OpListener
Called when an Exception occurred while retrieving a Document
onSuccess(Document) - Method in interface org.ojai.store.OpListener
Called when a Document from the async operation is available.
OpListener - Interface in org.ojai.store
 
or() - Method in interface org.ojai.store.QueryCondition
Begins a new OR compound condition block.
ORDERBY - Static variable in interface org.ojai.store.Query
OJAI field name for the Query.orderBy(FieldPath...) operator
orderBy(String...) - Method in interface org.ojai.store.Query
Sets the sort ordering of the returned Documents to the ascending order of specified field paths.
orderBy(FieldPath...) - Method in interface org.ojai.store.Query
Sets the sort ordering of the returned Documents to the ascending order of specified field paths.
orderBy(String, String) - Method in interface org.ojai.store.Query
Sets the sort ordering of the returned Documents to the specified field and order.
orderBy(String, SortOrder) - Method in interface org.ojai.store.Query
Sets the sort ordering of the returned Documents to the specified field and order.
orderBy(FieldPath, SortOrder) - Method in interface org.ojai.store.Query
Sets the sort ordering of the returned Documents to the specified field and order.
org.ojai - package org.ojai
 
org.ojai.annotation - package org.ojai.annotation
 
org.ojai.base - package org.ojai.base
 
org.ojai.beans - package org.ojai.beans
 
org.ojai.exceptions - package org.ojai.exceptions
 
org.ojai.json - package org.ojai.json
 
org.ojai.store - package org.ojai.store
 
org.ojai.store.base - package org.ojai.store.base
 
org.ojai.store.cdc - package org.ojai.store.cdc
 
org.ojai.store.exceptions - package org.ojai.store.exceptions
 
org.ojai.types - package org.ojai.types
 
org.ojai.util - package org.ojai.util
 
OTime - Class in org.ojai.types
An immutable class which encapsulates an OJAI TIME type.
OTime(long) - Constructor for class org.ojai.types.OTime
Constructs an OTime instance from the milliseconds value since the Unix epoch.
OTime(int, int, int) - Constructor for class org.ojai.types.OTime
Constructs an OTime instance set to the specified hour, minute and seconds.
OTime(int, int, int, int) - Constructor for class org.ojai.types.OTime
Constructs an OTime instance set to the specified hour, minute, seconds and milliseconds.
OTime(Date) - Constructor for class org.ojai.types.OTime
Constructs an OTime instance from a java.util.Date using exactly the same field values.
OTimestamp - Class in org.ojai.types
An immutable class which encapsulates an OJAI TIMESTAMP type.
OTimestamp(long) - Constructor for class org.ojai.types.OTimestamp
Constructs an OTimestamp instance from the milliseconds value since the Unix epoch.
OTimestamp(int, int, int, int, int, int, int) - Constructor for class org.ojai.types.OTimestamp
Constructs an OTimestamp instance set to the specified fields in the default time zone.
OTimestamp(Date) - Constructor for class org.ojai.types.OTimestamp
Constructs an OTimestamp instance from a java.util.Date using exactly the same field values.

P

parse(String) - Static method in class org.ojai.types.ODate
Parses and return an instance of ODate from the specified string.
parse(String) - Static method in class org.ojai.types.OTime
Parses and return an instance of OTime from the specified string.
parse(String) - Static method in class org.ojai.types.OTimestamp
Parses and return an instance of OTimestamp from the specified string.
parseBigDecimal(String) - Static method in class org.ojai.util.Values
Converts a string to BigDecimal object.
parseBinary(String) - Static method in class org.ojai.util.Values
Converts a base-64 encoded string to ByteBuffer.
ParseException - Exception in org.ojai.exceptions
 
ParseException() - Constructor for exception org.ojai.exceptions.ParseException
 
ParseException(String, Throwable) - Constructor for exception org.ojai.exceptions.ParseException
 
ParseException(String) - Constructor for exception org.ojai.exceptions.ParseException
 
ParseException(Throwable) - Constructor for exception org.ojai.exceptions.ParseException
 
parseFrom(String) - Static method in class org.ojai.FieldPath
Use this method to translate a String into FieldPath.
pretty() - Method in class org.ojai.json.JsonOptions
 
process(DocumentReader, DocumentReader.EventType, Queue<Events.EventDescriptor>) - Method in class org.ojai.json.Events.BaseDelegate
 
process(DocumentReader, DocumentReader.EventType, Queue<Events.EventDescriptor>) - Method in interface org.ojai.json.Events.Delegate
 
put(String, boolean) - Method in interface org.ojai.DocumentBuilder
Associates the specified boolean value with the specified field in the current map.
put(String, String) - Method in interface org.ojai.DocumentBuilder
Associates the specified String value with the specified field in the current map.
put(String, byte) - Method in interface org.ojai.DocumentBuilder
 
put(String, short) - Method in interface org.ojai.DocumentBuilder
 
put(String, int) - Method in interface org.ojai.DocumentBuilder
 
put(String, long) - Method in interface org.ojai.DocumentBuilder
 
put(String, float) - Method in interface org.ojai.DocumentBuilder
 
put(String, double) - Method in interface org.ojai.DocumentBuilder
 
put(String, BigDecimal) - Method in interface org.ojai.DocumentBuilder
 
put(String, byte[]) - Method in interface org.ojai.DocumentBuilder
 
put(String, byte[], int, int) - Method in interface org.ojai.DocumentBuilder
 
put(String, ByteBuffer) - Method in interface org.ojai.DocumentBuilder
 
put(String, ODate) - Method in interface org.ojai.DocumentBuilder
 
put(String, OTime) - Method in interface org.ojai.DocumentBuilder
 
put(String, OTimestamp) - Method in interface org.ojai.DocumentBuilder
 
put(String, OInterval) - Method in interface org.ojai.DocumentBuilder
 
put(String, Value) - Method in interface org.ojai.DocumentBuilder
 
put(String, Document) - Method in interface org.ojai.DocumentBuilder
 
put(String, Map<String, Object>) - Method in interface org.ojai.DocumentBuilder
 
putDate(String, int) - Method in interface org.ojai.DocumentBuilder
Associates the specified date value represented as the number of days since epoch with the specified field in the current map.
putDecimal(String, long) - Method in interface org.ojai.DocumentBuilder
 
putDecimal(String, double) - Method in interface org.ojai.DocumentBuilder
 
putDecimal(String, int, int) - Method in interface org.ojai.DocumentBuilder
 
putDecimal(String, long, int) - Method in interface org.ojai.DocumentBuilder
 
putDecimal(String, byte[], int) - Method in interface org.ojai.DocumentBuilder
 
putInterval(String, long) - Method in interface org.ojai.DocumentBuilder
 
putInterval(String, int, int, int) - Method in interface org.ojai.DocumentBuilder
 
putNewArray(String) - Method in interface org.ojai.DocumentBuilder
 
putNewMap(String) - Method in interface org.ojai.DocumentBuilder
 
putNull(String) - Method in interface org.ojai.DocumentBuilder
 
putTime(String, int) - Method in interface org.ojai.DocumentBuilder
Associates the specified time value represented as number of milliseconds since midnight with the specified field in the current map.
putTimestamp(String, long) - Method in interface org.ojai.DocumentBuilder
Associates the specified timestamp value represented as the number of milliseconds since epoch with the specified field in the current map.

Q

Query - Interface in org.ojai.store
OJAI interface which lets users build an OJAI Query that can be executed on an OJAI DocumentStore.
QueryCondition - Interface in org.ojai.store
 
QueryCondition.Op - Enum in org.ojai.store
 
QueryResult - Interface in org.ojai.store
 
QueryResultBase - Class in org.ojai.base
 
QueryResultBase() - Constructor for class org.ojai.base.QueryResultBase
 
QueryTimeoutException - Exception in org.ojai.exceptions
Exception thrown in the event of Query timeout.
QueryTimeoutException() - Constructor for exception org.ojai.exceptions.QueryTimeoutException
 
QueryTimeoutException(String, Throwable) - Constructor for exception org.ojai.exceptions.QueryTimeoutException
 
QueryTimeoutException(String) - Constructor for exception org.ojai.exceptions.QueryTimeoutException
 
QueryTimeoutException(Throwable) - Constructor for exception org.ojai.exceptions.QueryTimeoutException
 
quoteFieldName(String) - Static method in class org.ojai.util.Fields
 

R

RangeException - Exception in org.ojai.exceptions
 
RangeException() - Constructor for exception org.ojai.exceptions.RangeException
 
RangeException(String, Throwable) - Constructor for exception org.ojai.exceptions.RangeException
 
RangeException(String) - Constructor for exception org.ojai.exceptions.RangeException
 
RangeException(Throwable) - Constructor for exception org.ojai.exceptions.RangeException
 
readerFieldSegment - Variable in class org.ojai.util.BaseFieldProjector
 
readOnly(Document) - Static method in class org.ojai.util.Documents
Creates and return a read-only view of the specified OJAI document.

Any attempt to modify the returned document will result in ReadOnlyObjectException being thrown.

ReadOnlyObjectException - Exception in org.ojai.exceptions
 
ReadOnlyObjectException() - Constructor for exception org.ojai.exceptions.ReadOnlyObjectException
Default constructor.
ReadOnlyObjectException(String) - Constructor for exception org.ojai.exceptions.ReadOnlyObjectException
Constructor.
ReadOnlyObjectException(Throwable) - Constructor for exception org.ojai.exceptions.ReadOnlyObjectException
Constructor taking another exception.
ReadOnlyObjectException(String, Throwable) - Constructor for exception org.ojai.exceptions.ReadOnlyObjectException
Constructor taking a message and another exception.
registerDriver(Driver) - Static method in class org.ojai.store.DriverManager
Registers the specified Driver with this DriverManager.
replace(Value, Document) - Method in class org.ojai.store.base.ForwardingStore
 
replace(String, Document) - Method in class org.ojai.store.base.ForwardingStore
 
replace(Document) - Method in class org.ojai.store.base.ForwardingStore
 
replace(Document, FieldPath) - Method in class org.ojai.store.base.ForwardingStore
 
replace(Document, String) - Method in class org.ojai.store.base.ForwardingStore
 
replace(DocumentStream) - Method in class org.ojai.store.base.ForwardingStore
 
replace(DocumentStream, FieldPath) - Method in class org.ojai.store.base.ForwardingStore
 
replace(DocumentStream, String) - Method in class org.ojai.store.base.ForwardingStore
 
replace(String, Document) - Method in interface org.ojai.store.DocumentStore
Replaces a document in the DocumentStore.
replace(Value, Document) - Method in interface org.ojai.store.DocumentStore
 
replace(Document) - Method in interface org.ojai.store.DocumentStore
 
replace(Document, FieldPath) - Method in interface org.ojai.store.DocumentStore
 
replace(Document, String) - Method in interface org.ojai.store.DocumentStore
 
replace(DocumentStream) - Method in interface org.ojai.store.DocumentStore
Replaces a set of documents represented by the DocumentStream into the DocumentStore.
replace(DocumentStream, FieldPath) - Method in interface org.ojai.store.DocumentStore
 
replace(DocumentStream, String) - Method in interface org.ojai.store.DocumentStore
 
reset(DocumentReader) - Method in class org.ojai.util.BaseFieldProjector
Resets the state of this projection tree to the root of the Document.
reset() - Method in class org.ojai.util.BaseFieldProjector
Resets the state of this projection tree to the root of the Document when not using with a DocumentReader.
reset(DocumentReader) - Method in class org.ojai.util.FieldProjector
Resets the state of this projection tree to the root of the Document.
rootSegment - Variable in class org.ojai.util.BaseFieldProjector
 

S

SecurityException - Exception in org.ojai.store.exceptions
 
SecurityException() - Constructor for exception org.ojai.store.exceptions.SecurityException
 
SecurityException(String, Throwable) - Constructor for exception org.ojai.store.exceptions.SecurityException
 
SecurityException(String) - Constructor for exception org.ojai.store.exceptions.SecurityException
 
SecurityException(Throwable) - Constructor for exception org.ojai.store.exceptions.SecurityException
 
SEGMENT_QUOTE_CHAR - Static variable in class org.ojai.util.Fields
 
segmentAfterAncestor(FieldPath) - Method in class org.ojai.FieldPath
 
segmentCompareTo(FieldSegment) - Method in class org.ojai.FieldSegment.IndexSegment
 
segmentCompareTo(FieldSegment) - Method in class org.ojai.FieldSegment.NameSegment
 
segmentEquals(FieldSegment) - Method in class org.ojai.FieldSegment.IndexSegment
 
segmentEquals(FieldSegment) - Method in class org.ojai.FieldSegment.NameSegment
 
segmentEquals(FieldSegment) - Method in class org.ojai.FieldSegment
 
segmentHashCode() - Method in class org.ojai.FieldSegment.IndexSegment
 
segmentHashCode() - Method in class org.ojai.FieldSegment.NameSegment
 
segmentHashCode() - Method in class org.ojai.FieldSegment
 
SELECT - Static variable in interface org.ojai.store.Query
OJAI field name for the Query.select(FieldPath...) operator.
select(String...) - Method in interface org.ojai.store.Query
Adds the list of field paths to the list of projected fields.
select(FieldPath...) - Method in interface org.ojai.store.Query
Adds the list of field paths to the list of projected fields.
set(String, String) - Method in class org.ojai.base.DocumentBase
 
set(String, boolean) - Method in class org.ojai.base.DocumentBase
 
set(String, byte) - Method in class org.ojai.base.DocumentBase
 
set(String, short) - Method in class org.ojai.base.DocumentBase
 
set(String, int) - Method in class org.ojai.base.DocumentBase
 
set(String, long) - Method in class org.ojai.base.DocumentBase
 
set(String, float) - Method in class org.ojai.base.DocumentBase
 
set(String, double) - Method in class org.ojai.base.DocumentBase
 
set(String, OTime) - Method in class org.ojai.base.DocumentBase
 
set(String, ODate) - Method in class org.ojai.base.DocumentBase
 
set(String, OTimestamp) - Method in class org.ojai.base.DocumentBase
 
set(String, BigDecimal) - Method in class org.ojai.base.DocumentBase
 
set(String, byte[]) - Method in class org.ojai.base.DocumentBase
 
set(String, byte[], int, int) - Method in class org.ojai.base.DocumentBase
 
set(String, ByteBuffer) - Method in class org.ojai.base.DocumentBase
 
set(String, OInterval) - Method in class org.ojai.base.DocumentBase
 
set(String, Map<String, ? extends Object>) - Method in class org.ojai.base.DocumentBase
 
set(String, Document) - Method in class org.ojai.base.DocumentBase
 
set(String, Value) - Method in class org.ojai.base.DocumentBase
 
set(String, List<? extends Object>) - Method in class org.ojai.base.DocumentBase
 
set(String, String) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified String.
set(FieldPath, String) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified String.
set(String, boolean) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified boolean value.
set(FieldPath, boolean) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified boolean value.
set(String, byte) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified byte value.
set(FieldPath, byte) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified byte value.
set(String, short) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified short value.
set(FieldPath, short) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified short value.
set(String, int) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified int value.
set(FieldPath, int) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified int value.
set(String, long) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified long value.
set(FieldPath, long) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified long value.
set(String, float) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified float value.
set(FieldPath, float) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified float value.
set(String, double) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified double value.
set(FieldPath, double) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified double value.
set(String, BigDecimal) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified BigDecimal.
set(FieldPath, BigDecimal) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified BigDecimal.
set(String, OTime) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Time.
set(FieldPath, OTime) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Time.
set(String, ODate) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Date.
set(FieldPath, ODate) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Date.
set(String, OTimestamp) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Timestamp.
set(FieldPath, OTimestamp) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Timestamp.
set(String, OInterval) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Interval.
set(FieldPath, OInterval) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Interval.
set(String, byte[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified binary value.
set(FieldPath, byte[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified binary value.
set(String, byte[], int, int) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified binary value.
set(FieldPath, byte[], int, int) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified binary value.
set(String, ByteBuffer) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified ByteBuffer.
set(FieldPath, ByteBuffer) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified ByteBuffer.
set(String, Map<String, ? extends Object>) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Map.
set(FieldPath, Map<String, ? extends Object>) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Map.
set(String, Document) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Document.
set(FieldPath, Document) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Document.
set(String, Value) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Value.
set(FieldPath, Value) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Value.
set(String, List<? extends Object>) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Object List.
set(FieldPath, List<? extends Object>) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Object List.
set(String, Value) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified value.
set(FieldPath, Value) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified value.
set(String, boolean) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified boolean value.
set(FieldPath, boolean) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified boolean value.
set(String, byte) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified byte value.
set(FieldPath, byte) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified byte value.
set(String, short) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified short value.
set(FieldPath, short) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified short value.
set(String, int) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified int value.
set(FieldPath, int) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified int value.
set(String, long) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified long value.
set(FieldPath, long) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified long value.
set(String, float) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified float value.
set(FieldPath, float) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified float value.
set(String, double) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified double value.
set(FieldPath, double) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified double value.
set(String, String) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified String value.
set(FieldPath, String) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified String value.
set(String, BigDecimal) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified BigDecimal value.
set(FieldPath, BigDecimal) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified BigDecimal value.
set(String, ODate) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified Date value.
set(FieldPath, ODate) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified Date value.
set(String, OTime) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified Time value.
set(FieldPath, OTime) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified Time value.
set(String, OTimestamp) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified Timestamp value.
set(FieldPath, OTimestamp) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified Timestamp value.
set(String, OInterval) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified Interval value.
set(FieldPath, OInterval) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified Interval value.
set(String, ByteBuffer) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified ByteBuffer.
set(FieldPath, ByteBuffer) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified ByteBuffer.
set(String, List<? extends Object>) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified List.
set(FieldPath, List<? extends Object>) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified List.
set(String, Map<String, ? extends Object>) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified Map.
set(FieldPath, Map<String, ? extends Object>) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified Map.
set(String, Document) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified Document.
set(FieldPath, Document) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to the specified Document.
setArray(String, Object...) - Method in class org.ojai.base.DocumentBase
 
setArray(String, byte[]) - Method in class org.ojai.base.DocumentBase
 
setArray(String, short[]) - Method in class org.ojai.base.DocumentBase
 
setArray(String, int[]) - Method in class org.ojai.base.DocumentBase
 
setArray(String, long[]) - Method in class org.ojai.base.DocumentBase
 
setArray(String, float[]) - Method in class org.ojai.base.DocumentBase
 
setArray(String, double[]) - Method in class org.ojai.base.DocumentBase
 
setArray(String, String[]) - Method in class org.ojai.base.DocumentBase
 
setArray(String, boolean[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified boolean array.
setArray(FieldPath, boolean[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified boolean array.
setArray(String, byte[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified byte array.
setArray(FieldPath, byte[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified byte array.
setArray(String, short[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified short array.
setArray(FieldPath, short[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified short array.
setArray(String, int[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified int array.
setArray(FieldPath, int[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified int array.
setArray(String, long[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified long array.
setArray(FieldPath, long[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified long array.
setArray(String, float[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified float array.
setArray(FieldPath, float[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified float array.
setArray(String, double[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified double array.
setArray(FieldPath, double[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified double array.
setArray(String, String[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified String array.
setArray(FieldPath, String[]) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified String array.
setArray(String, Object...) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Object array.
setArray(FieldPath, Object...) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to the specified Object array.
setArrayIndex(int) - Method in interface org.ojai.DocumentBuilder
Sets the index in the current array at which the next value will be added.
setFieldName(String) - Method in class org.ojai.json.Events.EventDescriptor
 
setFieldPath(FieldPath) - Method in class org.ojai.store.MutationOp
 
setId(Value) - Method in interface org.ojai.Document
Sets the the "_id" field of this Document to the specified Value.
setId(String) - Method in interface org.ojai.Document
Sets the the "_id" field of this Document to the specified string.
setId(ByteBuffer) - Method in interface org.ojai.Document
Sets the "_id" field of this Document to the specified string.
setIndex(int) - Method in class org.ojai.json.Events.EventDescriptor
 
setNull(String) - Method in class org.ojai.base.DocumentBase
 
setNull(String) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to Value.Type.NULL.
setNull(FieldPath) - Method in interface org.ojai.Document
Sets the value of the specified fieldPath in this Document to Value.Type.NULL.
setNull(String) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to NULL Value.
setNull(FieldPath) - Method in interface org.ojai.store.DocumentMutation
Sets the field at the given FieldPath to NULL Value.
setOption(String, Object) - Method in interface org.ojai.store.Query
Sets a named query option.
setOptions(Document) - Method in interface org.ojai.store.Query
Sets multiple query options for this Query.
setOpValue(Value) - Method in class org.ojai.store.MutationOp
 
setOrReplace(String, Value) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the new value.
setOrReplace(FieldPath, Value) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the new value.
setOrReplace(String, boolean) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified boolean value.
setOrReplace(FieldPath, boolean) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified boolean value.
setOrReplace(String, byte) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified byte value.
setOrReplace(FieldPath, byte) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified byte value.
setOrReplace(String, short) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified short value.
setOrReplace(FieldPath, short) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified short value.
setOrReplace(String, int) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified int value.
setOrReplace(FieldPath, int) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified int value.
setOrReplace(String, long) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified long value.
setOrReplace(FieldPath, long) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified long value.
setOrReplace(String, float) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified float value.
setOrReplace(FieldPath, float) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified float value.
setOrReplace(String, double) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified double value.
setOrReplace(FieldPath, double) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified double value.
setOrReplace(String, String) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified String value.
setOrReplace(FieldPath, String) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified String value.
setOrReplace(String, BigDecimal) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified BigDecimal value.
setOrReplace(FieldPath, BigDecimal) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified BigDecimal value.
setOrReplace(String, ODate) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified Date value.
setOrReplace(FieldPath, ODate) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified Date value.
setOrReplace(String, OTime) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified Time value.
setOrReplace(FieldPath, OTime) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified Time value.
setOrReplace(String, OTimestamp) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified Timestamp value.
setOrReplace(FieldPath, OTimestamp) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified Timestamp value.
setOrReplace(String, OInterval) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified Interval.
setOrReplace(FieldPath, OInterval) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified Interval.
setOrReplace(String, ByteBuffer) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified ByteBuffer.
setOrReplace(FieldPath, ByteBuffer) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified ByteBuffer.
setOrReplace(String, List<? extends Object>) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified List.
setOrReplace(FieldPath, List<? extends Object>) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified List.
setOrReplace(String, Map<String, ? extends Object>) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified Map.
setOrReplace(FieldPath, Map<String, ? extends Object>) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified Map.
setOrReplace(String, Document) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified Document.
setOrReplace(FieldPath, Document) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to the specified Document.
setOrReplaceNull(String) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to NULL Value.
setOrReplaceNull(FieldPath) - Method in interface org.ojai.store.DocumentMutation
Sets or replaces the field at the given FieldPath to NULL Value.
setPretty(boolean) - Method in class org.ojai.json.JsonOptions
 
setTimeout(long) - Method in interface org.ojai.store.Query
Sets a duration after which the query will fails with QueryTimeoutException.
setType(MutationOp.Type) - Method in class org.ojai.store.MutationOp
 
setValue(Value) - Method in class org.ojai.json.Events.EventDescriptor
 
setWithTags(boolean) - Method in class org.ojai.json.JsonOptions
 
shouldEmitEvent() - Method in class org.ojai.util.BaseFieldProjector
 
size() - Method in interface org.ojai.Container
 
size() - Method in interface org.ojai.Document
 
sizeOf(String, QueryCondition.Op, long) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the size of the Value at the specified FieldPath satisfies the given QueryCondition.Op and the size.
sizeOf(FieldPath, QueryCondition.Op, long) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the size of the Value at the specified FieldPath satisfies the given QueryCondition.Op and the size.
skipChildren() - Method in class org.ojai.base.DocumentReaderBase
This is a trivial implementation of DocumentReaderBase.skipChildren() API.
skipChildren() - Method in interface org.ojai.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.
skipChildren() - Method in class org.ojai.util.DocumentReaderWithProjection
 
SortOrder - Enum in org.ojai.store
Enumeration specifying the sort ordering.
StoreException - Exception in org.ojai.store.exceptions
This class is the base class of all exceptions thrown from the DocumentStore.
StoreException() - Constructor for exception org.ojai.store.exceptions.StoreException
Default constructor.
StoreException(String) - Constructor for exception org.ojai.store.exceptions.StoreException
Constructor.
StoreException(Throwable) - Constructor for exception org.ojai.store.exceptions.StoreException
Constructor taking another exception.
StoreException(String, Throwable) - Constructor for exception org.ojai.store.exceptions.StoreException
Constructor taking a message and another exception.
storeExists(String) - Method in interface org.ojai.store.Connection
Tests if the OJAI DocumentStore specified by the given name or path exists.
StoreExistsException - Exception in org.ojai.store.exceptions
 
StoreExistsException(String) - Constructor for exception org.ojai.store.exceptions.StoreExistsException
 
StoreExistsException(String, Throwable) - Constructor for exception org.ojai.store.exceptions.StoreExistsException
 
StoreNotFoundException - Exception in org.ojai.store.exceptions
 
StoreNotFoundException(String) - Constructor for exception org.ojai.store.exceptions.StoreNotFoundException
 
StoreNotFoundException(String, Throwable) - Constructor for exception org.ojai.store.exceptions.StoreNotFoundException
 
StreamInUseException - Exception in org.ojai.exceptions
Exception thrown by implementations when a DocumentStream is accessed in more than one way.
StreamInUseException() - Constructor for exception org.ojai.exceptions.StreamInUseException
 
StreamInUseException(String, Throwable) - Constructor for exception org.ojai.exceptions.StreamInUseException
 
StreamInUseException(String) - Constructor for exception org.ojai.exceptions.StreamInUseException
 
StreamInUseException(Throwable) - Constructor for exception org.ojai.exceptions.StreamInUseException
 
streamTo(DocumentListener) - Method in class org.ojai.base.DocumentStreamBase
 
streamTo(DocumentListener) - Method in interface org.ojai.DocumentStream
Streams all the documents in this DocumentStream to the specified listener.

T

TAG_BINARY - Static variable in class org.ojai.util.Types
Deprecated.
TAG_BINARY - Static variable in interface org.ojai.Value
 
TAG_BYTE - Static variable in class org.ojai.util.Types
Deprecated.
TAG_BYTE - Static variable in interface org.ojai.Value
 
TAG_DATE - Static variable in class org.ojai.util.Types
Deprecated.
TAG_DATE - Static variable in interface org.ojai.Value
 
TAG_DECIMAL - Static variable in class org.ojai.util.Types
Deprecated.
TAG_DECIMAL - Static variable in interface org.ojai.Value
 
TAG_FLOAT - Static variable in class org.ojai.util.Types
Deprecated.
TAG_FLOAT - Static variable in interface org.ojai.Value
 
TAG_INT - Static variable in class org.ojai.util.Types
Deprecated.
TAG_INT - Static variable in interface org.ojai.Value
 
TAG_INTERVAL - Static variable in class org.ojai.util.Types
Deprecated.
TAG_INTERVAL - Static variable in interface org.ojai.Value
 
TAG_LONG - Static variable in class org.ojai.util.Types
Deprecated.
TAG_LONG - Static variable in interface org.ojai.Value
 
TAG_SHORT - Static variable in class org.ojai.util.Types
Deprecated.
TAG_SHORT - Static variable in interface org.ojai.Value
 
TAG_TIME - Static variable in class org.ojai.util.Types
Deprecated.
TAG_TIME - Static variable in interface org.ojai.Value
 
TAG_TIMESTAMP - Static variable in class org.ojai.util.Types
Deprecated.
TAG_TIMESTAMP - Static variable in interface org.ojai.Value
 
TAGS_BETWEEN - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for BETWEEN operator.
TAGS_EQUAL - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the QueryCondition.Op.EQUAL operator.
TAGS_EXISTS - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the QueryCondition.exists(FieldPath) operator.
TAGS_GREATER - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the QueryCondition.Op.GREATER operator.
TAGS_GREATER_OR_EQUAL - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the QueryCondition.Op.GREATER_OR_EQUAL operator.
TAGS_IN - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the QueryCondition.in(FieldPath, List) operator.
TAGS_LESS - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the QueryCondition.Op.LESS operator.
TAGS_LESS_OR_EQUAL - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the QueryCondition.Op.LESS_OR_EQUAL operator.
TAGS_LIKE - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the QueryCondition.like(FieldPath, String) operator.
TAGS_MATCHES - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the QueryCondition.matches(FieldPath, String) operator.
TAGS_NOT_EQUAL - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the QueryCondition.Op.NOT_EQUAL operator.
TAGS_NOT_EXISTS - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the QueryCondition.notExists(FieldPath) operator.
TAGS_NOT_IN - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the QueryCondition.notIn(FieldPath, List) operator.
TAGS_NOT_LIKE - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the QueryCondition.notLike(FieldPath, String) operator.
TAGS_NOT_MATCHES - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the QueryCondition.notMatches(FieldPath, String) operator.
TAGS_NOT_TYPE_OF - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the #notTypeOf(FieldPath, Type) operator.
TAGS_SIZE_OF - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the QueryCondition.sizeOf(FieldPath, Op, long) operator.
TAGS_TYPE_OF - Static variable in interface org.ojai.store.QueryCondition
OJAI tag name for the #typeOf(FieldPath, Type) operator.
TIMEZONE_OFFSET - Static variable in class org.ojai.util.Constants
A long value equal to the time zone offset from the GMT in milliseconds.
toDate() - Method in class org.ojai.types.ODate
Get this DATE as a Date in the default timezone.
toDate() - Method in class org.ojai.types.OTime
Get this TIME as a Date in the default timezone.
toDate() - Method in class org.ojai.types.OTimestamp
Get this timestamp as a Date.
toDateStr() - Method in class org.ojai.types.ODate
Returns a string representation of this date in ISO8601 format (yyyy-MM-dd).
toDaysSinceEpoch() - Method in class org.ojai.types.ODate
 
toFieldPathArray(String...) - Static method in class org.ojai.util.Fields
 
toFieldPathStringArray(FieldPath...) - Static method in class org.ojai.util.Fields
 
toFullTimeStr() - Method in class org.ojai.types.OTime
Returns a string representation of this TIME in "HH:mm.ss.SSS" format.
toJavaBean(Class<T>) - Method in interface org.ojai.Document
Converts this Document to an instance of the specified class.
toJsonString(Document) - Static method in class org.ojai.json.Json
 
toJsonString(Document, JsonOptions) - Static method in class org.ojai.json.Json
 
toJsonString(DocumentReader) - Static method in class org.ojai.json.Json
 
toJsonString(DocumentReader, JsonOptions) - Static method in class org.ojai.json.Json
 
toLocalString() - Method in class org.ojai.types.OTimestamp
Returns the ISO8601 format timestamp string in local time zone.
toShortTimeStr() - Method in class org.ojai.types.OTime
 
toString() - Method in interface org.ojai.Document
 
toString() - Method in class org.ojai.FieldPath
 
toString() - Method in class org.ojai.FieldSegment
 
toString() - Method in class org.ojai.json.JsonOptions
 
toString(String) - Method in class org.ojai.types.ODate
Returns a string representation of this date using the specified format pattern.
toString() - Method in class org.ojai.types.ODate
 
toString(String) - Method in class org.ojai.types.OTime
Returns a string representation of this TIME using the specified format pattern.
toString() - Method in class org.ojai.types.OTime
 
toString(String) - Method in class org.ojai.types.OTimestamp
Return the string representation the timestamp using the specified format pattern.
toString() - Method in class org.ojai.types.OTimestamp
 
toString() - Method in class org.ojai.util.BaseFieldProjector
 
toTimeInMillis() - Method in class org.ojai.types.OTime
 
toTimeStr() - Method in class org.ojai.types.OTime
Returns a string representation of this TIME in "HH:mm.ss[.SSS]" format.
toUTCString() - Method in class org.ojai.types.OTimestamp
Returns the ISO8601 format timestamp string in UTC.
type - Variable in class org.ojai.FieldSegment
 
TYPE_CODE_ARRAY - Static variable in interface org.ojai.Value
 
TYPE_CODE_BINARY - Static variable in interface org.ojai.Value
 
TYPE_CODE_BOOLEAN - Static variable in interface org.ojai.Value
 
TYPE_CODE_BYTE - Static variable in interface org.ojai.Value
 
TYPE_CODE_DATE - Static variable in interface org.ojai.Value
 
TYPE_CODE_DECIMAL - Static variable in interface org.ojai.Value
 
TYPE_CODE_DOUBLE - Static variable in interface org.ojai.Value
 
TYPE_CODE_FLOAT - Static variable in interface org.ojai.Value
 
TYPE_CODE_INT - Static variable in interface org.ojai.Value
 
TYPE_CODE_INTERVAL - Static variable in interface org.ojai.Value
 
TYPE_CODE_LONG - Static variable in interface org.ojai.Value
 
TYPE_CODE_MAP - Static variable in interface org.ojai.Value
 
TYPE_CODE_NULL - Static variable in interface org.ojai.Value
 
TYPE_CODE_SHORT - Static variable in interface org.ojai.Value
 
TYPE_CODE_STRING - Static variable in interface org.ojai.Value
 
TYPE_CODE_TIME - Static variable in interface org.ojai.Value
 
TYPE_CODE_TIMESTAMP - Static variable in interface org.ojai.Value
 
TYPE_EVENTTYPE_MAP - Static variable in class org.ojai.util.Types
 
TypeException - Exception in org.ojai.exceptions
 
TypeException() - Constructor for exception org.ojai.exceptions.TypeException
 
TypeException(String, Throwable) - Constructor for exception org.ojai.exceptions.TypeException
 
TypeException(String) - Constructor for exception org.ojai.exceptions.TypeException
 
TypeException(Throwable) - Constructor for exception org.ojai.exceptions.TypeException
 
typeOf(String, Value.Type) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is of the specified Type.
typeOf(FieldPath, Value.Type) - Method in interface org.ojai.store.QueryCondition
Adds a condition that tests if the Value at the specified FieldPath is of the specified Type.
Types - Class in org.ojai.util
A helper class that provides methods for conveniently operating on a Type.
Types() - Constructor for class org.ojai.util.Types
 

U

unEscape(String) - Static method in class org.ojai.FieldSegment.NameSegment
 
unQuote(String) - Static method in class org.ojai.FieldSegment.NameSegment
 
unquoteFieldName(String) - Static method in class org.ojai.util.Fields
 
update(Value, DocumentMutation) - Method in class org.ojai.store.base.ForwardingStore
 
update(String, DocumentMutation) - Method in class org.ojai.store.base.ForwardingStore
 
update(String, DocumentMutation) - Method in interface org.ojai.store.DocumentStore
Applies a mutation on the document identified by the document id.

All updates specified by the mutation object should be applied atomically, and consistently meaning either all of the updates in mutation are applied or none of them is applied and a partial update should not be visible to an observer.
update(Value, DocumentMutation) - Method in interface org.ojai.store.DocumentStore
Applies a mutation on the document identified by the document id.

All updates specified by the mutation object should be applied atomically, and consistently meaning either all of the updates in mutation are applied or none of them is applied and a partial update should not be visible to an observer.

V

Value - Interface in org.ojai
 
Value.Type - Enum in org.ojai
 
ValueBuilder - Interface in org.ojai.store
Provides APIs to create instances of the Value interface.
valueOf(String) - Static method in enum org.ojai.DocumentReader.EventType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ojai.FieldSegment.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ojai.store.cdc.ChangeDataRecordType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ojai.store.cdc.ChangeEvent
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ojai.store.cdc.ChangeOp
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ojai.store.MutationOp.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ojai.store.QueryCondition.Op
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ojai.store.SortOrder
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ojai.Value.Type
Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in enum org.ojai.Value.Type
 
values() - Static method in enum org.ojai.DocumentReader.EventType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.ojai.FieldSegment.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.ojai.store.cdc.ChangeDataRecordType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.ojai.store.cdc.ChangeEvent
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.ojai.store.cdc.ChangeOp
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.ojai.store.MutationOp.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.ojai.store.QueryCondition.Op
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.ojai.store.SortOrder
Returns an array containing the constants of this enum type, in the order they are declared.
Values - Class in org.ojai.util
A helper class that provides convenience methods to operate on a Value.
Values() - Constructor for class org.ojai.util.Values
 
values() - Static method in enum org.ojai.Value.Type
Returns an array containing the constants of this enum type, in the order they are declared.

W

waitForTrackedWrites(String) - Method in interface org.ojai.store.Query
Sets the writes-context for this query.
WHERE - Static variable in interface org.ojai.store.Query
OJAI field name for the Query.where(QueryCondition) operator
where(String) - Method in interface org.ojai.store.Query
Sets the filtering condition for the query.
where(QueryCondition) - Method in interface org.ojai.store.Query
Sets the filtering condition for the query.
WITH_TAGS - Static variable in class org.ojai.json.JsonOptions
 
WITHOUT_TAGS - Static variable in class org.ojai.json.JsonOptions
 
withoutTags() - Method in class org.ojai.json.JsonOptions
 
withTags() - Method in class org.ojai.json.JsonOptions
 
writeReaderToBuilder(DocumentReader, DocumentBuilder) - Static method in class org.ojai.json.Json
writeReaderToBuilder(DocumentReader, DocumentBuilder) - Static method in class org.ojai.util.Documents
This method can be used to build a Document (via DocumentBuilder) from a DocumentReader instance.
writeSegment(StringBuilder, boolean) - Method in class org.ojai.FieldSegment.IndexSegment
 
writeSegment(StringBuilder, boolean) - Method in class org.ojai.FieldSegment.NameSegment
 
writeSegment(StringBuilder, boolean) - Method in class org.ojai.FieldSegment
 
A B C D E F G H I J K L M N O P Q R S T U V W 
Skip navigation links
OJAI Core Library for Java v. 3.0

Copyright © 2015–2019 MapR Technologies, Inc.. All rights reserved.