dk.heick.caching.persistences.jpa.grouped

Interface CachedGroupJPAEntityRepository<K extends Serializable,V extends Serializable>

Type Parameters:

K - the key type.

V - the valye type.

All Known Implementing Classes:

DefaultCachedGroupJPAEntityRepository

public interface CachedGroupJPAEntityRepository<K extends Serializable,V extends Serializable>

The repository instance used by DefaultGroupJPAEntityValueManager.

Author:

Frederik Heick

See Also:

DefaultGroupJPAEntityValueManager

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.

Method Detail

validate

void validate()
       throws IllegalArgumentException,
              NullPointerException

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.

Throws:

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

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

See Also:

getEntityClazz(), getEntityManagerFactory(), getGroup()

getAll

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

Get all rows from the table with this "group"

Returns:

all rows which has this group.

Throws:

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

See Also:

getGroup()

deleteAll

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

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

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(), getGroup()

deleteAll

int deleteAll()
       throws javax.persistence.PersistenceException

Delete all rows from the table with this "group"

Returns:

the number of rows deleted.

Throws:

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

See Also:

getGroup()

get

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

Gets a row with the key and group.

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:

getGroup()

insert

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

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

Parameters:

entity - the entity instance.

Throws:

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

See Also:

getGroup(), CachedGroupJPAID.setGroup(String)

delete

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

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

Parameters:

key - the key

Throws:

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

See Also:

getGroup()

size

long size()
   throws javax.persistence.PersistenceException

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

Returns:

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

Throws:

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

See Also:

getGroup()

updateExpireTime

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

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

Parameters:

key - the key.

expireDateTime - the new expire datetime for the key.

Throws:

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

See Also:

getGroup()

getEntityManagerFactory

javax.persistence.EntityManagerFactory getEntityManagerFactory()

Gets the EntityManagerFactory.

Returns:

the EntityManagerFactory.

getEntityClazz

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

Gets the class instance of CachedGroupJPAEntity.

Returns:

class instance of CachedGroupJPAEntity.

getGroup

String getGroup()

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

Returns:

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