Uses of Class
org.ojai.annotation.API.Public

Packages that use API.Public

Package	Description
org.ojai
org.ojai.base
org.ojai.beans
org.ojai.exceptions
org.ojai.json
org.ojai.store
org.ojai.store.base
org.ojai.store.cdc
org.ojai.types
org.ojai.util

Uses of API.Public in org.ojai

Classes in org.ojai with annotations of type API.Public

Modifier and Type	Interface and Description
interface	Document
interface	DocumentBuilder
interface	DocumentListener
interface	DocumentReader
interface	DocumentStream A stream of documents.
interface	Expression Represents an expression that can be used in a query.
class	FieldPath Immutable class for representing a field path.
class	FieldSegment
interface	KeyValue<KEY,VALUE>
interface	OjaiCodec<T> Implementation of this interface can be used to encode/decode OJAI Object to/from a target/source format <T>
interface	Value

Fields in org.ojai with annotations of type API.Public

Modifier and Type	Field and Description
static Comparator<FieldSegment>	FieldSegment.FIELD_SEGMENT_COMPARATOR A Comparator that compares two FieldSegments solely on the segment value itself, excluding their child, if any.

Uses of API.Public in org.ojai.base

Classes in org.ojai.base with annotations of type API.Public

Modifier and Type	Class and Description
class	DocumentBase A template abstract class that implements the Document interface.
class	DocumentReaderBase A template abstract class that implements the DocumentReader interface.

Uses of API.Public in org.ojai.beans

Classes in org.ojai.beans with annotations of type API.Public

Modifier and Type	Class and Description
class	BeanCodec

Uses of API.Public in org.ojai.exceptions

Classes in org.ojai.exceptions with annotations of type API.Public

Modifier and Type	Class and Description
class	DecodingException Exception thrown by implementations if a failure occurs during deserialization of the document.
class	EncodingException Exception thrown by implementations if a failure occurs during serialization of the document.
class	OjaiException The parent class of all exceptions thrown from this library.
class	QueryTimeoutException Exception thrown in the event of Query timeout.
class	StreamInUseException Exception thrown by implementations when a DocumentStream is accessed in more than one way.
class	TypeException

Uses of API.Public in org.ojai.json

Classes in org.ojai.json with annotations of type API.Public

Modifier and Type	Class and Description
class	Events
class	Json This class serves as a factory for a JSON implementation of all OJAI interfaces.

Uses of API.Public in org.ojai.store

Classes in org.ojai.store with annotations of type API.Public

Modifier and Type	Interface and Description
interface	Connection A logical connection to an OJAI data source.
interface	DocumentMutation The DocumentMutation interface defines the APIs to perform mutation of a Document already stored in a DocumentStore.
interface	DocumentStore
interface	Driver Entry point of an implementation of OJAI APIs.
class	DriverManager A factory class to manage OJAI Drivers.
interface	OpListener
interface	Query OJAI interface which lets users build an OJAI Query that can be executed on an OJAI DocumentStore.
interface	QueryCondition
interface	QueryResult
interface	ValueBuilder Provides APIs to create instances of the Value interface.

Uses of API.Public in org.ojai.store.base

Classes in org.ojai.store.base with annotations of type API.Public

Modifier and Type	Class and Description
class	ForwardingStore An adapter implementation of DocumentStore interface which forwards the individual API calls to the wrapped Store object.

Uses of API.Public in org.ojai.store.cdc

Classes in org.ojai.store.cdc with annotations of type API.Public

Modifier and Type	Interface and Description
interface	ChangeDataReader A parser that traverses over the individual change nodes in a ChangeDataRecord.
interface	ChangeDataRecord This interface encapsulates an atomic set of change operations that were performed to a single Document in the source DocumentStore.
class	ChangeDataRecordType This enumeration specifies the mode of change for a change data record.
class	ChangeEvent This enumeration identifies the change event associated with the current change node.
interface	ChangeNode An encapsulation of a change to a single field in a Document.
class	ChangeOp This enumeration identifies the change event associated with the current change node.

Uses of API.Public in org.ojai.types

Classes in org.ojai.types with annotations of type API.Public

Modifier and Type	Class and Description
class	ODate An immutable class which encapsulates an OJAI DATE type.
class	OInterval An immutable class which encapsulates a time interval.
class	OTime An immutable class which encapsulates an OJAI TIME type.
class	OTimestamp An immutable class which encapsulates an OJAI TIMESTAMP type.

Uses of API.Public in org.ojai.util

Classes in org.ojai.util with annotations of type API.Public

Modifier and Type	Class and Description
class	BaseFieldProjector
class	Constants
class	Decimals Utility class with functions for data type conversions.
class	DocumentReaderWithProjection An implementation of DocumentReader interface which can be used to project a sub-set of fields
class	Documents This class contains utility methods for Document interface.
class	FieldProjector 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.
class	Fields
class	Types A helper class that provides methods for conveniently operating on a Type.
class	Values A helper class that provides convenience methods to operate on a Value.