org.springframework.data.couchbase.core

Class CouchbaseTemplate

java.lang.Object

org.springframework.data.couchbase.core.CouchbaseTemplate

All Implemented Interfaces:

Aware, ApplicationEventPublisherAware, CouchbaseOperations

public class CouchbaseTemplate
extends Object
implements CouchbaseOperations, ApplicationEventPublisherAware

Author:

Michael Nitschinger, Oliver Gierke, Simon Baslé, Young-Gu Chae, Mark Paluch

Field Summary

Fields

Modifier and Type	Field and Description
protected MappingContext<? extends CouchbasePersistentEntity<?>,CouchbasePersistentProperty>	mappingContext

Constructor Summary

Constructors

Constructor and Description
CouchbaseTemplate(com.couchbase.client.java.cluster.ClusterInfo clusterInfo, com.couchbase.client.java.Bucket client)
CouchbaseTemplate(com.couchbase.client.java.cluster.ClusterInfo clusterInfo, com.couchbase.client.java.Bucket client, CouchbaseConverter converter, TranslationService translationService)
CouchbaseTemplate(com.couchbase.client.java.cluster.ClusterInfo clusterInfo, com.couchbase.client.java.Bucket client, TranslationService translationService)

Method Summary

Modifier and Type	Method and Description
protected static void	ensureNotIterable(Object o) Make sure the given object is not a iterable.
<T> T	execute(BucketCallback<T> action) Executes a BucketCallback translating any exceptions as necessary.
<T> rx.Observable<T>	executeAsync(rx.Observable<T> asyncAction)
boolean	exists(String id) Checks if the given document exists.
<T> T	findById(String id, Class<T> entityClass) Find an object by its given Id and map it to the corresponding entity.
<T> List<T>	findByN1QL(com.couchbase.client.java.query.N1qlQuery n1ql, Class<T> entityClass) Query the N1QL Service for JSON data of type T.
<T> List<T>	findByN1QLProjection(com.couchbase.client.java.query.N1qlQuery n1ql, Class<T> entityClass) Query the N1QL Service for partial JSON data of type T.
<T> List<T>	findBySpatialView(com.couchbase.client.java.view.SpatialViewQuery query, Class<T> entityClass) Query a Spatial View for a list of documents of type T.
<T> List<T>	findByView(com.couchbase.client.java.view.ViewQuery query, Class<T> entityClass) Query a View for a list of documents of type T.
CouchbaseConverter	getConverter() Returns the underlying CouchbaseConverter.
com.couchbase.client.java.Bucket	getCouchbaseBucket() Returns the linked Bucket to this template.
com.couchbase.client.java.cluster.ClusterInfo	getCouchbaseClusterInfo() Returns the ClusterInfo about the cluster linked to this template.
Consistency	getDefaultConsistency() Returns the consistency parameter to be used by default for generated queries (views and N1QL) in repositories.
String	getGeneratedId(Object entity) Get generated id - applies both using prefix and suffix through entity as well as template KeySettings ** NOTE: UNIQUE strategy will generate different ids each time ***
void	insert(Collection<?> batchToInsert) Insert a list of objects.
void	insert(Collection<?> batchToInsert, com.couchbase.client.java.PersistTo persistTo, com.couchbase.client.java.ReplicateTo replicateTo) Insert a list of objects.
void	insert(Object objectToInsert) Insert the given object.
void	insert(Object objectToInsert, com.couchbase.client.java.PersistTo persistTo, com.couchbase.client.java.ReplicateTo replicateTo) Insert the given object.
KeySettings	keySettings() Get key settings associated with the template
void	keySettings(KeySettings settings) Add common key settings Throws UnsupportedOperationException if KeySettings is already set.
protected <T> void	maybeEmitEvent(CouchbaseMappingEvent<T> event) Helper method to publish an event if the event publisher is set.
com.couchbase.client.java.query.N1qlQueryResult	queryN1QL(com.couchbase.client.java.query.N1qlQuery query) Query the N1QL Service with direct access to the N1qlQueryResult.
com.couchbase.client.java.view.SpatialViewResult	querySpatialView(com.couchbase.client.java.view.SpatialViewQuery query) Query a Spatial View with direct access to the SpatialViewResult.
com.couchbase.client.java.view.ViewResult	queryView(com.couchbase.client.java.view.ViewQuery query) Query a View with direct access to the ViewResult.
void	remove(Collection<?> batchToRemove) Remove a list of objects from the bucket by id.
void	remove(Collection<?> batchToRemove, com.couchbase.client.java.PersistTo persistTo, com.couchbase.client.java.ReplicateTo replicateTo) Remove a list of objects from the bucket by id.
void	remove(Object objectToRemove) Remove the given object from the bucket by id.
void	remove(Object objectToRemove, com.couchbase.client.java.PersistTo persistTo, com.couchbase.client.java.ReplicateTo replicateTo) Remove the given object from the bucket by id.
void	save(Collection<?> batchToSave) Save a list of objects.
void	save(Collection<?> batchToSave, com.couchbase.client.java.PersistTo persistTo, com.couchbase.client.java.ReplicateTo replicateTo) Save a list of objects.
void	save(Object objectToSave) Save the given object.
void	save(Object objectToSave, com.couchbase.client.java.PersistTo persistTo, com.couchbase.client.java.ReplicateTo replicateTo) Save the given object.
void	setApplicationEventPublisher(ApplicationEventPublisher eventPublisher)
void	setDefaultConsistency(Consistency consistency)
void	setWriteResultChecking(WriteResultChecking writeResultChecking) Configures the WriteResultChecking to be used with the template.
void	update(Collection<?> batchToUpdate) Insert a list of objects.
void	update(Collection<?> batchToUpdate, com.couchbase.client.java.PersistTo persistTo, com.couchbase.client.java.ReplicateTo replicateTo) Insert a list of objects.
void	update(Object objectToUpdate) Update the given object.
void	update(Object objectToUpdate, com.couchbase.client.java.PersistTo persistTo, com.couchbase.client.java.ReplicateTo replicateTo) Update the given object.

Methods inherited from class java.lang.Object

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

Field Detail

mappingContext

protected final MappingContext<? extends CouchbasePersistentEntity<?>,CouchbasePersistentProperty> mappingContext

Constructor Detail

CouchbaseTemplate

public CouchbaseTemplate(com.couchbase.client.java.cluster.ClusterInfo clusterInfo,
                         com.couchbase.client.java.Bucket client)

CouchbaseTemplate

public CouchbaseTemplate(com.couchbase.client.java.cluster.ClusterInfo clusterInfo,
                         com.couchbase.client.java.Bucket client,
                         TranslationService translationService)

CouchbaseTemplate

public CouchbaseTemplate(com.couchbase.client.java.cluster.ClusterInfo clusterInfo,
                         com.couchbase.client.java.Bucket client,
                         CouchbaseConverter converter,
                         TranslationService translationService)

Method Detail

ensureNotIterable

protected static void ensureNotIterable(Object o)

Make sure the given object is not a iterable.

Parameters:

o - the object to verify.

setWriteResultChecking

public void setWriteResultChecking(WriteResultChecking writeResultChecking)

Configures the WriteResultChecking to be used with the template. Setting null will reset the default of DEFAULT_WRITE_RESULT_CHECKING. This can be configured to capture couchbase specific exceptions like Temporary failure, Authentication failure..

Parameters:

writeResultChecking - the setting to use.

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher eventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

maybeEmitEvent

protected <T> void maybeEmitEvent(CouchbaseMappingEvent<T> event)

Helper method to publish an event if the event publisher is set.

Type Parameters:

T - the enclosed type.

Parameters:

event - the event to emit.

save

public void save(Object objectToSave)

Description copied from interface: CouchbaseOperations

Save the given object.

When the document already exists (specified by its unique id), then it will be overriden. Otherwise it will be created.

Specified by:

save in interface CouchbaseOperations

Parameters:

objectToSave - the object to store in the bucket.

save

public void save(Object objectToSave,
                 com.couchbase.client.java.PersistTo persistTo,
                 com.couchbase.client.java.ReplicateTo replicateTo)

Description copied from interface: CouchbaseOperations

Save the given object.

When the document already exists (specified by its unique id), then it will be overriden. Otherwise it will be created.

Specified by:

save in interface CouchbaseOperations

Parameters:

objectToSave - the object to store in the bucket.

save

public void save(Collection<?> batchToSave)

Description copied from interface: CouchbaseOperations

Save a list of objects.

When one of the documents already exists (specified by its unique id), then it will be overriden. Otherwise it will be created.

Specified by:

save in interface CouchbaseOperations

Parameters:

batchToSave - the list of objects to store in the bucket.

save

public void save(Collection<?> batchToSave,
                 com.couchbase.client.java.PersistTo persistTo,
                 com.couchbase.client.java.ReplicateTo replicateTo)

Description copied from interface: CouchbaseOperations

Save a list of objects.

When one of the documents already exists (specified by its unique id), then it will be overriden. Otherwise it will be created.

Specified by:

save in interface CouchbaseOperations

Parameters:

batchToSave - the list of objects to store in the bucket.

persistTo - the persistence constraint setting.

replicateTo - the replication constraint setting.

insert

public void insert(Object objectToInsert)

Description copied from interface: CouchbaseOperations

Insert the given object.

When the document already exists (specified by its unique id), then it will not be overriden. Use the CouchbaseOperations.save(java.lang.Object) method for this task.

Specified by:

insert in interface CouchbaseOperations

Parameters:

objectToInsert - the object to add to the bucket.

insert

public void insert(Object objectToInsert,
                   com.couchbase.client.java.PersistTo persistTo,
                   com.couchbase.client.java.ReplicateTo replicateTo)

Description copied from interface: CouchbaseOperations

Insert the given object.

When the document already exists (specified by its unique id), then it will not be overriden. Use the CouchbaseOperations.save(java.lang.Object) method for this task.

Specified by:

insert in interface CouchbaseOperations

Parameters:

objectToInsert - the object to add to the bucket.

persistTo - the persistence constraint setting.

replicateTo - the replication constraint setting.

insert

public void insert(Collection<?> batchToInsert)

Description copied from interface: CouchbaseOperations

Insert a list of objects.

When one of the documents already exists (specified by its unique id), then it will not be overriden. Use the CouchbaseOperations.save(java.lang.Object) method for this.

Specified by:

insert in interface CouchbaseOperations

Parameters:

batchToInsert - the list of objects to add to the bucket.

insert

public void insert(Collection<?> batchToInsert,
                   com.couchbase.client.java.PersistTo persistTo,
                   com.couchbase.client.java.ReplicateTo replicateTo)

Description copied from interface: CouchbaseOperations

Insert a list of objects.

When one of the documents already exists (specified by its unique id), then it will not be overriden. Use the CouchbaseOperations.save(java.lang.Object) method for this.

Specified by:

insert in interface CouchbaseOperations

Parameters:

batchToInsert - the list of objects to add to the bucket.

persistTo - the persistence constraint setting.

replicateTo - the replication constraint setting.

update

public void update(Object objectToUpdate)

Description copied from interface: CouchbaseOperations

Update the given object.

When the document does not exist (specified by its unique id) it will not be created. Use the CouchbaseOperations.save(java.lang.Object) method for this.

Specified by:

update in interface CouchbaseOperations

Parameters:

objectToUpdate - the object to add to the bucket.

update

public void update(Object objectToUpdate,
                   com.couchbase.client.java.PersistTo persistTo,
                   com.couchbase.client.java.ReplicateTo replicateTo)

Description copied from interface: CouchbaseOperations

Update the given object.

When the document does not exist (specified by its unique id) it will not be created. Use the CouchbaseOperations.save(java.lang.Object) method for this.

Specified by:

update in interface CouchbaseOperations

Parameters:

objectToUpdate - the object to add to the bucket.

persistTo - the persistence constraint setting.

replicateTo - the replication constraint setting.

update

public void update(Collection<?> batchToUpdate)

Description copied from interface: CouchbaseOperations

Insert a list of objects.

If one of the documents does not exist (specified by its unique id), then it will not be created. Use the CouchbaseOperations.save(java.lang.Object) method for this.

Specified by:

update in interface CouchbaseOperations

Parameters:

batchToUpdate - the list of objects to add to the bucket.

update

public void update(Collection<?> batchToUpdate,
                   com.couchbase.client.java.PersistTo persistTo,
                   com.couchbase.client.java.ReplicateTo replicateTo)

Description copied from interface: CouchbaseOperations

Insert a list of objects.

If one of the documents does not exist (specified by its unique id), then it will not be created. Use the CouchbaseOperations.save(java.lang.Object) method for this.

Specified by:

update in interface CouchbaseOperations

Parameters:

batchToUpdate - the list of objects to add to the bucket.

persistTo - the persistence constraint setting.

replicateTo - the replication constraint setting.

findById

public <T> T findById(String id,
                      Class<T> entityClass)

Description copied from interface: CouchbaseOperations

Find an object by its given Id and map it to the corresponding entity.

Specified by:

findById in interface CouchbaseOperations

Parameters:

id - the unique ID of the document.

entityClass - the entity to map to.

Returns:

returns the found object or null otherwise.

findByView

public <T> List<T> findByView(com.couchbase.client.java.view.ViewQuery query,
                              Class<T> entityClass)

Description copied from interface: CouchbaseOperations

Query a View for a list of documents of type T.

There is no need to set includeDocs explicitly, since this method will manage the retrieval of documents internally. It is valid to pass in a empty constructed ViewQuery object.

Weak consistency in the query (stale(Stale.TRUE)) can lead to some documents being unreachable due to their deletion not having been indexed. These deleted null documents are eliminated from the result of this method.

This method does not work with reduced views, because they by design do not contain references to original objects. Use the provided CouchbaseOperations.queryView(com.couchbase.client.java.view.ViewQuery) method for more flexibility and direct access.

Specified by:

findByView in interface CouchbaseOperations

Parameters:

query - the Query object (also specifying view design document and view name).

entityClass - the entity to map to.

Returns:

the converted collection

queryView

public com.couchbase.client.java.view.ViewResult queryView(com.couchbase.client.java.view.ViewQuery query)

Description copied from interface: CouchbaseOperations

Query a View with direct access to the ViewResult.

This method is available to ease the working with views by still wrapping exceptions into the Spring infrastructure.

It is especially needed if you want to run reduced viewName queries, because they can't be mapped onto entities directly.

Specified by:

queryView in interface CouchbaseOperations

Parameters:

query - the Query object (also specifying view design document and view name).

Returns:

ViewResult containing the results of the query.

findBySpatialView

public <T> List<T> findBySpatialView(com.couchbase.client.java.view.SpatialViewQuery query,
                                     Class<T> entityClass)

Description copied from interface: CouchbaseOperations

Query a Spatial View for a list of documents of type T.

There is no need to set includeDocs explicitly, since this method will manage the retrieval of documents internally. It is valid to pass in a empty constructed SpatialViewQuery object.

Weak consistency in the query (stale(Stale.TRUE)) can lead to some documents being unreachable due to their deletion not having been indexed. These deleted null documents are eliminated from the result of this method.

Specified by:

findBySpatialView in interface CouchbaseOperations

Parameters:

query - the SpatialViewQuery object (also specifying view design document and view name).

entityClass - the entity to map to.

Returns:

the converted collection

querySpatialView

public com.couchbase.client.java.view.SpatialViewResult querySpatialView(com.couchbase.client.java.view.SpatialViewQuery query)

Description copied from interface: CouchbaseOperations

Query a Spatial View with direct access to the SpatialViewResult.

This method is available to ease the working with spatial views by still wrapping exceptions into the Spring infrastructure.

Specified by:

querySpatialView in interface CouchbaseOperations

Parameters:

query - the SpatialViewQuery object (also specifying view design document and view name).

Returns:

SpatialViewResult containing the results of the query.

findByN1QL

public <T> List<T> findByN1QL(com.couchbase.client.java.query.N1qlQuery n1ql,
                              Class<T> entityClass)

Description copied from interface: CouchbaseOperations

Query the N1QL Service for JSON data of type T. Enough data to construct the full entity is expected to be selected, including the metadata (document id and cas), obtained through N1QL's query.

This is done via a N1qlQuery that contains a Statement and possibly additional query parameters (N1qlParams) and placeholder values if the statement contains placeholders.
Use N1qlQuery's factory methods to construct such a Query.

Weak consistency in the query (eg. ScanConsistency.NOT_BOUND) can lead to some documents being unreachable due to their deletion not having been indexed. These deleted null documents are eliminated from the result of this method.

Specified by:

findByN1QL in interface CouchbaseOperations

Type Parameters:

T - the entity class

Parameters:

n1ql - the N1QL query.

entityClass - the target class for the returned entities.

Returns:

the list of entities matching this query.

findByN1QLProjection

public <T> List<T> findByN1QLProjection(com.couchbase.client.java.query.N1qlQuery n1ql,
                                        Class<T> entityClass)

Description copied from interface: CouchbaseOperations

Query the N1QL Service for partial JSON data of type T. The selected field will be used in a straightforward decoding (no document, metadata like id nor cas) to map to a "fragment class".

This is done via a N1qlQuery that contains a Statement and possibly additional query parameters (N1qlParams) and placeholder values if the statement contains placeholders.
Use N1qlQuery's factory methods to construct such a Query.

Weak consistency in the query (eg. ScanConsistency.NOT_BOUND) can lead to some documents being unreachable due to their deletion not having been indexed. These deleted null documents are eliminated from the result of this method.

Specified by:

findByN1QLProjection in interface CouchbaseOperations

Type Parameters:

T - the fragment class

Parameters:

n1ql - the N1QL query.

entityClass - the target class for the returned fragments.

Returns:

the list of entities matching this query.

queryN1QL

public com.couchbase.client.java.query.N1qlQueryResult queryN1QL(com.couchbase.client.java.query.N1qlQuery query)

Description copied from interface: CouchbaseOperations

Query the N1QL Service with direct access to the N1qlQueryResult.

This is done via a N1qlQuery that can contain a Statement, additional query parameters (N1qlParams) and placeholder values if the statement contains placeholders.

Use N1qlQuery's factory methods to construct this.

Specified by:

queryN1QL in interface CouchbaseOperations

Parameters:

query - the N1QL query.

Returns:

N1qlQueryResult containing the results of the n1ql query.

exists

public boolean exists(String id)

Description copied from interface: CouchbaseOperations

Checks if the given document exists.

Specified by:

exists in interface CouchbaseOperations

Parameters:

id - the unique ID of the document.

Returns:

whether the document could be found or not.

remove

public void remove(Object objectToRemove)

Description copied from interface: CouchbaseOperations

Remove the given object from the bucket by id.

If the object is a String, it will be treated as the document key directly.

Specified by:

remove in interface CouchbaseOperations

Parameters:

objectToRemove - the Object to remove.

remove

public void remove(Object objectToRemove,
                   com.couchbase.client.java.PersistTo persistTo,
                   com.couchbase.client.java.ReplicateTo replicateTo)

Description copied from interface: CouchbaseOperations

Remove the given object from the bucket by id.

If the object is a String, it will be treated as the document key directly.

Specified by:

remove in interface CouchbaseOperations

Parameters:

objectToRemove - the Object to remove.

persistTo - the persistence constraint setting.

replicateTo - the replication constraint setting.

remove

public void remove(Collection<?> batchToRemove)

Description copied from interface: CouchbaseOperations

Remove a list of objects from the bucket by id.

Specified by:

remove in interface CouchbaseOperations

Parameters:

batchToRemove - the list of Objects to remove.

remove

public void remove(Collection<?> batchToRemove,
                   com.couchbase.client.java.PersistTo persistTo,
                   com.couchbase.client.java.ReplicateTo replicateTo)

Description copied from interface: CouchbaseOperations

Remove a list of objects from the bucket by id.

Specified by:

remove in interface CouchbaseOperations

Parameters:

batchToRemove - the list of Objects to remove.

persistTo - the persistence constraint setting.

replicateTo - the replication constraint setting.

execute

public <T> T execute(BucketCallback<T> action)

Description copied from interface: CouchbaseOperations

Executes a BucketCallback translating any exceptions as necessary.

Allows for returning a result object, that is a domain object or a collection of domain objects.

Specified by:

execute in interface CouchbaseOperations

Type Parameters:

T - the return type.

Parameters:

action - the action to execute in the callback.

Returns:

the return type.

executeAsync

public <T> rx.Observable<T> executeAsync(rx.Observable<T> asyncAction)

getCouchbaseBucket

public com.couchbase.client.java.Bucket getCouchbaseBucket()

Description copied from interface: CouchbaseOperations

Returns the linked Bucket to this template.

Specified by:

getCouchbaseBucket in interface CouchbaseOperations

Returns:

the client used for the template.

getCouchbaseClusterInfo

public com.couchbase.client.java.cluster.ClusterInfo getCouchbaseClusterInfo()

Description copied from interface: CouchbaseOperations

Returns the ClusterInfo about the cluster linked to this template.

Specified by:

getCouchbaseClusterInfo in interface CouchbaseOperations

Returns:

the info about the cluster the template connects to.

getConverter

public CouchbaseConverter getConverter()

Description copied from interface: CouchbaseOperations

Returns the underlying CouchbaseConverter.

Specified by:

getConverter in interface CouchbaseOperations

Returns:

CouchbaseConverter.

getDefaultConsistency

public Consistency getDefaultConsistency()

Description copied from interface: CouchbaseOperations

Returns the consistency parameter to be used by default for generated queries (views and N1QL) in repositories. Defaults to Consistency.DEFAULT_CONSISTENCY.

Specified by:

getDefaultConsistency in interface CouchbaseOperations

Returns:

the consistency to use for generated repository queries.

setDefaultConsistency

public void setDefaultConsistency(Consistency consistency)

keySettings

public void keySettings(KeySettings settings)

Description copied from interface: CouchbaseOperations

Add common key settings Throws UnsupportedOperationException if KeySettings is already set. It becomes immutable.

Specified by:

keySettings in interface CouchbaseOperations

Parameters:

settings - KeySettings

keySettings

public KeySettings keySettings()

Description copied from interface: CouchbaseOperations

Get key settings associated with the template

Specified by:

keySettings in interface CouchbaseOperations

Returns:

KeySettings

getGeneratedId

public String getGeneratedId(Object entity)

Description copied from interface: CouchbaseOperations

Get generated id - applies both using prefix and suffix through entity as well as template KeySettings ** NOTE: UNIQUE strategy will generate different ids each time ***

Specified by:

getGeneratedId in interface CouchbaseOperations

Parameters:

entity - the entity object.

Returns:

id the couchbase document key.