org.ojai.store

Interface Connection

All Superinterfaces:

AutoCloseable, Closeable

@API.Public
 @API.ThreadSafe
public interface Connection
extends Closeable

A logical connection to an OJAI data source. This could be a connection to a database server, a distributed cluster, or a set of distributed clusters.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this connection and releases any system resources associated with it.
default DocumentStore	createStore(String storeName) Creates an OJAI DocumentStore specified by the given name or path and returns a handle.
default DocumentStore	createStore(String storeName, Document options) Creates an OJAI DocumentStore specified by the given name or path and returns a handle.
default boolean	deleteStore(String storeName) Deletes the OJAI DocumentStore specified by the given name or path.
Driver	getDriver() Returns the OJAI Driver instance associated with this connection.
default DocumentStore	getStore(String storeName) Returns a handle to an OJAI DocumentStore specified by the given name or path.
default DocumentStore	getStore(String storeName, Document options) Returns a handle to an OJAI DocumentStore specified by the given name or path.
ValueBuilder	getValueBuilder() Returns a ValueBuilder object from this Connection.
QueryCondition	newCondition() Creates and returns a new QueryCondition object.
Document	newDocument() Creates and returns a new, empty instance of an OJAI Document.
Document	newDocument(Map<String,Object> map) Returns a new instance of Document constructed from the specified Map.
Document	newDocument(Object bean) Returns a new instance of Document built from the specified Java bean.
Document	newDocument(String jsonString) Returns a new instance of OJAI Document parsed from the specified JSON string.
DocumentBuilder	newDocumentBuilder() Returns a new DocumentBuilder object.
DocumentMutation	newMutation() Creates and returns a new DocumentMutation object.
Query	newQuery() Creates and returns a new Query object.
Query	newQuery(String queryJson) Creates and returns a new Query object decoded from the supplied JSON String.
default boolean	storeExists(String storeName) Tests if the OJAI DocumentStore specified by the given name or path exists.

Method Detail

createStore

default DocumentStore createStore(@API.NonNullable
                                  String storeName)
                           throws OjaiException

Creates an OJAI DocumentStore specified by the given name or path and returns a handle.

Parameters:

storeName - name or path of an OJAI data source table/store

Returns:

a DocumentStore object.

Throws:

OjaiException

createStore

default DocumentStore createStore(@API.NonNullable
                                  String storeName,
                                  @API.NonNullable
                                  Document options)
                           throws OjaiException

Creates an OJAI DocumentStore specified by the given name or path and returns a handle.

Parameters:

storeName - name or path of an OJAI data source table/store

options - an OJAI Document containing implementation specific options

Returns:

a DocumentStore object.

Throws:

OjaiException

deleteStore

default boolean deleteStore(@API.NonNullable
                            String storeName)
                     throws OjaiException

Deletes the OJAI DocumentStore specified by the given name or path.

Parameters:

storeName - name or path of an OJAI data source table/store

Returns:

true if the store was deleted, false otherwise

Throws:

OjaiException

storeExists

default boolean storeExists(@API.NonNullable
                            String storeName)
                     throws OjaiException

Tests if the OJAI DocumentStore specified by the given name or path exists.

Parameters:

storeName - name or path of an OJAI data source table/store

Returns:

true if the store exists, false otherwise

Throws:

OjaiException

getStore

default DocumentStore getStore(@API.NonNullable
                               String storeName)
                        throws OjaiException

Returns a handle to an OJAI DocumentStore specified by the given name or path.

Parameters:

storeName - name or path of an OJAI data source table/store

Returns:

a DocumentStore object.

Throws:

OjaiException

getStore

default DocumentStore getStore(@API.NonNullable
                               String storeName,
                               @API.NonNullable
                               Document options)
                        throws OjaiException

Returns a handle to an OJAI DocumentStore specified by the given name or path.

Parameters:

storeName - name or path of an OJAI data source table/store

options - an OJAI Document containing implementation specific options

Throws:

OjaiException

getValueBuilder

ValueBuilder getValueBuilder()

Returns a ValueBuilder object from this Connection. This is an alias to getDriver().getValueBuilder().

newDocument

Document newDocument()

Creates and returns a new, empty instance of an OJAI Document.

This is an alias to getDriver().newDocument().

newDocument

Document newDocument(@API.NonNullable
                     String jsonString)
              throws DecodingException

Returns a new instance of OJAI Document parsed from the specified JSON string.

This is an alias to getDriver().newDocument().

Throws:

DecodingException

newDocument

Document newDocument(@API.NonNullable
                     Map<String,Object> map)
              throws DecodingException

Returns a new instance of Document constructed from the specified Map.

This is an alias to getDriver().newDocument().

Throws:

DecodingException

newDocument

Document newDocument(@API.NonNullable
                     Object bean)
              throws DecodingException

Returns a new instance of Document built from the specified Java bean.

This is an alias to getDriver().newDocument().

Throws:

DecodingException

newDocumentBuilder

DocumentBuilder newDocumentBuilder()

Returns a new DocumentBuilder object.

This is an alias to getDriver().newDocumentBuilder().

newMutation

DocumentMutation newMutation()

Creates and returns a new DocumentMutation object.

This is an alias to getDriver().newMutation().

newCondition

QueryCondition newCondition()

Creates and returns a new QueryCondition object.

This is an alias to getDriver().newCondition().

newQuery

Query newQuery()

Creates and returns a new Query object.

This is an alias to getDriver().newQuery().

newQuery

Query newQuery(@API.NonNullable
               String queryJson)

Creates and returns a new Query object decoded from the supplied JSON String.

This is an alias to getDriver().newQuery().

getDriver

Driver getDriver()

Returns the OJAI Driver instance associated with this connection.

close

void close()

Closes this connection and releases any system resources associated with it. If the connection is already closed then invoking this method has no effect.

This method does not throw any exception.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable