dk.heick.caching.persistences.jpa.grouped

Class DefaultGroupJPAEntityValueManager<K extends Serializable,V extends Serializable>

java.lang.Object

dk.heick.caching.persistences.AbstractPersistenceValueManager<K,V>

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

Type Parameters:

K - the key type.

V - the value type.

All Implemented Interfaces:

ValueManager<K,V>

public class DefaultGroupJPAEntityValueManager<K extends Serializable,V extends Serializable>
extends AbstractPersistenceValueManager<K,V>

The valueManager which handles key,values for CachedGroupJPAEntity using the CachedGroupJPAEntityRepository.

Author:

Frederik Heick

Constructor Summary

Constructors

Constructor and Description
DefaultGroupJPAEntityValueManager(CachedGroupJPAEntityRepository<K,V> repository, PersistencesRestoreMethod persistencesRestoreMethod) Constructor.
DefaultGroupJPAEntityValueManager(String group, Class<? extends CachedGroupJPAEntity<K,V>> clazz, javax.persistence.EntityManagerFactory entityManagerFactory, PersistencesRestoreMethod persistencesRestoreMethod) Constructor.

Method Summary

Modifier and Type	Method and Description
protected CachedGroupJPAEntity<K,V>	constructEntity(K key, V value, Date expireDateTime) Constructs an instance of "CachedGroupJPAEntity" clazz.
AbstractValueWrapper<K,V>	constructWrapper(K key, V value) Construct a ValueWrapper for the value, but do not sets the value, this is done either in "restore" or "storeValue"
void	flush() This is ensures that any memory data that needs to be persisted is flushed.
CachedGroupJPAEntityRepository<K,V>	getRepository() Gets the "CachedGroupJPAEntityRepository" instance.
int	removeAll() Remove all persisted values from the value "storage".
void	removeValue(AbstractValueWrapper<K,V> valueWrapper) Removes the value
void	restore(LRUCachingMap<K,V> map) Restores any persisted key/values to the LRUCachingMap when the map is constructed.
V	retrieveValue(AbstractValueWrapper<K,V> valueWrapper) Retrives value via the data contained in the ValueWrapper
void	storeValue(AbstractValueWrapper<K,V> valueWrapper, K key, V value, Date expireDateTime) Stores the value and giving the ValueWrapper enough information to retrieve/remove it again.
void	updateExpireTime(AbstractValueWrapper<K,V> valueWrapper, Date expireDateTime) Update the expiration date time for a value.

Methods inherited from class dk.heick.caching.persistences.AbstractPersistenceValueManager

getLogger, getPersistencesRestoreMethod, isPersisted

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultGroupJPAEntityValueManager

public DefaultGroupJPAEntityValueManager(CachedGroupJPAEntityRepository<K,V> repository,
                                         PersistencesRestoreMethod persistencesRestoreMethod)
                                  throws IllegalArgumentException,
                                         NullPointerException

Constructor.

Parameters:

repository - an instance of CachedGroupJPAEntityRepository

persistencesRestoreMethod - the persistencesRestoreMethod

Throws:

IllegalArgumentException - if repository is invalid.

NullPointerException - if either repository or persistencesRestoreMethod is null.

DefaultGroupJPAEntityValueManager

public DefaultGroupJPAEntityValueManager(String group,
                                         Class<? extends CachedGroupJPAEntity<K,V>> clazz,
                                         javax.persistence.EntityManagerFactory entityManagerFactory,
                                         PersistencesRestoreMethod persistencesRestoreMethod)
                                  throws IllegalArgumentException,
                                         NullPointerException

Constructor.

Parameters:

group - the group name, none empty.

clazz - the class instance of CachedGroupJPAEntity.

entityManagerFactory - the entityManagerFactory.

persistencesRestoreMethod - the persistencesRestoreMethod

Throws:

IllegalArgumentException - if repository is invalid.

NullPointerException - if either repository or persistencesRestoreMethod is null.

Method Detail

getRepository

public CachedGroupJPAEntityRepository<K,V> getRepository()

Gets the "CachedGroupJPAEntityRepository" instance.

Returns:

the repository.

restore

public final void restore(LRUCachingMap<K,V> map)

Description copied from interface: ValueManager

Restores any persisted key/values to the LRUCachingMap when the map is constructed.
This is used if your values is stored in a persistence storage like a file etc.
This method should find all persistence instances and reinitialize the "map" using the method "restoreCacheElement(K,AbstractValueWrapper<K,V>,Date)".
This method must call the "flush" method when done.

Parameters:

map - the map instance.

See Also:

LRUCachingMap.restoreCacheElement(Object, AbstractValueWrapper, Date), PersistencesRestoreMethod, AbstractPersistenceValueManager, ValueManager.flush()

removeAll

public final int removeAll()

Description copied from interface: ValueManager

Remove all persisted values from the value "storage".

Returns:

the number of values is removed.

constructWrapper

public final AbstractValueWrapper<K,V> constructWrapper(K key,
                                                        V value)

Description copied from interface: ValueManager

Construct a ValueWrapper for the value, but do not sets the value, this is done either in "restore" or "storeValue"

Parameters:

key - the key

value - the value

Returns:

a ValueWrapper instance.

See Also:

ValueManager.restore(LRUCachingMap), ValueManager.storeValue(AbstractValueWrapper, Object, Object, Date)

removeValue

public final void removeValue(AbstractValueWrapper<K,V> valueWrapper)
                       throws RuntimeException

Description copied from interface: ValueManager

Removes the value

Throws:

RuntimeException - if for any reason the value could not be removed.

retrieveValue

public final V retrieveValue(AbstractValueWrapper<K,V> valueWrapper)
                      throws RuntimeException

Description copied from interface: ValueManager

Retrives value via the data contained in the ValueWrapper

Parameters:

valueWrapper - the

Returns:

the Value

Throws:

RuntimeException - if for any reason the value could not be retrieved.

storeValue

public final void storeValue(AbstractValueWrapper<K,V> valueWrapper,
                             K key,
                             V value,
                             Date expireDateTime)
                      throws RuntimeException

Description copied from interface: ValueManager

Stores the value and giving the ValueWrapper enough information to retrieve/remove it again.

Parameters:

valueWrapper - the wrapper instance to store the value or information about the value, this can be used to minimize the memory footprint.

key - the key

value - the value

expireDateTime - the expiration datetime for the key, this can be stored on a persisted key/value and used in case of a restore.

Throws:

RuntimeException - if for any reason the value could not be store.

updateExpireTime

public void updateExpireTime(AbstractValueWrapper<K,V> valueWrapper,
                             Date expireDateTime)
                      throws RuntimeException

Description copied from interface: ValueManager

Update the expiration date time for a value.

Parameters:

valueWrapper - the wrapper which holds enough information to get the value.

expireDateTime - the new expireDateTime

Throws:

RuntimeException - if this for any reasons fails.

flush

public void flush()

This is ensures that any memory data that needs to be persisted is flushed.
This is the case with Indexed value managers.
This method must be called by the LRUCachingMap implementation after "cleanup" and after "restore". Does nothing.

See Also:

LRUCachingMap.cleanup(), ValueManager.restore(LRUCachingMap)

constructEntity

protected CachedGroupJPAEntity<K,V> constructEntity(K key,
                                                    V value,
                                                    Date expireDateTime)
                                             throws RuntimeException

Constructs an instance of "CachedGroupJPAEntity" clazz. Using "new Date()" as store time and "getGroup()" as group.

Parameters:

key - the key

value - the value

expireDateTime - the expiration datetime.

Returns:

an instance if the CachedGroupJPAEntity using reflection for a no-args constuctor.

Throws:

RuntimeException - if the instance could not be created.