dk.heick.caching

Class LRUCachingMapFactory

java.lang.Object

dk.heick.caching.LRUCachingMapFactory

public final class LRUCachingMapFactory
extends Object

Constructor Summary

Constructors

Constructor and Description
LRUCachingMapFactory()

Method Summary

Modifier and Type	Method and Description
static <V extends Serializable> DefaultFileLRUCachingMap<String,V>	createFilenameSerializedCache(LRUCachingMapConfiguration configuration, CachingDirectory cachingDirectory, PersistencesRestoreMethod persistencesRestoreMethod) Constructs a file serialization cache, where the values is serialized to files.
static <V> DefaultFileLRUCachingMap<String,V>	createFilenameXmlCache(LRUCachingMapConfiguration configuration, CachingDirectory cachingDirectory, Class<V> xmlClazz, PersistencesRestoreMethod persistencesRestoreMethod) Constructs a xml file marshall/unmarshall cache.
static DefaultFilenameFileReferenceLRUCachingMap	createFileReferenceCache(LRUCachingMapConfiguration configuration, CachingDirectory cachingDirectory, PersistencesRestoreMethod persistencesRestoreMethod) Constructs a file reference cache.
static <K extends Serializable,V extends Serializable> DefaultFileLRUCachingMap<K,V>	createIndexedSerializedCache(LRUCachingMapConfiguration configuration, CachingDirectory cachingDirectory, PersistencesRestoreMethod persistencesRestoreMethod, int indexSaveInterval) Constructs a indexed serializable file cache.
static <K extends Serializable,V> DefaultFileLRUCachingMap<K,V>	createIndexedXmlCache(LRUCachingMapConfiguration configuration, CachingDirectory cachingDirectory, Class<V> xmlClazz, PersistencesRestoreMethod persistencesRestoreMethod, int indexSaveInterval) Constructs a indexed XML file cache.
static <K extends Serializable,V extends Serializable> DefaultLRUCachingMap<K,V>	createJPACache(LRUCachingMapConfiguration configuration, Class<? extends CachedJPAEntity<K,V>> entityClazz, javax.persistence.EntityManagerFactory entityManagerFactory, PersistencesRestoreMethod persistencesRestoreMethod) Constructs a JPA cache for an entity.
static <K extends Serializable,V extends Serializable> DefaultLRUCachingMap<K,V>	createJPAGroupedCache(LRUCachingMapConfiguration configuration, String group, Class<? extends CachedGroupJPAEntity<K,V>> entityGroupClazz, javax.persistence.EntityManagerFactory entityManagerFactory, PersistencesRestoreMethod persistencesRestoreMethod) Constructs a group JPA cache for an entity, where multiple cache instances can share the same table.
static <K extends Serializable,V extends Keyed<K> & Serializable> DefaultFileLRUCachingMap<K,V>	createKeyedSerializedCache(LRUCachingMapConfiguration configuration, CachingDirectory cachingDirectory, PersistencesRestoreMethod persistencesRestoreMethod) Constructs a keyed serializable file cache.
static <K extends Serializable,V extends Keyed<K>> DefaultFileLRUCachingMap<K,V>	createKeyedXmlCache(LRUCachingMapConfiguration configuration, CachingDirectory cachingDirectory, Class<V> xmlClazz, PersistencesRestoreMethod persistencesRestoreMethod) Constructs a keyed XML file cache.
static <K,V> DefaultLRUCachingMap<K,V>	createMemoryCache(LRUCachingMapConfiguration configuration) Constructs a memory cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

LRUCachingMapFactory

public LRUCachingMapFactory()

Method Detail

createMemoryCache

public static <K,V> DefaultLRUCachingMap<K,V> createMemoryCache(LRUCachingMapConfiguration configuration)
                                                         throws NullPointerException

Constructs a memory cache.

Parameters:

configuration - the configuration.

Returns:

an instance of DefaultMemoryLRUCachingMap using DefaultMemoryValueManager

Throws:

NullPointerException

See Also:

DefaultLRUCachingMapConfiguration, DefaultLRUCachingMap, DefaultMemoryValueManager

createFileReferenceCache

public static DefaultFilenameFileReferenceLRUCachingMap createFileReferenceCache(LRUCachingMapConfiguration configuration,
                                                                                 CachingDirectory cachingDirectory,
                                                                                 PersistencesRestoreMethod persistencesRestoreMethod)

Constructs a file reference cache.

Parameters:

configuration - the configuration.

cachingDirectory - where to look after files when restoring the cache.

persistencesRestoreMethod - which method to use when restoring the cache.

Returns:

a instance of DefaultFilenameFileReferenceLRUCachingMap

See Also:

DefaultLRUCachingMapConfiguration

createIndexedXmlCache

public static <K extends Serializable,V> DefaultFileLRUCachingMap<K,V> createIndexedXmlCache(LRUCachingMapConfiguration configuration,
                                                                                             CachingDirectory cachingDirectory,
                                                                                             Class<V> xmlClazz,
                                                                                             PersistencesRestoreMethod persistencesRestoreMethod,
                                                                                             int indexSaveInterval)

Constructs a indexed XML file cache.

Parameters:

configuration - the configuration.

cachingDirectory - where to look after files when restoring the cache.

xmlClazz - the class of V which has an XmlRootElement annotation.

persistencesRestoreMethod - which method to use when restoring the cache.

indexSaveInterval - how many changes (put,remove) must occur before the index file (filename to key) index is persisted.

Returns:

an instance of DefaultFileLRUCachingMap

createKeyedXmlCache

public static <K extends Serializable,V extends Keyed<K>> DefaultFileLRUCachingMap<K,V> createKeyedXmlCache(LRUCachingMapConfiguration configuration,
                                                                                                            CachingDirectory cachingDirectory,
                                                                                                            Class<V> xmlClazz,
                                                                                                            PersistencesRestoreMethod persistencesRestoreMethod)

Constructs a keyed XML file cache.

Parameters:

configuration - the configuration.

cachingDirectory - where to look after files when restoring the cache.

xmlClazz - the class of V which has an XmlRootElement annotation.

persistencesRestoreMethod - which method to use when restoring the cache.

Returns:

an instance of DefaultFileLRUCachingMap

createFilenameXmlCache

public static <V> DefaultFileLRUCachingMap<String,V> createFilenameXmlCache(LRUCachingMapConfiguration configuration,
                                                                            CachingDirectory cachingDirectory,
                                                                            Class<V> xmlClazz,
                                                                            PersistencesRestoreMethod persistencesRestoreMethod)

Constructs a xml file marshall/unmarshall cache.

Parameters:

configuration - the configuration

cachingDirectory - the directory where the xml files is stored, and loaded and restored from.

xmlClazz - the class of V which has an XmlRootElement annotation.

persistencesRestoreMethod - which method to use when restoring the cache.

Returns:

an instance of DefaultFileLRUCachingMap

See Also:

XmlRootElement

createIndexedSerializedCache

public static <K extends Serializable,V extends Serializable> DefaultFileLRUCachingMap<K,V> createIndexedSerializedCache(LRUCachingMapConfiguration configuration,
                                                                                                                         CachingDirectory cachingDirectory,
                                                                                                                         PersistencesRestoreMethod persistencesRestoreMethod,
                                                                                                                         int indexSaveInterval)

Constructs a indexed serializable file cache.

Parameters:

configuration - the configuration.

cachingDirectory - where to look after files when restoring the cache.

persistencesRestoreMethod - which method to use when restoring the cache.

indexSaveInterval - how many changes (put,remove) must occur before the index file (filename to key) index is persisted.

Returns:

an instance of DefaultFileLRUCachingMap

createKeyedSerializedCache

public static <K extends Serializable,V extends Keyed<K> & Serializable> DefaultFileLRUCachingMap<K,V> createKeyedSerializedCache(LRUCachingMapConfiguration configuration,
                                                                                                                                  CachingDirectory cachingDirectory,
                                                                                                                                  PersistencesRestoreMethod persistencesRestoreMethod)

Constructs a keyed serializable file cache.

Parameters:

configuration - the configuration.

cachingDirectory - where to look after files when restoring the cache.

persistencesRestoreMethod - which method to use when restoring the cache.

Returns:

an instance of DefaultFileLRUCachingMap

createFilenameSerializedCache

public static <V extends Serializable> DefaultFileLRUCachingMap<String,V> createFilenameSerializedCache(LRUCachingMapConfiguration configuration,
                                                                                                        CachingDirectory cachingDirectory,
                                                                                                        PersistencesRestoreMethod persistencesRestoreMethod)

Constructs a file serialization cache, where the values is serialized to files.

Parameters:

configuration - the configuration

cachingDirectory - the directory where the files is serialized to, and loaded and restored from.

persistencesRestoreMethod - which method to use when restoring the cache.

Returns:

an instance of DefaultFileLRUCachingMap

createJPACache

public static <K extends Serializable,V extends Serializable> DefaultLRUCachingMap<K,V> createJPACache(LRUCachingMapConfiguration configuration,
                                                                                                       Class<? extends CachedJPAEntity<K,V>> entityClazz,
                                                                                                       javax.persistence.EntityManagerFactory entityManagerFactory,
                                                                                                       PersistencesRestoreMethod persistencesRestoreMethod)

Constructs a JPA cache for an entity.

Parameters:

configuration - the configuration

entityClazz - a class instance which extends CachedJPAEntity and has JPA annotations.

entityManagerFactory - an instance of entityManagerFactory.

persistencesRestoreMethod - which method to use when restoring the cache.

Returns:

an instance DefaultLRUCachingMap.

createJPAGroupedCache

public static <K extends Serializable,V extends Serializable> DefaultLRUCachingMap<K,V> createJPAGroupedCache(LRUCachingMapConfiguration configuration,
                                                                                                              String group,
                                                                                                              Class<? extends CachedGroupJPAEntity<K,V>> entityGroupClazz,
                                                                                                              javax.persistence.EntityManagerFactory entityManagerFactory,
                                                                                                              PersistencesRestoreMethod persistencesRestoreMethod)

Constructs a group JPA cache for an entity, where multiple cache instances can share the same table.

Parameters:

configuration - the configuration

group - the group name of the cache.

entityGroupClazz - a class instance which extends CachedGroupJPAEntity and has JPA annotations.

entityManagerFactory - an instance of entityManagerFactory.

persistencesRestoreMethod - which method to use when restoring the cache.

Returns:

an instance DefaultLRUCachingMap.