io.orchestrate.client.dao

Class GenericAsyncDao<T>

java.lang.Object

io.orchestrate.client.dao.GenericAsyncDao<T>

Type Parameters:

T - The type this object will control CRUD operations for.

All Implemented Interfaces:

AsyncDao<T>

public abstract class GenericAsyncDao<T>
extends java.lang.Object
implements AsyncDao<T>

A generic object for CRUD data access operations.

See Also:

http://java.orchestrate.io/examples/#data-access-object

Constructor Summary

Constructors

Constructor and Description
GenericAsyncDao(Client client, java.lang.String collection, java.lang.Class<T> clazz) Create a data access object to store objects of type T to the specified collection using the client.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	delete(java.lang.String key) Delete the object with the specified key.
void	delete(java.lang.String key, java.lang.Iterable<ResponseListener<java.lang.Boolean>> listeners) Delete the object with the specified key and fire the listeners on the response.
java.lang.Boolean	delete(java.lang.String key, KvMetadata metadata) Delete the object with the specified key if and only if the ref from the metadata matches the current stored ref.
void	delete(java.lang.String key, KvMetadata metadata, java.lang.Iterable<ResponseListener<java.lang.Boolean>> listeners) Delete the object with the specified key if and only if the ref from the metadata matches the current stored ref.
java.lang.Boolean	delete(java.lang.String key, java.lang.String currentRef) Delete the object with the specified key if and only if the currentRef matches the current stored ref.
void	delete(java.lang.String key, java.lang.String currentRef, java.lang.Iterable<ResponseListener<java.lang.Boolean>> listeners) Delete the object with the specified key if and only if the currentRef matches the current stored ref.
java.lang.Boolean	deleteCollection() Delete all objects in the collection.
void	deleteCollection(java.lang.Iterable<ResponseListener<java.lang.Boolean>> listeners) Delete all objects in the collection.
KvObject<T>	findOne(java.lang.String key) Return the KvObject for the object stored with the specified key.
void	findOne(java.lang.String key, java.lang.Iterable<ResponseListener<KvObject<T>>> listeners) Find the object stored with the specified key and fire the listeners on the response.
KvObject<T>	findOne(java.lang.String key, KvMetadata metadata) Return the KvObject for the object stored with the specified key and the version from the metadata.
void	findOne(java.lang.String key, KvMetadata metadata, java.lang.Iterable<ResponseListener<KvObject<T>>> listeners) Find the object stored with the specified key and the version from the metadata and fire the listeners on the response.
KvObject<T>	findOne(java.lang.String key, java.lang.String ref) Return the KvObject for the object stored with the specified key and the version ref.
void	findOne(java.lang.String key, java.lang.String ref, java.lang.Iterable<ResponseListener<KvObject<T>>> listeners) Find the object stored with the specified key and the version ref and fire the listeners on the response.
KvMetadata	save(java.lang.String key, T value) Save the specified value to the key.
KvMetadata	save(java.lang.String key, T value, boolean ifAbsent) Save the specified value to the key if and only if the key does not already exist when ifAbsent is true.
void	save(java.lang.String key, T value, boolean ifAbsent, java.lang.Iterable<ResponseListener<KvMetadata>> listeners) Save the specified value to the key if and only if the key does not already exist when ifAbsent is true.
void	save(java.lang.String key, T value, java.lang.Iterable<ResponseListener<KvMetadata>> listeners) Save the specified value to the key and fire the listeners on the response.
KvMetadata	save(java.lang.String key, T value, KvMetadata metadata) Save the specified value to the key if and only if the ref from the metadata matches the current stored ref.
void	save(java.lang.String key, T value, KvMetadata metadata, java.lang.Iterable<ResponseListener<KvMetadata>> listeners) Save the specified value to the key if and only if the ref from the metadata matches the current stored ref.
KvMetadata	save(java.lang.String key, T value, java.lang.String currentRef) Save the specified value to the key if and only if the currentRef matches the current stored ref.
void	save(java.lang.String key, T value, java.lang.String currentRef, java.lang.Iterable<ResponseListener<KvMetadata>> listeners) Save the specified value to the key if and only if the currentRef matches the current stored ref.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericAsyncDao

public GenericAsyncDao(Client client,
               java.lang.String collection,
               java.lang.Class<T> clazz)

Create a data access object to store objects of type T to the specified collection using the client.

Parameters:

client - The client used to query the Orchestrate.io service.

collection - The name of the collection to store objects to.

clazz - Type information for deserializing to type T at runtime.

Method Detail

findOne

public KvObject<T> findOne(java.lang.String key)

Return the KvObject for the object stored with the specified key.

Specified by:

findOne in interface AsyncDao<T>

Parameters:

key - The key used to find the object.

Returns:

The KvObject with this key, may return null.

findOne

public void findOne(java.lang.String key,
           java.lang.Iterable<ResponseListener<KvObject<T>>> listeners)

Find the object stored with the specified key and fire the listeners on the response.

Specified by:

findOne in interface AsyncDao<T>

Parameters:

key - The key used to find the object.

listeners - The callbacks to fire on the operation's response.

findOne

public KvObject<T> findOne(java.lang.String key,
                  KvMetadata metadata)

Return the KvObject for the object stored with the specified key and the version from the metadata.

Specified by:

findOne in interface AsyncDao<T>

Parameters:

key - The key used to find the object.

metadata - The metadata about the version of the object to get.

Returns:

The KvObject with this key and version (from the metadata), may return null.

findOne

public void findOne(java.lang.String key,
           KvMetadata metadata,
           java.lang.Iterable<ResponseListener<KvObject<T>>> listeners)

Find the object stored with the specified key and the version from the metadata and fire the listeners on the response.

Specified by:

findOne in interface AsyncDao<T>

Parameters:

key - The key used to find the object.

metadata - The metadata about the version of the object to get.

listeners - The callbacks to fire on the operation's response.

findOne

public KvObject<T> findOne(java.lang.String key,
                  java.lang.String ref)

Return the KvObject for the object stored with the specified key and the version ref.

Specified by:

findOne in interface AsyncDao<T>

Parameters:

key - The key used to find the object.

ref - The version of the object.

Returns:

A KvObject with this key and version, may return null.

findOne

public void findOne(java.lang.String key,
           java.lang.String ref,
           java.lang.Iterable<ResponseListener<KvObject<T>>> listeners)

Find the object stored with the specified key and the version ref and fire the listeners on the response.

Specified by:

findOne in interface AsyncDao<T>

Parameters:

key - The key used to find the object.

ref - The version of the object.

listeners - The callbacks to fire on the operation's response.

save

public KvMetadata save(java.lang.String key,
              T value)

Save the specified value to the key. This returns the KvMetadata about the saved object.

Specified by:

save in interface AsyncDao<T>

Parameters:

key - The key to save the specified value to.

value - The object to save.

Returns:

The metadata about the saved object.

save

public void save(java.lang.String key,
        T value,
        java.lang.Iterable<ResponseListener<KvMetadata>> listeners)

Save the specified value to the key and fire the listeners on the response.

Specified by:

save in interface AsyncDao<T>

Parameters:

key - The key to save the specified value to.

value - The object to save.

listeners - The callbacks to fire on the operation's response.

save

public KvMetadata save(java.lang.String key,
              T value,
              boolean ifAbsent)

Save the specified value to the key if and only if the key does not already exist when ifAbsent is true.

If ifAbsent is true and the key already exists the KvMetadata will be null.

Specified by:

save in interface AsyncDao<T>

Parameters:

key - The key to save the specified value to.

value - The object to save.

ifAbsent - When true the store operation will only succeed if the specified key does not already exist.

Returns:

The metadata about the saved object, may be null.

save

public void save(java.lang.String key,
        T value,
        boolean ifAbsent,
        java.lang.Iterable<ResponseListener<KvMetadata>> listeners)

Save the specified value to the key if and only if the key does not already exist when ifAbsent is true. Fire the listeners on the response.

If ifAbsent is true and the key already exists the KvMetadata will be null.

Specified by:

save in interface AsyncDao<T>

Parameters:

key - The key to save the specified value to.

value - The object to save.

ifAbsent - When true the store operation will only succeed if the specified key does not already exist.

listeners - The callbacks to fire on the operation's response.

save

public KvMetadata save(java.lang.String key,
              T value,
              KvMetadata metadata)

Save the specified value to the key if and only if the ref from the metadata matches the current stored ref.

If the ref from the metadata does not match the current ref stored, the resulting KvMetadata will be null.

Specified by:

save in interface AsyncDao<T>

Parameters:

key - The key to save the specified value to.

value - The object to save.

metadata - The metadata about the current object stored to this key.

Returns:

The metadata about the saved object.

save

public void save(java.lang.String key,
        T value,
        KvMetadata metadata,
        java.lang.Iterable<ResponseListener<KvMetadata>> listeners)

Save the specified value to the key if and only if the ref from the metadata matches the current stored ref. Fire the listeners on the response.

Specified by:

save in interface AsyncDao<T>

Parameters:

key - The key to save the specified value to.

value - The object to save.

metadata - The metadata about the current object stored to this key.

listeners - The callbacks to fire on the operation's response.

save

public KvMetadata save(java.lang.String key,
              T value,
              java.lang.String currentRef)

Save the specified value to the key if and only if the currentRef matches the current stored ref.

If the currentRef does not match the current ref stored, the resulting KvMetadata will be null.

Specified by:

save in interface AsyncDao<T>

Parameters:

key - The key to save the specified value to.

value - The object to save.

currentRef - The ref of the last known object stored to this key.

Returns:

The metadata about the saved object.

save

public void save(java.lang.String key,
        T value,
        java.lang.String currentRef,
        java.lang.Iterable<ResponseListener<KvMetadata>> listeners)

Save the specified value to the key if and only if the currentRef matches the current stored ref. Fire the listeners on the response.

If the currentRef does not match the current ref stored, the resulting KvMetadata will be null.

Specified by:

save in interface AsyncDao<T>

Parameters:

key - The key to save the specified value to.

value - The object to save.

currentRef - The ref of the last known object stored to this key.

listeners - The callbacks to fire on the operation's response.

delete

public java.lang.Boolean delete(java.lang.String key)

Delete the object with the specified key.

Specified by:

delete in interface AsyncDao<T>

Parameters:

key - The key of the object to delete.

Returns:

The success of the delete.

delete

public void delete(java.lang.String key,
          java.lang.Iterable<ResponseListener<java.lang.Boolean>> listeners)

Delete the object with the specified key and fire the listeners on the response.

Specified by:

delete in interface AsyncDao<T>

Parameters:

key - The key of the object to delete.

listeners - The callbacks to fire on the operation's response.

delete

public java.lang.Boolean delete(java.lang.String key,
                       KvMetadata metadata)

Delete the object with the specified key if and only if the ref from the metadata matches the current stored ref.

If the ref from the metadata does not match the current ref stored, the result will be false.

Specified by:

delete in interface AsyncDao<T>

Parameters:

key - The key of the object to delete.

metadata - The metadata about the current object stored to this key.

Returns:

The success of the delete.

delete

public void delete(java.lang.String key,
          KvMetadata metadata,
          java.lang.Iterable<ResponseListener<java.lang.Boolean>> listeners)

Delete the object with the specified key if and only if the ref from the metadata matches the current stored ref.

If the ref from the metadata does not match the current ref stored, the result will be false.

Specified by:

delete in interface AsyncDao<T>

Parameters:

key - The key of the object to delete.

metadata - The metadata about the current object stored to this key.

listeners - The callbacks to fire on the operation's response.

delete

public java.lang.Boolean delete(java.lang.String key,
                       java.lang.String currentRef)

Delete the object with the specified key if and only if the currentRef matches the current stored ref.

If the currentRef does not match the current ref stored, the result will be false.

Specified by:

delete in interface AsyncDao<T>

Parameters:

key - The key of the object to delete.

currentRef - The ref of the last known object stored to this key.

Returns:

The success of the delete.

delete

public void delete(java.lang.String key,
          java.lang.String currentRef,
          java.lang.Iterable<ResponseListener<java.lang.Boolean>> listeners)

Delete the object with the specified key if and only if the currentRef matches the current stored ref.

If the currentRef does not match the current ref stored, the result will be false.

Specified by:

delete in interface AsyncDao<T>

Parameters:

key - The key of the object to delete.

currentRef - The ref of the last known object stored to this key.

listeners - The callbacks to fire on the operation's response.

deleteCollection

public java.lang.Boolean deleteCollection()

Delete all objects in the collection.

Specified by:

deleteCollection in interface AsyncDao<T>

Returns:

The success of the delete.

deleteCollection

public void deleteCollection(java.lang.Iterable<ResponseListener<java.lang.Boolean>> listeners)

Delete all objects in the collection.

Specified by:

deleteCollection in interface AsyncDao<T>

Parameters:

listeners - The callbacks to fire on the operation's response.