com.cloudant.client.cache

Class DatabaseCache

java.lang.Object

com.cloudant.client.api.Database

com.cloudant.client.cache.DatabaseCache

Direct Known Subclasses:

DatabaseCacheWithLifetimes

public class DatabaseCache
extends Database

A Database implementation with a cache.

Constructor Summary

Constructors

Constructor and Description
DatabaseCache(Database database, Cache<java.lang.String,java.lang.Object> cacheInstance) Constructor which is designed to work with a variety of different caches.

Method Summary

Modifier and Type	Method and Description
java.util.List<Response>	bulk(java.util.List<?> list)
boolean	contains(java.lang.String id) Checks if the cache contains the specified document.
<T> T	find(java.lang.Class<T> classType, java.lang.String id) Preferentially use the cache for the find operation.
<T> T	find(java.lang.Class<T> classType, java.lang.String id, Params params) Preferentially use the cache for the find operation.
<T> T	findAny(java.lang.Class<T> classType, java.lang.String uri) Preferentially use the cache for the find operation.
Cache<java.lang.String,java.lang.Object>	getCache() Returns the cache so that the application can manage it using the Cache API methods.
Response	post(java.lang.Object object)
Response	post(java.lang.Object object, int writeQuorum)
Response	remove(java.lang.Object object)
Response	save(java.lang.Object object)
Response	save(java.lang.Object object, int writeQuorum)
Response	update(java.lang.Object object)
Response	update(java.lang.Object object, int writeQuorum)

Methods inherited from class com.cloudant.client.api.Database

changes, createIndex, createIndex, deleteIndex, ensureFullCommit, find, find, find, findByIndex, findByIndex, getAllDocsRequestBuilder, getAttachment, getAttachment, getDBUri, getDesignDocumentManager, getPermissions, getShard, getShards, getViewRequestBuilder, info, invokeUpdateHandler, listIndices, remove, removeAttachment, removeAttachment, saveAttachment, saveAttachment, search, setPermissions

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseCache

public DatabaseCache(Database database,
                     Cache<java.lang.String,java.lang.Object> cacheInstance)

Constructor which is designed to work with a variety of different caches.

Parameters:

database - non-null data structure with information about the database connection

cacheInstance - non-null cache instance which has already been created and initialized

Method Detail

getCache

public Cache<java.lang.String,java.lang.Object> getCache()

Returns the cache so that the application can manage it using the Cache API methods.

Returns:

the cache instance

find

public <T> T find(java.lang.Class<T> classType,
                  java.lang.String id)

Preferentially use the cache for the find operation. Adds the retrieved T to the cache if it was not present and was found in the remote database.

Overrides:

find in class Database

find

public <T> T find(java.lang.Class<T> classType,
                  java.lang.String id,
                  Params params)

Preferentially use the cache for the find operation. Adds the retrieved T to the cache if it was not present and was found in the remote database.

Overrides:

find in class Database

findAny

public <T> T findAny(java.lang.Class<T> classType,
                     java.lang.String uri)

Preferentially use the cache for the find operation. Adds the retrieved T to the cache if it was not present and was found in the remote database.

Note that this method uses the URI as the cache key (and not document ID) since the document may come from a different database or server. As a result even if the same object is already stored in the cache under its document ID it would be retrieved remotely by this method and re-stored in the cache with a URI key. This also prevents the remove method from removing these objects from the cache so it is recommended to only use this method with a CacheWithLifetimes cache to avoid the cache growing unbounded.

Overrides:

findAny in class Database

contains

public boolean contains(java.lang.String id)

Checks if the cache contains the specified document. If it does not then checks if the database contains the specified document.

Overrides:

contains in class Database

save

public Response save(java.lang.Object object)

If the operation was successful then the object is also added to the cache.

Overrides:

save in class Database

save

public Response save(java.lang.Object object,
                     int writeQuorum)

If the operation was successful then the object is also added to the cache.

Overrides:

save in class Database

post

public Response post(java.lang.Object object)

If the operation was successful then the object is also added to the cache.

Overrides:

post in class Database

post

public Response post(java.lang.Object object,
                     int writeQuorum)

If the operation was successful then the object is also added to the cache.

Overrides:

post in class Database

update

public Response update(java.lang.Object object)

If the operation was successful then the object is also updated in the cache.

Overrides:

update in class Database

update

public Response update(java.lang.Object object,
                       int writeQuorum)

If the operation was successful then the object is also updated in the cache.

Overrides:

update in class Database

remove

public Response remove(java.lang.Object object)

If the operation was successful then the object is also removed from the cache.

Overrides:

remove in class Database

bulk

public java.util.List<Response> bulk(java.util.List<?> list)

Objects are added to or updated in the cache if their remote operation completes successfully.

Overrides:

bulk in class Database