dk.heick.caching.persistences.jpa.grouped

Class DefaultCachedGroupJPAEntityRepository<K extends Serializable,V extends Serializable>

java.lang.Object

dk.heick.caching.persistences.jpa.grouped.DefaultCachedGroupJPAEntityRepository<K,V>

Type Parameters:

K - the key type.

V - the valye type.

All Implemented Interfaces:

CachedGroupJPAEntityRepository<K,V>

public class DefaultCachedGroupJPAEntityRepository<K extends Serializable,V extends Serializable>
extends Object
implements CachedGroupJPAEntityRepository<K,V>

The repository instance of CachedGroupJPAEntityRepository.

Author:

Frederik Heick

See Also:

CachedGroupJPAEntityRepository

Constructor Summary

Constructors

Constructor and Description
DefaultCachedGroupJPAEntityRepository(String group, Class<? extends CachedGroupJPAEntity<K,V>> entityClazz, javax.persistence.EntityManagerFactory entityManagerFactory) Constructor

Method Summary

Modifier and Type	Method and Description
void	delete(K key) This will delete a row in the table with the key and with the "group".
int	deleteAll() Delete all rows from the table with this "group"
int	deleteAll(Date belowExpireDateTime) Delete all rows from this table where "CachedGroupJPAEntity.getExpireDateTime()" is below belowExpireDateTime and with this "group".
CachedGroupJPAEntity<K,V>	get(K key) Gets a row with the key and group.
List<CachedGroupJPAEntity<K,V>>	getAll() Get all rows from the table with this "group"
Class<? extends CachedGroupJPAEntity<K,V>>	getEntityClazz() Gets the class instance of CachedGroupJPAEntity.
javax.persistence.EntityManagerFactory	getEntityManagerFactory() Gets the EntityManagerFactory.
String	getGroup() Gets the group name for this repository, is part of the ID for CachedGroupJPAEntity.
void	insert(CachedGroupJPAEntity<K,V> entity) This will insert a row in the table with the "group".
long	size() The number of rows in the table with the "group".
void	updateExpireTime(K key, Date expireDateTime) Update the "expireDateTime" column for a key on with the "group.
void	validate() Should validate that the "entityManagerFactory" is not null, the entity clazz is not null, and the group is not null or empty, or the entity clazz do not have a "@Entity" annotation.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCachedGroupJPAEntityRepository

public DefaultCachedGroupJPAEntityRepository(String group,
                                             Class<? extends CachedGroupJPAEntity<K,V>> entityClazz,
                                             javax.persistence.EntityManagerFactory entityManagerFactory)
                                      throws NullPointerException,
                                             IllegalArgumentException

Constructor

Parameters:

group - the group name of the repository, must be not null and none empty.

entityClazz - the class instance of CachedGroupJPAEntity.

entityManagerFactory - an instance of entityManagerFactory.

Throws:

IllegalArgumentException - see validate method, or if entityClazz do not have "@Entity" as annotation.

NullPointerException - if either entityManagerFactory, queryEntityManager or entityClazz is null.

See Also:

validate()

Method Detail

getEntityClazz

public final Class<? extends CachedGroupJPAEntity<K,V>> getEntityClazz()

Description copied from interface: CachedGroupJPAEntityRepository

Gets the class instance of CachedGroupJPAEntity.

Specified by:

getEntityClazz in interface CachedGroupJPAEntityRepository<K extends Serializable,V extends Serializable>

Returns:

class instance of CachedGroupJPAEntity.

validate

public void validate()
              throws NullPointerException,
                     IllegalArgumentException

Description copied from interface: CachedGroupJPAEntityRepository

Should validate that the "entityManagerFactory" is not null, the entity clazz is not null, and the group is not null or empty, or the entity clazz do not have a "@Entity" annotation.

Specified by:

validate in interface CachedGroupJPAEntityRepository<K extends Serializable,V extends Serializable>

Throws:

NullPointerException - if either of the above conditions is not true.

IllegalArgumentException - if either of the above conditions is not true.

See Also:

CachedGroupJPAEntityRepository.getEntityClazz(), CachedGroupJPAEntityRepository.getEntityManagerFactory(), CachedGroupJPAEntityRepository.getGroup()

getAll

public List<CachedGroupJPAEntity<K,V>> getAll()
                                       throws javax.persistence.PersistenceException

Description copied from interface: CachedGroupJPAEntityRepository

Get all rows from the table with this "group"

Specified by:

getAll in interface CachedGroupJPAEntityRepository<K extends Serializable,V extends Serializable>

Returns:

all rows which has this group.

Throws:

javax.persistence.PersistenceException - if unable to get all rows.

See Also:

CachedGroupJPAEntityRepository.getGroup()

deleteAll

public int deleteAll()
              throws javax.persistence.PersistenceException

Description copied from interface: CachedGroupJPAEntityRepository

Delete all rows from the table with this "group"

Specified by:

deleteAll in interface CachedGroupJPAEntityRepository<K extends Serializable,V extends Serializable>

Returns:

the number of rows deleted.

Throws:

javax.persistence.PersistenceException - if unable to performed deletion.

See Also:

CachedGroupJPAEntityRepository.getGroup()

get

public CachedGroupJPAEntity<K,V> get(K key)
                              throws javax.persistence.PersistenceException

Description copied from interface: CachedGroupJPAEntityRepository

Gets a row with the key and group.

Specified by:

get in interface CachedGroupJPAEntityRepository<K extends Serializable,V extends Serializable>

Parameters:

key - the key.

Returns:

a row with the key in this group, if none found null is returned.

Throws:

javax.persistence.PersistenceException - if unable to perform find.

See Also:

CachedGroupJPAEntityRepository.getGroup()

insert

public void insert(CachedGroupJPAEntity<K,V> entity)
            throws javax.persistence.PersistenceException

Description copied from interface: CachedGroupJPAEntityRepository

This will insert a row in the table with the "group". This method should enforce that the entity has this "group" set.

Specified by:

insert in interface CachedGroupJPAEntityRepository<K extends Serializable,V extends Serializable>

Parameters:

entity - the entity instance.

Throws:

javax.persistence.PersistenceException - if unable to perform persist.

See Also:

CachedGroupJPAEntityRepository.getGroup(), CachedGroupJPAID.setGroup(String)

size

public long size()
          throws javax.persistence.PersistenceException

Description copied from interface: CachedGroupJPAEntityRepository

The number of rows in the table with the "group".

Specified by:

size in interface CachedGroupJPAEntityRepository<K extends Serializable,V extends Serializable>

Returns:

the number of rows in the table with the "group".

Throws:

javax.persistence.PersistenceException - if unable to performed query.

See Also:

CachedGroupJPAEntityRepository.getGroup()

updateExpireTime

public void updateExpireTime(K key,
                             Date expireDateTime)
                      throws javax.persistence.PersistenceException

Description copied from interface: CachedGroupJPAEntityRepository

Update the "expireDateTime" column for a key on with the "group.

Specified by:

updateExpireTime in interface CachedGroupJPAEntityRepository<K extends Serializable,V extends Serializable>

Parameters:

key - the key.

expireDateTime - the new expire datetime for the key.

Throws:

javax.persistence.PersistenceException - if unable to perform update.

See Also:

CachedGroupJPAEntityRepository.getGroup()

deleteAll

public int deleteAll(Date belowExpireDateTime)
              throws javax.persistence.PersistenceException

Description copied from interface: CachedGroupJPAEntityRepository

Delete all rows from this table where "CachedGroupJPAEntity.getExpireDateTime()" is below belowExpireDateTime and with this "group".

Specified by:

deleteAll in interface CachedGroupJPAEntityRepository<K extends Serializable,V extends Serializable>

Parameters:

belowExpireDateTime - the datetime a rows "getExpireDateTime()" has to be below.

Returns:

the number of rows deleted.

Throws:

javax.persistence.PersistenceException - if unable to performed deletion.

See Also:

CommonCachedJPAEntity.getExpireDateTime(), CachedGroupJPAEntityRepository.getGroup()

delete

public void delete(K key)
            throws javax.persistence.PersistenceException

Description copied from interface: CachedGroupJPAEntityRepository

This will delete a row in the table with the key and with the "group".

Specified by:

delete in interface CachedGroupJPAEntityRepository<K extends Serializable,V extends Serializable>

Parameters:

key - the key

Throws:

javax.persistence.PersistenceException - if unable to performed deletion.

See Also:

CachedGroupJPAEntityRepository.getGroup()

getEntityManagerFactory

public javax.persistence.EntityManagerFactory getEntityManagerFactory()

Description copied from interface: CachedGroupJPAEntityRepository

Gets the EntityManagerFactory.

Specified by:

getEntityManagerFactory in interface CachedGroupJPAEntityRepository<K extends Serializable,V extends Serializable>

Returns:

the EntityManagerFactory.

getGroup

public final String getGroup()

Description copied from interface: CachedGroupJPAEntityRepository

Gets the group name for this repository, is part of the ID for CachedGroupJPAEntity.

Specified by:

getGroup in interface CachedGroupJPAEntityRepository<K extends Serializable,V extends Serializable>

Returns:

the group name, must be not null and none empty.