Package | Description |
---|---|
org.ojai | |
org.ojai.base | |
org.ojai.exceptions | |
org.ojai.store | |
org.ojai.store.exceptions |
Modifier and Type | Method and Description |
---|---|
Buildable |
Buildable.build()
Builds this object and makes it immutable.
|
void |
DocumentStream.close()
Overridden to remove checked exception
|
Modifier and Type | Method and Description |
---|---|
void |
DocumentStreamBase.close()
Closes this
DocumentStream .
If a derived class requires any closing steps, it should override DocumentStreamBase.closeDerived() . |
protected void |
DocumentStreamBase.closeDerived()
Perform whatever steps the derived class requires for closing.
|
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 |
ParseException |
class |
QueryTimeoutException
Exception thrown in the event of
Query timeout. |
class |
RangeException |
class |
ReadOnlyObjectException |
class |
StreamInUseException
Exception thrown by implementations when a
DocumentStream is
accessed in more than one way. |
class |
TypeException |
Modifier and Type | Method and Description |
---|---|
Connection |
Driver.connect(String url,
Document options)
Establishes and returns a Connection to an OJAI data source.
|
default DocumentStore |
Connection.createStore(String storeName)
Creates an OJAI DocumentStore specified by the given name or path and returns a handle.
|
default DocumentStore |
Connection.createStore(String storeName,
Document options)
Creates an OJAI DocumentStore specified by the given name or path and returns a handle.
|
default boolean |
Connection.deleteStore(String storeName)
Deletes the OJAI DocumentStore specified by the given name or path.
|
static Connection |
DriverManager.getConnection(String url)
Establishes and returns a Connection to an OJAI data source.
|
static Connection |
DriverManager.getConnection(String url,
Document options)
Establishes and returns a Connection to an OJAI data source.
|
static Driver |
DriverManager.getDriver(String url)
Discovers and loads the OJAI Driver implementation which supported the
specified URL.
|
default DocumentStore |
Connection.getStore(String storeName)
Returns a handle to an OJAI DocumentStore specified by the given name
or path.
|
default DocumentStore |
Connection.getStore(String storeName,
Document options)
Returns a handle to an OJAI DocumentStore specified by the given name
or path.
|
default boolean |
Connection.storeExists(String storeName)
Tests if the OJAI DocumentStore specified by the given name or path exists.
|
Query |
Query.where(QueryCondition condition)
Sets the filtering condition for the query.
|
Query |
Query.where(String conditionJson)
Sets the filtering condition for the query.
|
Modifier and Type | Class and Description |
---|---|
class |
AuthenticationException
An operation was requested without sufficient authentication.
|
class |
AuthorizationException
An operation was requested without sufficient permission.
|
class |
ConnectionException
This class is the base class of all exceptions thrown from the
Connection . |
class |
DocumentExistsException
This exception is thrown if a Store operation fails if a Document already
existed when none was expected for the operation to succeed.
|
class |
DocumentNotFoundException
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.
|
class |
ExpiredTokenException
An operation was requested with and expired authentication token.
|
class |
IllegalMutationException
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. |
class |
MultiOpException
This class is used to wrap an exception for stream processing that fails midway.
|
class |
SecurityException |
class |
StoreException
This class is the base class of all exceptions thrown from the
DocumentStore . |
class |
StoreExistsException |
class |
StoreNotFoundException |
Copyright © 2015–2019 MapR Technologies, Inc.. All rights reserved.