au.org.ala.biocache.util

Class WMSCache

java.lang.Object

au.org.ala.biocache.util.WMSCache

public class WMSCache
extends Object

A cache of points and colours for WMS. Cache size defaults can overridden in wms.properties or directly at runtime. TODO refactor to use the common configuration file biocache-config.properties Management of the cache size not exact.

Author:

Adam

Constructor Summary

Constructors

Constructor and Description
WMSCache()

Method Summary

Methods

Modifier and Type	Method and Description
static void	empty() empty the WMSCache
static WMSTile	get(String query, String colourmode, PointType pointType) Retrieve search parameter object
static String	getKey(String query, String colourmode, PointType pointType) cache key built from query, colourmode and point type.
static long	getLargestCacheableSize()
static long	getMaxCacheSize()
static long	getMinCacheSize()
static boolean	isCachable(WMSTile wco, int occurrenceCount, boolean hasCounts) determine if a WMSTile created with the given characteristics will be too large for the cache.
static boolean	isEnabled() WMSCache is enabled
static boolean	isFull() Test if cache is full.
static boolean	put(String q, String colourMode, PointType pointType, WMSTile wco) Store search params and return key.
static void	remove(String q, String colourMode, PointType pointType) remove a specific cache entry.
static void	setLargestCacheableSize(long sizeInBytes)
static void	setMaxCacheSize(long sizeInBytes)
static void	setMinCacheSize(long sizeInBytes)

Methods inherited from class java.lang.Object

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

Constructor Detail

WMSCache

public WMSCache()

Method Detail

put

public static boolean put(String q,
          String colourMode,
          PointType pointType,
          WMSTile wco)

Store search params and return key.

Parameters:

q - Search url params to store as String.

colourMode - to store as String

pointType - resolution of data to store as PointType

wco - data to store as WMSTile

Returns:

true when successfully added to the cache. WMSCache must be enabled, not full. wco must be not too large and not cause the cache to exceed max size when added.

getKey

public static String getKey(String query,
            String colourmode,
            PointType pointType)

cache key built from query, colourmode and point type.

Parameters:

query -

colourmode -

pointType -

Returns:

cache key as String

get

public static WMSTile get(String query,
          String colourmode,
          PointType pointType)

Retrieve search parameter object

Parameters:

query - Search url params to store as String.

colourmode - colourmode as String

pointType - data resolution as PointType

Returns:

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

isEnabled

public static boolean isEnabled()

WMSCache is enabled

Returns:

true when WMSCache is enabled

empty

public static void empty()

empty the WMSCache

remove

public static void remove(String q,
          String colourMode,
          PointType pointType)

remove a specific cache entry.

Parameters:

q - Search url params to store as String.

colourMode - to store as String

pointType - resolution of data to store as PointType

isCachable

public static boolean isCachable(WMSTile wco,
                 int occurrenceCount,
                 boolean hasCounts)

determine if a WMSTile created with the given characteristics will be too large for the cache.

Parameters:

wco -

occurrenceCount -

hasCounts -

Returns:

isFull

public static boolean isFull()

Test if cache is full. Note: all put requests into the cache will fail should it be full.

Returns:

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