org.dasein.persist
Class RelationalCache<T extends org.dasein.util.CachedItem>

java.lang.Object
  org.dasein.persist.PersistentCache<T>
      org.dasein.persist.RelationalCache<T>

public final class RelationalCache<T extends org.dasein.util.CachedItem>
extends PersistentCache<T>

Nested Class Summary

static class

RelationalCache.OrderedColumn

Nested classes/interfaces inherited from class org.dasein.persist.PersistentCache

PersistentCache.EntityJoin

Field Summary

static org.apache.log4j.Logger

logger

Constructor Summary

RelationalCache()

Method Summary

long	count() Counts the total number of objects governed by this factory in the database.
long	count(SearchTerm... terms)
T	create(Transaction xaction, Map<String,Object> state) Creates the specified object with the data provided in the specified state under the governance of the specified transaction.
Collection<T>	find(SearchTerm[] terms, org.dasein.util.JiteratorFilter<T> filter, Boolean orderDesc, String... orderFields)
T	get(Object primaryKeyValue) Retrieves the object uniquely identified by the value for the specified ID field.
protected void	init(Class<T> cls, Key... keys) Constructs a new persistent factory for objects of the specified class with the named unique identifier attributes.
Collection<T>	list() Loads all elements of this class from the data store.
void	remove(Transaction xaction, T item) Removes the specified item from the system permanently.
String	toString()
void	update(Transaction xaction, T item, Map<String,Object> state) Updates the specified object with the data provided in the specified state under the governance of the specified transaction.

Methods inherited from class org.dasein.persist.PersistentCache

addJoinEntity, find, getCache, getCache, getJoin, getJoins, getKeyValue, getKeyValue, getKeyValue, getKeyValues, getNewKeyValue, getPrimaryKey, getPrimaryKeyField, getSecondaryKeys, getTarget, initBase, list, matchKeys

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final org.apache.log4j.Logger logger

Constructor Detail

RelationalCache

public RelationalCache()

Method Detail

init

protected void init(Class<T> cls,
                    Key... keys)

Constructs a new persistent factory for objects of the specified class with the named unique identifier attributes.

Overrides:

init in class PersistentCache<T extends org.dasein.util.CachedItem>

Parameters:

cls - the class of objects managed by this factory

keys - a list of unique identifiers for instances of the specified class

count

public long count()
           throws PersistenceException

Counts the total number of objects governed by this factory in the database.

Overrides:

count in class PersistentCache<T extends org.dasein.util.CachedItem>

Returns:

the number of objects in the database

Throws:

PersistenceException - an error occurred counting the elements in the database

count

public long count(SearchTerm... terms)
           throws PersistenceException

Overrides:

count in class PersistentCache<T extends org.dasein.util.CachedItem>

Throws:

PersistenceException

create

public T create(Transaction xaction,
                Map<String,Object> state)
                                            throws PersistenceException

Creates the specified object with the data provided in the specified state under the governance of the specified transaction.

Specified by:

create in class PersistentCache<T extends org.dasein.util.CachedItem>

Parameters:

xaction - the transaction governing this event

state - the new state for the new object

Throws:

PersistenceException - an error occurred talking to the data store, or creates are not supported

find

public Collection<T> find(SearchTerm[] terms,
                          org.dasein.util.JiteratorFilter<T> filter,
                          Boolean orderDesc,
                          String... orderFields)
                                                      throws PersistenceException

Specified by:

find in class PersistentCache<T extends org.dasein.util.CachedItem>

Throws:

PersistenceException

get

public T get(Object primaryKeyValue)
                                         throws PersistenceException

Retrieves the object uniquely identified by the value for the specified ID field.

Specified by:

get in class PersistentCache<T extends org.dasein.util.CachedItem>

Parameters:

primaryKeyValue - the ID field identifying the object

Returns:

the object matching the query criterion

Throws:

PersistenceException - an error occurred talking to the data store

list

public Collection<T> list()
                                                      throws PersistenceException

Loads all elements of this class from the data store. Use this method only when you know exactly what you are doing. Otherwise, you will pull a lot of data.

Specified by:

list in class PersistentCache<T extends org.dasein.util.CachedItem>

Returns:

all objects from the database

Throws:

PersistenceException - an error occurred executing the query

remove

public void remove(Transaction xaction,
                   T item)
            throws PersistenceException

Removes the specified item from the system permanently.

Specified by:

remove in class PersistentCache<T extends org.dasein.util.CachedItem>

Parameters:

xaction - the transaction under which this event is occurring

item - the item to be removed

Throws:

PersistenceException - an error occurred talking to the data store or removal of these objects is prohibited

toString

public String toString()

Overrides:

toString in class Object

update

public void update(Transaction xaction,
                   T item,
                   Map<String,Object> state)
            throws PersistenceException

Updates the specified object with the data provided in the specified state under the governance of the specified transaction.

Specified by:

update in class PersistentCache<T extends org.dasein.util.CachedItem>

Parameters:

xaction - the transaction governing this event

item - the item to be updated

state - the new state for the updated object

Throws:

PersistenceException - an error occurred talking to the data store, or updates are not supported