org.ojai.store.base

Class ForwardingStore

java.lang.Object

org.ojai.store.base.ForwardingStore

All Implemented Interfaces:

AutoCloseable, DocumentStore

@API.Public
public class ForwardingStore
extends Object
implements DocumentStore

An adapter implementation of DocumentStore interface which forwards the individual API calls to the wrapped Store object.

Constructor Summary

Constructors

Constructor and Description
ForwardingStore(DocumentStore store)

Method Summary

Modifier and Type	Method and Description
void	beginTrackingWrites() Begins tracking the write operations performed through this instance of DocumentStore.
void	beginTrackingWrites(String previousWritesContext) Begins tracking the write operations performed through this instance of DocumentStore.
boolean	checkAndDelete(String id, QueryCondition condition) Atomically evaluates the condition on given document and if the condition holds true for the document then it is atomically deleted.
boolean	checkAndDelete(Value _id, QueryCondition condition)
boolean	checkAndMutate(String id, QueryCondition condition, DocumentMutation m) Atomically evaluates the condition on a given document and if the condition holds true for the document then a mutation is applied on the document.
boolean	checkAndMutate(Value _id, QueryCondition condition, DocumentMutation mutation) Atomically evaluates the condition on a given document and if the condition holds true for the document then a mutation is applied on the document.
boolean	checkAndReplace(String id, QueryCondition condition, Document r) Atomically evaluates the condition on the given document and if the condition holds true for the document then it atomically replaces the document with the given document.
boolean	checkAndReplace(Value _id, QueryCondition condition, Document doc)
void	clearTrackedWrites() Stops the writes tracking and clears any state on this DocumentStore instance.
void	close() Override AutoCloseable.close() to avoid declaring a checked exception.
void	delete(Document r)
void	delete(Document r, FieldPath fieldAsKey)
void	delete(DocumentStream rs) Deletes a set of documents from the DocumentStore represented by the DocumentStream.
void	delete(DocumentStream rs, FieldPath fieldAsKey)
void	delete(DocumentStream rs, String fieldAsKey)
void	delete(Document r, String fieldAsKey)
void	delete(String id) Deletes a document with the given id.
void	delete(Value _id)
String	endTrackingWrites() Flushes any buffered writes operations for this DocumentStore and returns a writesContext which can be used to ensure that such writes are visible to ensuing queries.
DocumentStream	find() Executes a query to return all Documents in the DocumentStore.
DocumentStream	find(FieldPath... paths) Executes a query to return all Documents in the DocumentStore.
QueryResult	find(Query query) Executes the specified query on the DocumentStore and return a QueryResult.
DocumentStream	find(QueryCondition c) Returns a DocumentStream with all the documents in the DocumentStore that satisfies the QueryCondition.
DocumentStream	find(QueryCondition c, FieldPath... paths) Executes a query on the DocumentStore and return a DocumentStream of the Document matching the specified QueryCondition.
DocumentStream	find(QueryCondition c, String... paths) Executes a query on the DocumentStore and return a DocumentStream of the Document matching the specified QueryCondition.
DocumentStream	find(String... paths) Executes a query to return all Documents in the DocumentStore.
Document	findById(String id) Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore.
Document	findById(String id, FieldPath... paths) Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore.
Document	findById(String id, QueryCondition c) Returns the Document with the given `_id` if it matches the specified condition.
Document	findById(String id, QueryCondition c, FieldPath... paths) Returns the Document with the given `_id` if it matches the specified condition.
Document	findById(String id, QueryCondition c, String... paths) Returns the Document with the given `_id` if it matches the specified condition.
Document	findById(String id, String... paths) Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore.
Document	findById(Value id) Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore.
Document	findById(Value _id, FieldPath... fieldPaths) Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore.
Document	findById(Value _id, QueryCondition condition) Returns the Document with the given `_id` if it matches the specified condition.
Document	findById(Value _id, QueryCondition condition, FieldPath... fieldPaths) Returns the Document with the given `_id` if it matches the specified condition.
Document	findById(Value _id, QueryCondition condition, String... fieldPaths) Returns the Document with the given `_id` if it matches the specified condition.
Document	findById(Value _id, String... fieldPaths) Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore.
DocumentStream	findQuery(Query query) Executes the specified query on the DocumentStore and return a DocumentStream of the result.
DocumentStream	findQuery(String queryJSON) Executes the specified query on the DocumentStore and return a DocumentStream of the result.
void	flush() Flushes any buffered writes operations for this DocumentStore.
void	increment(String id, String field, BigDecimal inc)
void	increment(String id, String field, byte inc) Atomically applies an increment to a given field (in dot separated notation) of the given document id.
void	increment(String id, String field, double inc)
void	increment(String id, String field, float inc)
void	increment(String id, String field, int inc)
void	increment(String id, String field, long inc)
void	increment(String id, String field, short inc)
void	increment(Value _id, String field, BigDecimal inc)
void	increment(Value _id, String field, byte inc)
void	increment(Value _id, String field, double inc)
void	increment(Value _id, String field, float inc)
void	increment(Value _id, String field, int inc)
void	increment(Value _id, String field, long inc)
void	increment(Value _id, String field, short inc)
void	insert(Document r)
void	insert(Document r, FieldPath fieldAsKey)
void	insert(DocumentStream rs) Inserts a set of documents represented by the DocumentStream into the DocumentStore.
void	insert(DocumentStream rs, FieldPath fieldAsKey)
void	insert(DocumentStream rs, String fieldAsKey)
void	insert(Document r, String fieldAsKey)
void	insert(String id, Document r) Inserts a document with the given id.
void	insert(Value _id, Document doc)
void	insertOrReplace(Document r) Inserts or replaces a new document in this DocumentStore.
void	insertOrReplace(Document r, FieldPath fieldAsKey) Inserts or replaces a new document in this DocumentStore with the value of the specified Field as the _id.
void	insertOrReplace(DocumentStream rs) Inserts all documents from the specified DocumentStream into this DocumentStore.
void	insertOrReplace(DocumentStream rs, FieldPath fieldAsKey) Inserts all documents from the specified DocumentStream into this DocumentStore using the field specified by parameter fieldAsKey as the "_id" field.
void	insertOrReplace(DocumentStream rs, String fieldAsKey) Inserts all documents from the specified DocumentStream into this DocumentStore using the field specified by parameter fieldAsKey as the "_id" field.
void	insertOrReplace(Document r, String fieldAsKey) Inserts or replaces a new document in this DocumentStore with the value of the specified Field as the _id.
void	insertOrReplace(String id, Document r) Inserts or replaces a new document in this DocumentStore with the given _id.
void	insertOrReplace(Value _id, Document doc) Inserts or replaces a new document in this DocumentStore with the given _id.
boolean	isReadOnly() Returns true if this Document store does not support any write operations like insert/update/delete, etc.
void	replace(Document r)
void	replace(Document r, FieldPath fieldAsKey)
void	replace(DocumentStream rs) Replaces a set of documents represented by the DocumentStream into the DocumentStore.
void	replace(DocumentStream rs, FieldPath fieldAsKey)
void	replace(DocumentStream rs, String fieldAsKey)
void	replace(Document r, String fieldAsKey)
void	replace(String id, Document r) Replaces a document in the DocumentStore.
void	replace(Value _id, Document doc)
void	update(String id, DocumentMutation m) Applies a mutation on the document identified by the document id. All updates specified by the mutation object should be applied atomically, and consistently meaning either all of the updates in mutation are applied or none of them is applied and a partial update should not be visible to an observer.
void	update(Value _id, DocumentMutation mutation) Applies a mutation on the document identified by the document id. All updates specified by the mutation object should be applied atomically, and consistently meaning either all of the updates in mutation are applied or none of them is applied and a partial update should not be visible to an observer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ojai.store.DocumentStore

checkAndUpdate, checkAndUpdate

Constructor Detail

ForwardingStore

public ForwardingStore(DocumentStore store)

Method Detail

close

public void close()
           throws StoreException

Description copied from interface: DocumentStore

Override AutoCloseable.close() to avoid declaring a checked exception.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DocumentStore

Throws:

StoreException

isReadOnly

public boolean isReadOnly()

Description copied from interface: DocumentStore

Returns true if this Document store does not support any write operations like insert/update/delete, etc.

Specified by:

isReadOnly in interface DocumentStore

beginTrackingWrites

public void beginTrackingWrites()
                         throws StoreException

Description copied from interface: DocumentStore

Begins tracking the write operations performed through this instance of DocumentStore.

Specified by:

beginTrackingWrites in interface DocumentStore

Throws:

StoreException

See Also:

DocumentStore.endTrackingWrites(), DocumentStore.clearTrackedWrites(), Query.waitForTrackedWrites(String)

beginTrackingWrites

public void beginTrackingWrites(String previousWritesContext)
                         throws StoreException

Description copied from interface: DocumentStore

Begins tracking the write operations performed through this instance of DocumentStore.

Specified by:

beginTrackingWrites in interface DocumentStore

Parameters:

previousWritesContext - previously tracked writes that were retrieved from this DocumentStore, or from other DocumentStore instances. The tracking begins by using this context as the base state

Throws:

StoreException

See Also:

DocumentStore.endTrackingWrites(), DocumentStore.clearTrackedWrites(), Query.waitForTrackedWrites(String)

endTrackingWrites

public String endTrackingWrites()
                         throws StoreException

Description copied from interface: DocumentStore

Flushes any buffered writes operations for this DocumentStore and returns a writesContext which can be used to ensure that such writes are visible to ensuing queries.

The write-context is cleared and tracking is stopped.

This call does not isolate the writes originating from this instance of DocumentStore from other instances and as a side-effect other writes issued to the same document-store through other DocumentStore instances could get flushed.

Specified by:

endTrackingWrites in interface DocumentStore

Returns:

an encoded string representing the write-context of all writes issued, since DocumentStore.beginTrackingWrites() until now, through this instance of DocumentStore

Throws:

StoreException - if the flush failed or if the flush of any buffered operation resulted in an error.

See Also:

DocumentStore.beginTrackingWrites(), DocumentStore.clearTrackedWrites(), Query.waitForTrackedWrites(String)

clearTrackedWrites

public void clearTrackedWrites()
                        throws StoreException

Description copied from interface: DocumentStore

Stops the writes tracking and clears any state on this DocumentStore instance.

This API should be called to stop tracking the writes-context in case where DocumentStore.beginTrackingWrites() was previously called but a commit context is not needed anymore, for example in case of an error in any of the mutation.

Specified by:

clearTrackedWrites in interface DocumentStore

Throws:

StoreException

findById

public Document findById(Value _id,
                         String... fieldPaths)
                  throws StoreException

Description copied from interface: DocumentStore

Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore. The returned Document will include only the specified fields.

Specified by:

findById in interface DocumentStore

Parameters:

_id - Document _id

fieldPaths - Array of of field paths that should be returned

Returns:

an OJAI Document with the specified id or null if one does not exist in this DocumentStore

Throws:

StoreException

findById

public Document findById(Value _id,
                         FieldPath... fieldPaths)
                  throws StoreException

Description copied from interface: DocumentStore

Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore. The returned Document will include only the specified fields.

Specified by:

findById in interface DocumentStore

Parameters:

_id - Document _id

fieldPaths - Array of of field paths that should be returned

Returns:

an OJAI Document with the specified id or null if one does not exist in this DocumentStore

Throws:

StoreException

findById

public Document findById(Value _id,
                         QueryCondition condition)
                  throws StoreException

Description copied from interface: DocumentStore

Returns the Document with the given `_id` if it matches the specified condition. If a Document with the specified `_id` does not exist in this DocumentStore or does not satisfy the specified condition, null is returned.

Specified by:

findById in interface DocumentStore

Parameters:

_id - document id

condition - query condition to test the document

Returns:

an OJAI Document with the specified _id

Throws:

StoreException

findById

public Document findById(Value _id,
                         QueryCondition condition,
                         String... fieldPaths)
                  throws StoreException

Description copied from interface: DocumentStore

Returns the Document with the given `_id` if it matches the specified condition. If a Document with the specified `_id` does not exist in this DocumentStore or does not satisfy the specified condition, null is returned. The returned Document will include only the specified fields.

Specified by:

findById in interface DocumentStore

Parameters:

_id - document id

condition - query condition to test the document

fieldPaths - list of fields that should be returned in the read document

Returns:

an OJAI Document with the specified _id

Throws:

StoreException

findById

public Document findById(Value _id,
                         QueryCondition condition,
                         FieldPath... fieldPaths)
                  throws StoreException

Description copied from interface: DocumentStore

Returns the Document with the given `_id` if it matches the specified condition. If a Document with the specified `_id` does not exist in this DocumentStore or does not satisfy the specified condition, null is returned. The returned Document will include only the specified fields.

Specified by:

findById in interface DocumentStore

Parameters:

_id - document id

condition - query condition to test the document

fieldPaths - list of fields that should be returned in the read document

Returns:

an OJAI Document with the specified _id

Throws:

StoreException

find

public QueryResult find(Query query)
                 throws StoreException

Description copied from interface: DocumentStore

Executes the specified query on the DocumentStore and return a QueryResult.

The returned QueryResult must be closed after retrieving the documents.

Specified by:

find in interface DocumentStore

Returns:

a QueryResult that can be used to retrieve the documents in the result

Throws:

StoreException

findQuery

public DocumentStream findQuery(Query query)
                         throws StoreException

Description copied from interface: DocumentStore

Executes the specified query on the DocumentStore and return a DocumentStream of the result.

The returned DocumentStream must be closed after retrieving the documents.

Specified by:

findQuery in interface DocumentStore

Returns:

a DocumentStream that can be used to retrieve the documents in the result

Throws:

StoreException

findQuery

public DocumentStream findQuery(String queryJSON)
                         throws StoreException

Description copied from interface: DocumentStore

Executes the specified query on the DocumentStore and return a DocumentStream of the result.

The returned DocumentStream must be closed after retrieving the documents.

Specified by:

findQuery in interface DocumentStore

Parameters:

queryJSON - a Json string representation of OJAI Query

Returns:

a DocumentStream that can be used to retrieve the documents in the result

Throws:

StoreException

insertOrReplace

public void insertOrReplace(Value _id,
                            Document doc)
                     throws StoreException

Description copied from interface: DocumentStore

Inserts or replaces a new document in this DocumentStore with the given _id.

The specified document should either not contain an "_id" field or its value should be same as the specified _id or the operation will fail.

If the document with the given _id exists in the DocumentStore then that document will be replaced by the specified document.

Specified by:

insertOrReplace in interface DocumentStore

Parameters:

_id - value to be used as the _id for this document

doc - the Document to be inserted or replaced in the DocumentStore

Throws:

StoreException

update

public void update(Value _id,
                   DocumentMutation mutation)
            throws StoreException

Description copied from interface: DocumentStore

Applies a mutation on the document identified by the document id.

All updates specified by the mutation object should be applied atomically, and consistently meaning either all of the updates in mutation are applied or none of them is applied and a partial update should not be visible to an observer.

Specified by:

update in interface DocumentStore

Parameters:

_id - document id

Throws:

StoreException

delete

public void delete(Value _id)
            throws StoreException

Specified by:

delete in interface DocumentStore

Throws:

StoreException

insert

public void insert(Value _id,
                   Document doc)
            throws StoreException

Specified by:

insert in interface DocumentStore

Throws:

StoreException

replace

public void replace(Value _id,
                    Document doc)
             throws StoreException

Specified by:

replace in interface DocumentStore

Throws:

StoreException

increment

public void increment(Value _id,
                      String field,
                      byte inc)
               throws StoreException

Specified by:

increment in interface DocumentStore

Throws:

StoreException

increment

public void increment(Value _id,
                      String field,
                      short inc)
               throws StoreException

Specified by:

increment in interface DocumentStore

Throws:

StoreException

increment

public void increment(Value _id,
                      String field,
                      int inc)
               throws StoreException

Specified by:

increment in interface DocumentStore

Throws:

StoreException

increment

public void increment(Value _id,
                      String field,
                      long inc)
               throws StoreException

Specified by:

increment in interface DocumentStore

Throws:

StoreException

increment

public void increment(Value _id,
                      String field,
                      float inc)
               throws StoreException

Specified by:

increment in interface DocumentStore

Throws:

StoreException

increment

public void increment(Value _id,
                      String field,
                      double inc)
               throws StoreException

Specified by:

increment in interface DocumentStore

Throws:

StoreException

increment

public void increment(Value _id,
                      String field,
                      BigDecimal inc)
               throws StoreException

Specified by:

increment in interface DocumentStore

Throws:

StoreException

checkAndMutate

public boolean checkAndMutate(Value _id,
                              QueryCondition condition,
                              DocumentMutation mutation)
                       throws StoreException

Description copied from interface: DocumentStore

Atomically evaluates the condition on a given document and if the condition holds true for the document then a mutation is applied on the document. If an id doesn't exist, the function returns false (no exception is thrown). If the mutation operation fails, it throws exception.

Specified by:

checkAndMutate in interface DocumentStore

Parameters:

_id - document id

condition - the condition to evaluate on the document

Returns:

True if the condition is true for the document; otherwise, false

Throws:

StoreException - if the condition passes but the mutate fails

checkAndDelete

public boolean checkAndDelete(Value _id,
                              QueryCondition condition)
                       throws StoreException

Specified by:

checkAndDelete in interface DocumentStore

Throws:

StoreException

checkAndReplace

public boolean checkAndReplace(Value _id,
                               QueryCondition condition,
                               Document doc)
                        throws StoreException

Specified by:

checkAndReplace in interface DocumentStore

Throws:

StoreException

flush

public void flush()
           throws StoreException

Description copied from interface: DocumentStore

Flushes any buffered writes operations for this DocumentStore.

Specified by:

flush in interface DocumentStore

Throws:

StoreException - if the flush failed or if the flush of any buffered operation resulted in an error

findById

public Document findById(String id)
                  throws StoreException

Description copied from interface: DocumentStore

Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore.

Specified by:

findById in interface DocumentStore

Parameters:

id - document id

Returns:

an OJAI Document with the specified id or null if one does not exist in this DocumentStore

Throws:

StoreException

findById

public Document findById(Value id)
                  throws StoreException

Description copied from interface: DocumentStore

Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore.

Specified by:

findById in interface DocumentStore

Parameters:

id - Document _id

Returns:

an OJAI Document with the specified id or null if one does not exist in this DocumentStore

Throws:

StoreException

findById

public Document findById(String id,
                         String... paths)
                  throws StoreException

Description copied from interface: DocumentStore

Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore. The returned Document will include only the specified fields.

Specified by:

findById in interface DocumentStore

Parameters:

id - Document _id

paths - Array of field paths that should be returned

Returns:

an OJAI Document with the specified id or null if one does not exist in this DocumentStore

Throws:

StoreException

findById

public Document findById(String id,
                         FieldPath... paths)
                  throws StoreException

Description copied from interface: DocumentStore

Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore. The returned Document will include only the specified fields.

Specified by:

findById in interface DocumentStore

Parameters:

id - Document _id

paths - Array of field paths that should be returned

Returns:

an OJAI Document with the specified id or null if one does not exist in this DocumentStore

Throws:

StoreException

findById

public Document findById(String id,
                         QueryCondition c)
                  throws StoreException

Description copied from interface: DocumentStore

Returns the Document with the given `_id` if it matches the specified condition. If a Document with the specified `_id` does not exist in this DocumentStore or does not satisfy the specified condition, null is returned.

Specified by:

findById in interface DocumentStore

Parameters:

id - document id

c - query condition to test the document

Returns:

an OJAI Document with the specified _id

Throws:

StoreException

findById

public Document findById(String id,
                         QueryCondition c,
                         String... paths)
                  throws StoreException

Description copied from interface: DocumentStore

Returns the Document with the given `_id` if it matches the specified condition. If a Document with the specified `_id` does not exist in this DocumentStore or does not satisfy the specified condition, null is returned. The returned Document will include only the specified fields.

Specified by:

findById in interface DocumentStore

Parameters:

id - document id

c - query condition to test the document

paths - list of fields that should be returned in the read document

Returns:

an OJAI Document with the specified _id

Throws:

StoreException

findById

public Document findById(String id,
                         QueryCondition c,
                         FieldPath... paths)
                  throws StoreException

Description copied from interface: DocumentStore

Returns the Document with the given `_id` if it matches the specified condition. If a Document with the specified `_id` does not exist in this DocumentStore or does not satisfy the specified condition, null is returned. The returned Document will include only the specified fields.

Specified by:

findById in interface DocumentStore

Parameters:

id - document id

c - query condition to test the document

paths - list of fields that should be returned in the read document

Returns:

an OJAI Document with the specified _id

Throws:

StoreException

find

public DocumentStream find()
                    throws StoreException

Description copied from interface: DocumentStore

Executes a query to return all Documents in the DocumentStore.

The returned DocumentStream must be closed after retrieving the documents.

Specified by:

find in interface DocumentStore

Returns:

a DocumentStream of all documents in the this DocumentStore

Throws:

StoreException

find

public DocumentStream find(String... paths)
                    throws StoreException

Description copied from interface: DocumentStore

Executes a query to return all Documents in the DocumentStore.

Each Document will contain only those field paths that are specified in the argument. If no fields are specified then it returns a full document.

Specified by:

find in interface DocumentStore

Parameters:

paths - list of fields that should be returned in the read document

Returns:

a DocumentStream that can be used to retrieve the documents in the result

Throws:

StoreException

find

public DocumentStream find(FieldPath... paths)
                    throws StoreException

Description copied from interface: DocumentStore

Executes a query to return all Documents in the DocumentStore.

Each Document will contain only those field paths that are specified in the argument. If no fields are specified then it returns a full document.

Specified by:

find in interface DocumentStore

Parameters:

paths - list of fields that should be returned in the read document

Returns:

a DocumentStream that can be used to retrieve the documents in the result

Throws:

StoreException

find

public DocumentStream find(QueryCondition c)
                    throws StoreException

Description copied from interface: DocumentStore

Returns a DocumentStream with all the documents in the DocumentStore that satisfies the QueryCondition.

Specified by:

find in interface DocumentStore

Parameters:

c - the QueryCondition to match the documents

Returns:

a DocumentStream that can be used to retrieve the documents in the result

Throws:

StoreException

find

public DocumentStream find(QueryCondition c,
                           String... paths)
                    throws StoreException

Description copied from interface: DocumentStore

Executes a query on the DocumentStore and return a DocumentStream of the Document matching the specified QueryCondition.

Each Document will contain only those field paths that are specified in the argument. If no fields are specified then it returns a full document.

Specified by:

find in interface DocumentStore

Parameters:

c - the QueryCondition to match the documents

paths - list of fields that should be returned in the read document

Returns:

a DocumentStream that can be used to retrieve the documents in the result

Throws:

StoreException

find

public DocumentStream find(QueryCondition c,
                           FieldPath... paths)
                    throws StoreException

Description copied from interface: DocumentStore

Executes a query on the DocumentStore and return a DocumentStream of the Document matching the specified QueryCondition.

Each Document will contain only those field paths that are specified in the argument. If no fields are specified then it returns a full document.

Specified by:

find in interface DocumentStore

Parameters:

c - the QueryCondition to match the documents

paths - list of fields that should be returned in the read document

Returns:

a DocumentStream that can be used to retrieve the documents in the result

Throws:

StoreException

insertOrReplace

public void insertOrReplace(Document r)
                     throws StoreException

Description copied from interface: DocumentStore

Inserts or replaces a new document in this DocumentStore.

The specified Document must contain an "_id" field or the operation will fail.

If the document with the given _id exists in the DocumentStore then that document will be replaced by the specified document.

Specified by:

insertOrReplace in interface DocumentStore

Parameters:

r - the Document to be inserted or replaced in the DocumentStore

Throws:

StoreException

insertOrReplace

public void insertOrReplace(String id,
                            Document r)
                     throws StoreException

Description copied from interface: DocumentStore

Inserts or replaces a new document in this DocumentStore with the given _id.

The specified document should either not contain an "_id" field or its value should be same as the specified _id or the operation will fail.

If the document with the given _id exists in the DocumentStore then that document will be replaced by the specified document.

Specified by:

insertOrReplace in interface DocumentStore

Parameters:

id - value to be used as the _id for this document

Throws:

StoreException

insertOrReplace

public void insertOrReplace(Document r,
                            FieldPath fieldAsKey)
                     throws StoreException

Description copied from interface: DocumentStore

Inserts or replaces a new document in this DocumentStore with the value of the specified Field as the _id.

If the document with the given _id exists in the DocumentStore then that document will be replaced by the specified document.

Specified by:

insertOrReplace in interface DocumentStore

Parameters:

r - the Document to be inserted or replaced in the DocumentStore

fieldAsKey - document's field to be used as the key when an id is not passed in and the document doesn't have an "_id" field or a different field is desired to be used as _id

Throws:

StoreException

insertOrReplace

public void insertOrReplace(Document r,
                            String fieldAsKey)
                     throws StoreException

Description copied from interface: DocumentStore

Inserts or replaces a new document in this DocumentStore with the value of the specified Field as the _id.

If the document with the given _id exists in the DocumentStore then that document will be replaced by the specified document.

Specified by:

insertOrReplace in interface DocumentStore

Parameters:

r - the Document to be inserted or replaced in the DocumentStore

fieldAsKey - document's field to be used as the key when an id is not passed in and the document doesn't have an "_id" field or a different field is desired to be used as _id

Throws:

StoreException

insertOrReplace

public void insertOrReplace(DocumentStream rs)
                     throws MultiOpException

Description copied from interface: DocumentStore

Inserts all documents from the specified DocumentStream into this DocumentStore.

This is a synchronous API and it won't return until all the documents in the DocumentStream are written to the DocumentStore or some error has occurred while storing the documents. Each document read from the DocumentStream must have a field "_id"; otherwise, the operation will fail. If there is an error in reading from the stream or in writing to the DocumentStore then a MultiOpException will be thrown containing the list of documents that failed to be stored in the DocumentStore. Reading from a stream stops on the first read error. If only write errors occur, the iterator will stop and the rest of the documents will remain un-consumed in the DocumentStream.

Specified by:

insertOrReplace in interface DocumentStore

Parameters:

rs - the DocumentStream to read the documents from

Throws:

MultiOpException - which has a list of write-failed documents and their errors

insertOrReplace

public void insertOrReplace(DocumentStream rs,
                            FieldPath fieldAsKey)
                     throws MultiOpException

Description copied from interface: DocumentStore

Inserts all documents from the specified DocumentStream into this DocumentStore using the field specified by parameter fieldAsKey as the "_id" field. If an "_id" field is present in the documents, an exception will be thrown.

This is a synchronous API and it won't return until all the documents in the DocumentStream are written to the DocumentStore or some error has occurred while storing the documents. Each document read from the DocumentStream must have a field "_id"; otherwise, the operation will fail. If there is an error in reading from the stream or in writing to the DocumentStore then a MultiOpException will be thrown containing the list of documents that failed to be stored in the DocumentStore. Reading from a stream stops on the first read error. If only write errors occur, the iterator will stop and the rest of the documents will remain un-consumed in the DocumentStream.

Specified by:

insertOrReplace in interface DocumentStore

Parameters:

rs - the DocumentStream to read the documents from

fieldAsKey - field from each document whose value is to be used as the document key for insertion

Throws:

MultiOpException - which has a list of write-failed documents and their errors

insertOrReplace

public void insertOrReplace(DocumentStream rs,
                            String fieldAsKey)
                     throws MultiOpException

Description copied from interface: DocumentStore

Inserts all documents from the specified DocumentStream into this DocumentStore using the field specified by parameter fieldAsKey as the "_id" field. If an "_id" field is present in the documents, an exception will be thrown.

This is a synchronous API and it won't return until all the documents in the DocumentStream are written to the DocumentStore or some error has occurred while storing the documents. Each document read from the DocumentStream must have a field "_id"; otherwise, the operation will fail. If there is an error in reading from the stream or in writing to the DocumentStore then a MultiOpException will be thrown containing the list of documents that failed to be stored in the DocumentStore. Reading from a stream stops on the first read error. If only write errors occur, the iterator will stop and the rest of the documents will remain un-consumed in the DocumentStream.

Specified by:

insertOrReplace in interface DocumentStore

Parameters:

rs - the DocumentStream to read the documents from

fieldAsKey - field from each document whose value is to be used as the document key for insertion

Throws:

MultiOpException - which has a list of write-failed documents and their errors

update

public void update(String id,
                   DocumentMutation m)
            throws StoreException

Description copied from interface: DocumentStore

Applies a mutation on the document identified by the document id.

All updates specified by the mutation object should be applied atomically, and consistently meaning either all of the updates in mutation are applied or none of them is applied and a partial update should not be visible to an observer.

Specified by:

update in interface DocumentStore

Parameters:

id - document id

Throws:

StoreException

delete

public void delete(String id)
            throws StoreException

Description copied from interface: DocumentStore

Deletes a document with the given id. This operation is successful even when the document with the given id doesn't exist. If the parameter fieldAsKey is provided, its value will be used as the "_id" to delete the document.

Specified by:

delete in interface DocumentStore

Parameters:

id - document id

Throws:

StoreException

delete

public void delete(Document r)
            throws StoreException

Specified by:

delete in interface DocumentStore

Throws:

StoreException

delete

public void delete(Document r,
                   FieldPath fieldAsKey)
            throws StoreException

Specified by:

delete in interface DocumentStore

Throws:

StoreException

delete

public void delete(Document r,
                   String fieldAsKey)
            throws StoreException

Specified by:

delete in interface DocumentStore

Throws:

StoreException

delete

public void delete(DocumentStream rs)
            throws MultiOpException

Description copied from interface: DocumentStore

Deletes a set of documents from the DocumentStore represented by the DocumentStream. This is a synchronous API and it won't return until all the documents in the DocumentStream are written to the DocumentStore or some error occurs while writing the documents. Each document read from the DocumentStream must have a field "_id" of type BINARY or UTF8-string; otherwise the operation will fail. If there is an error in reading from the stream or in writing to the DocumentStore then a MultiOpException will be thrown that contains a list of documents that failed to write to the DocumentStore. Reading from a stream stops on the first read error. If only write errors occur, the iterator will stop and the current list of failed document is returned in a multi op exception. The untouched documents will remain in the DocumentStream.

Specified by:

delete in interface DocumentStore

Parameters:

rs - DocumentStream

Throws:

MultiOpException - which has a list of write-failed documents and their errors

delete

public void delete(DocumentStream rs,
                   FieldPath fieldAsKey)
            throws MultiOpException

Specified by:

delete in interface DocumentStore

Throws:

MultiOpException

delete

public void delete(DocumentStream rs,
                   String fieldAsKey)
            throws MultiOpException

Specified by:

delete in interface DocumentStore

Throws:

MultiOpException

insert

public void insert(String id,
                   Document r)
            throws StoreException

Description copied from interface: DocumentStore

Inserts a document with the given id. This operation is successful only when the document with the given id doesn't exist. "fieldAsKey", when provided, will also be stored as the "_id" field in the written document for the document. If "_id" already existed in the document, then an error will be thrown. When reading the document back from the DB, the key will be returned back as usual as the "_id" field. Note that an insertOrReplace() operation would be more efficient than an insert() call.

Specified by:

insert in interface DocumentStore

Parameters:

id - to be used as the key for the document

r - JSON document as the new value for the given document

Throws:

DocumentExistsException - when a document with id already exists in DocumentStore

StoreException

insert

public void insert(Document r)
            throws StoreException

Specified by:

insert in interface DocumentStore

Throws:

StoreException

insert

public void insert(Document r,
                   FieldPath fieldAsKey)
            throws StoreException

Specified by:

insert in interface DocumentStore

Throws:

StoreException

insert

public void insert(Document r,
                   String fieldAsKey)
            throws StoreException

Specified by:

insert in interface DocumentStore

Throws:

StoreException

insert

public void insert(DocumentStream rs)
            throws MultiOpException

Description copied from interface: DocumentStore

Inserts a set of documents represented by the DocumentStream into the DocumentStore. This is a synchronous API that won't return until all the documents in the DocumentStream are written to the DocumentStore or some error occurs while writing the documents. Each document read from the DocumentStream must have a field "_id" of type BINARY or UTF8-string; otherwise, the operation will fail or it will be of the Document type. If a document with the given key exists on the server then it throws a document exists exception, similar to the non-DocumentStream based insert() API. If there is an error in reading from the stream or in writing to the DocumentStore then a MultiOpException will be thrown that contains a list of documents that failed to write to the DocumentStore. Reading from a stream stops on the first read error. If only write errors occur, the iterator will stop and the current list of failed document is returned in a multi op exception. The untouched documents will remain in the DocumentStream.

Specified by:

insert in interface DocumentStore

Parameters:

rs - DocumentStream

Throws:

MultiOpException - which has a list of write-failed documents and their errors

insert

public void insert(DocumentStream rs,
                   FieldPath fieldAsKey)
            throws MultiOpException

Specified by:

insert in interface DocumentStore

Throws:

MultiOpException

insert

public void insert(DocumentStream rs,
                   String fieldAsKey)
            throws MultiOpException

Specified by:

insert in interface DocumentStore

Throws:

MultiOpException

replace

public void replace(String id,
                    Document r)
             throws StoreException

Description copied from interface: DocumentStore

Replaces a document in the DocumentStore. The document id is either explicitly specified as parameter "id" or it is implicitly specified as the field "_id" in the passed document. If the document id is explicitly passed then the document should not contain "_id" field or its value should be the same as the explicitly specified id; otherwise, the operation will fail. If the document with the given key does not exist on the server then it will throw DocumentNotFoundException. "fieldAsKey", when provided, will also be stored as the "_id" field in the written document for the document. If "_id" already existed in the document, then an error will be thrown. When reading the document back from the DB, the key would be returned back as usual as "_id" field. Note that an insertOrReplace() operation would be more efficient than an replace() call.

Specified by:

replace in interface DocumentStore

Parameters:

id - to be used as the key for the document

r - JSON document as the new value for the given document

Throws:

DocumentNotFoundException - when a document with the id does not exist in DocumentStore

StoreException

replace

public void replace(Document r)
             throws StoreException

Specified by:

replace in interface DocumentStore

Throws:

StoreException

replace

public void replace(Document r,
                    FieldPath fieldAsKey)
             throws StoreException

Specified by:

replace in interface DocumentStore

Throws:

StoreException

replace

public void replace(Document r,
                    String fieldAsKey)
             throws StoreException

Specified by:

replace in interface DocumentStore

Throws:

StoreException

replace

public void replace(DocumentStream rs)
             throws MultiOpException

Description copied from interface: DocumentStore

Replaces a set of documents represented by the DocumentStream into the DocumentStore. This is a synchronous API and it won't return until all the documents in the DocumentStream are written to the DocumentStore or some error occurs while writing the documents. Each document read from the DocumentStream must have a field "_id" of type BINARY or UTF8-string; otherwise, the operation will fail or it will be of Document type. If the document with the given key does not exist on the server then it throws, a document not exists exception, similar to the non-DocumentStream based replace() API. If there is an error in reading from the stream or in writing to the DocumentStore then a MultiOpException will be thrown that contains a list of documents that failed to write to the DocumentStore. Reading from a stream stops on the first read error. If only write errors occur, the iterator will stop and the current list of failed document is returned in a multi op exception. The untouched documents will remain in the DocumentStream.

Specified by:

replace in interface DocumentStore

Parameters:

rs - a DocumentStream to read the documents from

Throws:

MultiOpException - which has list of write-failed documents and their errors

replace

public void replace(DocumentStream rs,
                    FieldPath fieldAsKey)
             throws MultiOpException

Specified by:

replace in interface DocumentStore

Throws:

MultiOpException

replace

public void replace(DocumentStream rs,
                    String fieldAsKey)
             throws MultiOpException

Specified by:

replace in interface DocumentStore

Throws:

MultiOpException

increment

public void increment(String id,
                      String field,
                      byte inc)
               throws StoreException

Description copied from interface: DocumentStore

Atomically applies an increment to a given field (in dot separated notation) of the given document id. If the field doesn't exist on the server then it will be created with the type of the incremental value. The increment operation can be applied on any of the numeric types, such as byte, short, int, long, float, double, or decimal, of a field. The operation will fail if the increment is applied to a field that is of a non-numeric type. If an id doesn't exist, it gets created (similar to the insertOrReplace behavior). And it is created, with the value of 'inc' parameter. The same logic applies to intermittent paths in the path: they get created top to bottom. If the type is different than the field in the operation, it fails. The increment operation won't change the type of existing value stored in the given field for the document. The resultant value of the field will be truncated based on the original type of the field. For example, if a field 'score' is of type int and contains 60 and an increment of double '5.675' is applied, then the resultant value of the field will be 65 (65.675 will be truncated to 65). If the type to which the increment is applied is a byte, short, or int, then it needs to use long as the operation.

Specified by:

increment in interface DocumentStore

Parameters:

id - document id

field - the field name in dot separated notation

inc - increment to apply to a field. Can be positive or negative

Throws:

StoreException

increment

public void increment(String id,
                      String field,
                      short inc)
               throws StoreException

Specified by:

increment in interface DocumentStore

Throws:

StoreException

increment

public void increment(String id,
                      String field,
                      int inc)
               throws StoreException

Specified by:

increment in interface DocumentStore

Throws:

StoreException

increment

public void increment(String id,
                      String field,
                      long inc)
               throws StoreException

Specified by:

increment in interface DocumentStore

Throws:

StoreException

increment

public void increment(String id,
                      String field,
                      float inc)
               throws StoreException

Specified by:

increment in interface DocumentStore

Throws:

StoreException

increment

public void increment(String id,
                      String field,
                      double inc)
               throws StoreException

Specified by:

increment in interface DocumentStore

Throws:

StoreException

increment

public void increment(String id,
                      String field,
                      BigDecimal inc)
               throws StoreException

Specified by:

increment in interface DocumentStore

Throws:

StoreException

checkAndMutate

public boolean checkAndMutate(String id,
                              QueryCondition condition,
                              DocumentMutation m)
                       throws StoreException

Description copied from interface: DocumentStore

Atomically evaluates the condition on a given document and if the condition holds true for the document then a mutation is applied on the document. If an id doesn't exist, the function returns false (no exception is thrown). If the mutation operation fails, it throws exception.

Specified by:

checkAndMutate in interface DocumentStore

Parameters:

id - document id

condition - the condition to evaluate on the document

Returns:

True if the condition is true for the document; otherwise, false

Throws:

StoreException - if the condition passes but the mutate fails

checkAndDelete

public boolean checkAndDelete(String id,
                              QueryCondition condition)
                       throws StoreException

Description copied from interface: DocumentStore

Atomically evaluates the condition on given document and if the condition holds true for the document then it is atomically deleted. If id doesn't exist, returns false (no exception is thrown). If deletion operation fails, it throws exception.

Specified by:

checkAndDelete in interface DocumentStore

Parameters:

id - document id

condition - condition to evaluate on the document

Returns:

True if the condition is valid for the document, otherwise false.

Throws:

StoreException - if the condition passes but the delete fails

checkAndReplace

public boolean checkAndReplace(String id,
                               QueryCondition condition,
                               Document r)
                        throws StoreException

Description copied from interface: DocumentStore

Atomically evaluates the condition on the given document and if the condition holds true for the document then it atomically replaces the document with the given document. If the id doesn't exist, the function returns false (no exception is thrown). If the replace operation fails, it throws an exception.

Specified by:

checkAndReplace in interface DocumentStore

Parameters:

id - document id

condition - the condition to evaluate on the document

r - document to replace

Returns:

True if the condition is true for the document otherwise false

Throws:

StoreException - if the condition passes but the replace fails