org.ojai.store

Interface Driver

@API.Public
 @API.ThreadSafe
public interface Driver

Entry point of an implementation of OJAI APIs. An OJAI Driver implementation must support JAVA Service Provider Interface. DriverManager uses the implementation to establish a connection to the OJAI data source.

Method Summary

Modifier and Type	Method and Description
boolean	accepts(String url) Returns true if this Driver supports the protocol specified in the URL.
Connection	connect(String url, Document options) Establishes and returns a Connection to an OJAI data source.
boolean	equals(Object obj) Returns true if the other object is "equal to" this Driver.
String	getName() Returns a printable name for the OJAI Driver implementation
ValueBuilder	getValueBuilder() Returns a ValueBuilder object from this Driver.
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 documentJson) 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.

Method Detail

getName

String getName()

Returns a printable name for the OJAI Driver implementation

equals

boolean equals(@API.Nullable
               Object obj)

Returns true if the other object is "equal to" this Driver.

Overrides:

equals in class Object

getValueBuilder

ValueBuilder getValueBuilder()

Returns a ValueBuilder object from this Driver.

newDocument

Document newDocument()

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

newDocument

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

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

Throws:

DecodingException

newDocument

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

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

Throws:

DecodingException

newDocument

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

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

Throws:

DecodingException

newDocumentBuilder

DocumentBuilder newDocumentBuilder()

Returns a new DocumentBuilder object.

newMutation

DocumentMutation newMutation()

Creates and returns a new DocumentMutation object.

newCondition

QueryCondition newCondition()

Creates and returns a new QueryCondition object.

newQuery

Query newQuery()

Creates and returns a new Query object.

newQuery

Query newQuery(@API.NonNullable
               String queryJson)

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

accepts

@API.Internal
boolean accepts(@API.NonNullable
                              String url)

Returns true if this Driver supports the protocol specified in the URL.

connect

@API.Internal
Connection connect(@API.NonNullable
                                 String url,
                                 @API.Nullable
                                 Document options)
                          throws OjaiException

Establishes and returns a Connection to an OJAI data source. Used by DriverManager to connect to the OJAI data source. Application should not use this API directly.

Throws:

OjaiException