dk.heick.caching.persistences.jpa.single

Interface CachedJPAEntityRepository<K extends Serializable,V extends Serializable>

Type Parameters:

K - the key type.

V - the value type.

All Known Implementing Classes:

DefaultCachedJPAEntityRepository

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

The repository instance used by DefaultJPAEntityValueManager.

Author:

Frederik Heick

See Also:

DefaultJPAEntityValueManager

Method Summary

Modifier and Type	Method and Description
void	delete(K key) This will delete a row in the table with the key.
int	deleteAll() Delete all rows from the table.
int	deleteAll(Date belowExpireDateTime) Delete all rows from this table where "CachedJPAEntity.getExpireDateTime()" is below belowExpireDateTime.
CachedJPAEntity<K,V>	get(K key) Gets a row with the key.
List<CachedJPAEntity<K,V>>	getAll() Get all rows from the table
Class<? extends CachedJPAEntity<K,V>>	getEntityClazz() Gets the class instance of CachedJPAEntity.
javax.persistence.EntityManagerFactory	getEntityManagerFactory() Gets the EntityManagerFactory.
void	insert(CachedJPAEntity<K,V> entity) This will insert a row in the table.
long	size() The number of rows in the table
void	updateExpireTime(K key, Date expireDateTime) Update the "expireDateTime" column for a key.
void	validate() Should validate that the "entityManagerFactory" is not null and the entity clazz is not null 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 and the entity clazz is not null 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()

getAll

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

Get all rows from the table

Returns:

all rows

Throws:

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

deleteAll

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

Delete all rows from this table where "CachedJPAEntity.getExpireDateTime()" is below belowExpireDateTime.

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

deleteAll

int deleteAll()
       throws javax.persistence.PersistenceException

Delete all rows from the table.

Returns:

the number of rows deleted.

Throws:

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

get

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

Gets a row with the key.

Parameters:

key - the key.

Returns:

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

Throws:

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

insert

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

This will insert a row in the table.

Parameters:

entity - the entity instance.

Throws:

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

delete

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

This will delete a row in the table with the key.

Parameters:

key - the key

Throws:

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

size

long size()
   throws javax.persistence.PersistenceException

The number of rows in the table

Returns:

the number of rows in the table.

Throws:

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

updateExpireTime

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

Update the "expireDateTime" column for a key.

Parameters:

key - the key.

expireDateTime - the new expire datetime for the key.

Throws:

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

getEntityManagerFactory

javax.persistence.EntityManagerFactory getEntityManagerFactory()

Gets the EntityManagerFactory.

Returns:

the EntityManagerFactory.

getEntityClazz

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

Gets the class instance of CachedJPAEntity.

Returns:

class instance of CachedJPAEntity.