au.org.ala.biocache.util

Class ParamsCache

java.lang.Object

au.org.ala.biocache.util.ParamsCache

public class ParamsCache
extends Object

Manage cache of POST'ed search parameter q in memory and on disk.

Author:

Adam

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	qidPattern

Constructor Summary

Constructors

Constructor and Description
ParamsCache()

Method Summary

Methods

Modifier and Type	Method and Description
static void	deleteOldParamFiles() delete save params cache objects that are older than MAX_FILE_AGE.
static ParamsCacheObject	get(long key) Retrive search parameter object
static long	getLargestCacheableSize()
static long	getMaxCacheSize()
static long	getMaxFileAge()
static long	getMinCacheSize()
static ParamsCacheObject	getParamCacheObjectFromQuery(String query) Retrieves the ParamsCacheObject based on the supplied query string.
static String	getTempFilePath()
static long	put(String q, String displayQ, String wkt, double[] bbox, String[] fqs) Store search params and return key.
static void	setLargestCacheableSize(long sizeInBytes)
static void	setMaxCacheSize(long sizeInBytes)
static void	setMaxFileAge(long ageInMs)
static void	setMinCacheSize(long sizeInBytes)
static void	setTempFilePath(String path)

Methods inherited from class java.lang.Object

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

Field Detail

qidPattern

public static Pattern qidPattern

Constructor Detail

ParamsCache

public ParamsCache()

Method Detail

put

public static long put(String q,
       String displayQ,
       String wkt,
       double[] bbox,
       String[] fqs)
                throws ParamsCacheSizeException

Store search params and return key.

Parameters:

q - Search parameter q to store.

displayQ - Search display q to store.

Returns:

id to retrieve stored value as long.

Throws:

ParamsCacheSizeException

get

public static ParamsCacheObject get(long key)
                             throws ParamsCacheMissingException

Retrive search parameter object

Parameters:

key - id returned by put as long.

Returns:

search parameter q as String, or null if not in memory or in file storage.

Throws:

ParamsCacheMissingException

getParamCacheObjectFromQuery

public static ParamsCacheObject getParamCacheObjectFromQuery(String query)
                                                      throws ParamsCacheMissingException

Retrieves the ParamsCacheObject based on the supplied query string.

Parameters:

query -

Returns:

Throws:

Exception

ParamsCacheMissingException

deleteOldParamFiles

public static void deleteOldParamFiles()

delete save params cache objects that are older than MAX_FILE_AGE.

setMaxCacheSize

public static void setMaxCacheSize(long sizeInBytes)

getMaxCacheSize

public static long getMaxCacheSize()

setMinCacheSize

public static void setMinCacheSize(long sizeInBytes)

getMinCacheSize

public static long getMinCacheSize()

setLargestCacheableSize

public static void setLargestCacheableSize(long sizeInBytes)

getLargestCacheableSize

public static long getLargestCacheableSize()

setTempFilePath

public static void setTempFilePath(String path)

getTempFilePath

public static String getTempFilePath()

setMaxFileAge

public static void setMaxFileAge(long ageInMs)

getMaxFileAge

public static long getMaxFileAge()