A SODA for Java Core Interfaces

The SODA for Java core interfaces are described.

Table A-1 lists and briefly describes these interfaces. For complete information about them, see the SODA Javadoc.


Table A-1 SODA for Java Core Interfaces

Interface Description

OracleClient

SODA for Java entry point (client)

OracleDocument

Document

Content is typically JSON; possibly a MIME type (for example, image, audio, or video)

Provides methods that get document content and metadata.

OracleDatabase

Database of collections of documents

Provides methods that access OracleDatabaseAdmin and open existing collections.

Inherits methods that create documents suitable for insertion into collections.

Obtained by invoking OracleClient.getDatabase().

OracleDatabaseAdmin

Provides methods that create collections and get their metadata.

Obtained by invoking OracleDatabase.admin().

OracleCollection

Collection of documents

Provides methods that access OracleOperationBuilder and OracleCollectionAdmin and insert and save collection documents.

Obtained by invoking OracleDatabase.admin().createCollection() or, if it already exists, OracleDatabase.openCollection().

OracleCollectionAdmin

Provides methods that index and drop collections and get their metadata.

Obtained by invoking OracleDatabase.admin().

OracleOperationBuilder

Builder and executor of read and write operations on a collection.

Provides nonterminal methods for building operations (for example, skip() and limit()) and terminal methods for executing operations (for example, getCursor(), count(), and remove()).

Obtained by invoking OracleCollection.find(), which returns an OracleOperationBuilder object that represents a query that finds all documents in the collection.

OracleCursor

Cursor for result list of query that OracleCollection.find() returns

next() method returns the next document from the query result list.

Obtained by invoking OracleOperationBuilder.getCursor().