info.archinnov.achilles.persistence

Class PersistenceManager

java.lang.Object

info.archinnov.achilles.persistence.PersistenceManager

Direct Known Subclasses:

BatchingPersistenceManager

public class PersistenceManager
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurationContext	configContext
protected PersistenceContextFactory	contextFactory
protected DaoContext	daoContext
protected Map<Class<?>,EntityMeta>	entityMetaMap
protected EntityProxifier	proxifier

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PersistenceManager(Map<Class<?>,EntityMeta> entityMetaMap, PersistenceContextFactory contextFactory, DaoContext daoContext, ConfigurationContext configContext)

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	find(Class<T> entityClass, Object primaryKey) Find an entity.
<T> T	find(Class<T> entityClass, Object primaryKey, ConsistencyLevel readLevel) Find an entity with the given Consistency Level for read
protected ConfigurationContext	getConfigContext()
protected Map<Class<?>,EntityMeta>	getEntityMetaMap()
com.datastax.driver.core.Session	getNativeSession()
<T> T	getProxy(Class<T> entityClass, Object primaryKey) Create a proxy for the entity.
<T> T	getProxy(Class<T> entityClass, Object primaryKey, ConsistencyLevel readLevel) Create a proxy for the entity.
<T> TypedQueryBuilder<T>	indexedQuery(Class<T> entityClass, IndexCondition indexCondition) Return a CQL typed query builder All found entities will be in 'managed' state
<T> List<T>	initAndRemoveProxy(List<T> entities) Shorthand for manager.removeProxy(manager.initialize(List entities))
<T> Set<T>	initAndRemoveProxy(Set<T> entities) Shorthand for manager.removeProxy(manager.initialize(Set entities))
<T> T	initAndRemoveProxy(T entity) Shorthand for manager.removeProxy(manager.initialize(T entity))
<T> List<T>	initialize(List<T> entities) Initialize all lazy fields of a list of 'managed' entities, except WideMap/Counter fields.
<T> Set<T>	initialize(Set<T> entities) Initialize all lazy fields of a set of 'managed' entities, except WideMap/Counter fields.
<T> T	initialize(T entity) Initialize all lazy fields of a 'managed' entity, except WideMap/Counter fields.
protected PersistenceContext	initPersistenceContext(Class<?> entityClass, Object primaryKey, Options options)
protected PersistenceContext	initPersistenceContext(Object entity, Options options)
NativeQueryBuilder	nativeQuery(String queryString, Object... boundValues) Return a CQL native query builder
<T> T	persist(T entity) Persist an entity.
<T> T	persist(T entity, Options options) Persist an entity with the given options.
<T> TypedQueryBuilder<T>	rawTypedQuery(Class<T> entityClass, String queryString, Object... boundValues) Return a CQL typed query builder All found entities will be returned as raw entities and not 'managed' by Achilles
void	refresh(Object entity) Refresh an entity.
void	refresh(Object entity, ConsistencyLevel readLevel) Refresh an entity with the given Consistency Level for read.
void	remove(Object entity) Remove an entity.
void	remove(Object entity, Options options) Remove an entity with the given Consistency Level for write.
void	removeById(Class<?> entityClass, Object primaryKey) Remove an entity by its id.
void	removeById(Class<?> entityClass, Object primaryKey, ConsistencyLevel writeLevel) Remove an entity by its id with the given Consistency Level for write.
<T> List<T>	removeProxy(List<T> proxies) Remove the proxy of a list of 'managed' entities and return the underlying "raw" entities See removeProxy(T)
<T> T	removeProxy(T proxy) Remove the proxy of a 'managed' entity and return the underlying "raw" entity If the argument is not a proxy objet, return itself Else, return the target object behind the proxy
protected void	setConfigContext(ConfigurationContext configContext)
protected void	setEntityMetaMap(Map<Class<?>,EntityMeta> entityMetaMap)
<T> SliceQueryBuilder<T>	sliceQuery(Class<T> entityClass)
<T> TypedQueryBuilder<T>	typedQuery(Class<T> entityClass, String queryString, Object... boundValues) Return a CQL typed query builder All found entities will be in 'managed' state
<T> Set<T>	unwrap(Set<T> proxies) Remove the proxy of a set of 'managed' entities return the underlying "raw" entities See removeProxy(T)
void	update(Object entity) Update a "managed" entity
void	update(Object entity, Options options) Update a "managed" entity

Methods inherited from class java.lang.Object

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

Field Detail

entityMetaMap

protected Map<Class<?>,EntityMeta> entityMetaMap

configContext

protected ConfigurationContext configContext

contextFactory

protected PersistenceContextFactory contextFactory

proxifier

protected EntityProxifier proxifier

daoContext

protected DaoContext daoContext

Constructor Detail

PersistenceManager

protected PersistenceManager(Map<Class<?>,EntityMeta> entityMetaMap,
                  PersistenceContextFactory contextFactory,
                  DaoContext daoContext,
                  ConfigurationContext configContext)

Method Detail

persist

public <T> T persist(T entity)

Persist an entity.

Parameters:

entity - Entity to be persisted

Returns:

proxified entity

persist

public <T> T persist(T entity,
            Options options)

Persist an entity with the given options.

Parameters:

entity - Entity to be persisted

options - options for consistency level, ttl and timestamp

Returns:

proxified entity

update

public void update(Object entity)

Update a "managed" entity

Parameters:

entity - Managed entity to be updated

update

public void update(Object entity,
          Options options)

Update a "managed" entity

Parameters:

entity - Managed entity to be updated

options - options for consistency level, ttl and timestamp

remove

public void remove(Object entity)

Remove an entity.

Parameters:

entity - Entity to be removed

removeById

public void removeById(Class<?> entityClass,
              Object primaryKey)

Remove an entity by its id.

Parameters:

entityClass - Entity class

primaryKey - Primary key

remove

public void remove(Object entity,
          Options options)

Remove an entity with the given Consistency Level for write.

Parameters:

entity - Entity to be removed

options - options for consistency level and timestamp

removeById

public void removeById(Class<?> entityClass,
              Object primaryKey,
              ConsistencyLevel writeLevel)

Remove an entity by its id with the given Consistency Level for write.

Parameters:

entityClass - Entity class

primaryKey - Primary key

find

public <T> T find(Class<T> entityClass,
         Object primaryKey)

Find an entity.

Parameters:

entityClass - Entity type

primaryKey - Primary key (Cassandra row key) of the entity to load

find

public <T> T find(Class<T> entityClass,
         Object primaryKey,
         ConsistencyLevel readLevel)

Find an entity with the given Consistency Level for read

Parameters:

entityClass - Entity type

primaryKey - Primary key (Cassandra row key) of the entity to load

readLevel - Consistency Level for read

getProxy

public <T> T getProxy(Class<T> entityClass,
             Object primaryKey)

Create a proxy for the entity. An new empty entity will be created, populated with the provided primary key and then proxified. This method never returns null Use this method to perform direct update without read-before-write

Parameters:

entityClass - Entity type

primaryKey - Primary key (Cassandra row key) of the entity to initialize

getProxy

public <T> T getProxy(Class<T> entityClass,
             Object primaryKey,
             ConsistencyLevel readLevel)

Create a proxy for the entity. An new empty entity will be created, populated with the provided primary key and then proxified. This method never returns null Use this method to perform direct update without read-before-write

Parameters:

entityClass - Entity type

primaryKey - Primary key (Cassandra row key) of the entity to initialize

readLevel - Consistency Level for read

refresh

public void refresh(Object entity)
             throws AchillesStaleObjectStateException

Refresh an entity.

Parameters:

entity - Entity to be refreshed

Throws:

AchillesStaleObjectStateException

refresh

public void refresh(Object entity,
           ConsistencyLevel readLevel)
             throws AchillesStaleObjectStateException

Refresh an entity with the given Consistency Level for read.

Parameters:

entity - Entity to be refreshed

readLevel - Consistency Level for read

Throws:

AchillesStaleObjectStateException

initialize

public <T> T initialize(T entity)

Initialize all lazy fields of a 'managed' entity, except WideMap/Counter fields. Raise an IllegalStateException if the entity is not 'managed'

initialize

public <T> Set<T> initialize(Set<T> entities)

Initialize all lazy fields of a set of 'managed' entities, except WideMap/Counter fields. Raise an IllegalStateException if an entity is not 'managed'

initialize

public <T> List<T> initialize(List<T> entities)

Initialize all lazy fields of a list of 'managed' entities, except WideMap/Counter fields. Raise an IllegalStateException if an entity is not 'managed'

initAndRemoveProxy

public <T> T initAndRemoveProxy(T entity)

Shorthand for manager.removeProxy(manager.initialize(T entity))

initAndRemoveProxy

public <T> Set<T> initAndRemoveProxy(Set<T> entities)

Shorthand for manager.removeProxy(manager.initialize(Set entities))

initAndRemoveProxy

public <T> List<T> initAndRemoveProxy(List<T> entities)

Shorthand for manager.removeProxy(manager.initialize(List entities))

removeProxy

public <T> T removeProxy(T proxy)

Remove the proxy of a 'managed' entity and return the underlying "raw" entity If the argument is not a proxy objet, return itself
Else, return the target object behind the proxy

Parameters:

proxy -

Returns:

real object

removeProxy

public <T> List<T> removeProxy(List<T> proxies)

Remove the proxy of a list of 'managed' entities and return the underlying "raw" entities See removeProxy(T)

Parameters:

proxies - list of proxified entity

Returns:

real object list

unwrap

public <T> Set<T> unwrap(Set<T> proxies)

Remove the proxy of a set of 'managed' entities return the underlying "raw" entities See removeProxy(T)

Parameters:

proxies - set of proxified entities

Returns:

real object set

sliceQuery

public <T> SliceQueryBuilder<T> sliceQuery(Class<T> entityClass)

nativeQuery

public NativeQueryBuilder nativeQuery(String queryString,
                             Object... boundValues)

Return a CQL native query builder

Parameters:

queryString - native CQL query string, including limit, ttl and consistency options

boundValues - values to be bind to the parameterized query, if any

Returns:

NativeQueryBuilder

typedQuery

public <T> TypedQueryBuilder<T> typedQuery(Class<T> entityClass,
                                  String queryString,
                                  Object... boundValues)

Return a CQL typed query builder All found entities will be in 'managed' state

Parameters:

entityClass - type of entity to be returned

queryString - native CQL query string, including limit, ttl and consistency options

boundValues - values to be bind to the parameterized query, if any

Returns:

TypedQueryBuilder

indexedQuery

public <T> TypedQueryBuilder<T> indexedQuery(Class<T> entityClass,
                                    IndexCondition indexCondition)

Return a CQL typed query builder All found entities will be in 'managed' state

Parameters:

entityClass - type of entity to be returned

indexCondition - index condition

Returns:

TypedQueryBuilder

rawTypedQuery

public <T> TypedQueryBuilder<T> rawTypedQuery(Class<T> entityClass,
                                     String queryString,
                                     Object... boundValues)

Return a CQL typed query builder All found entities will be returned as raw entities and not 'managed' by Achilles

Parameters:

entityClass - type of entity to be returned

queryString - native CQL query string, including limit, ttl and consistency options

boundValues - values to be bind to the parameterized query, if any

Returns:

TypedQueryBuilder

initPersistenceContext

protected PersistenceContext initPersistenceContext(Class<?> entityClass,
                                        Object primaryKey,
                                        Options options)

initPersistenceContext

protected PersistenceContext initPersistenceContext(Object entity,
                                        Options options)

getNativeSession

public com.datastax.driver.core.Session getNativeSession()

getEntityMetaMap

protected Map<Class<?>,EntityMeta> getEntityMetaMap()

getConfigContext

protected ConfigurationContext getConfigContext()

setEntityMetaMap

protected void setEntityMetaMap(Map<Class<?>,EntityMeta> entityMetaMap)

setConfigContext

protected void setConfigContext(ConfigurationContext configContext)