Class ExpiringGeoCache<T extends Cacheable>

java.lang.Object

org.deltava.util.cache.Cache<T>

org.deltava.util.cache.ExpiringCache<T>

org.deltava.util.cache.ExpiringGeoCache<T>

Type Parameters:

T - the Cacheable object type

All Implemented Interfaces:

GeoCache<T>

public class ExpiringGeoCache<T extends Cacheable>
extends ExpiringCache<T>
implements GeoCache<T>

A cache to store geographic lookups. Lat/long coordinates are automatically reduced to a set number of decimal places.

Since:

7.3

Version:

7.4

Author:

Luke

Nested Class Summary

Nested classes/interfaces inherited from class ExpiringCache

ExpiringCache.ExpiringLocalCacheEntry<U>, ExpiringCache.ExpiringNullCacheEntry<U>

Modifier and Type	Class	Description
protected class	ExpiringCache.ExpiringLocalCacheEntry<U extends T>
protected class	ExpiringCache.ExpiringNullCacheEntry<U extends T>	A null cache entry for expiring caches.

Field Summary

Fields inherited from class ExpiringCache

_expiry, _lastCreationTime

Modifier and Type	Field	Description
protected int	_expiry
protected long	_lastCreationTime

Fields inherited from class Cache

_cache

Modifier and Type	Field	Description
protected final ConcurrentMap<Object, CacheEntry<T>>	_cache

Constructor Summary

Constructors

Constructor	Description
ExpiringGeoCache(int maxSize, int expiryTime, double roundAmt)	Creates a new Cache.

Method Summary

Modifier and Type	Method	Description
void	add(GeoLocation loc, T data)	Adds a geographically located object to the cache.
void	addNull(GeoLocation loc)	Adds a null entry to the cache.
boolean	contains(GeoLocation loc)	Returns whether the cache contains an entry for a particular location.
T	get(GeoLocation loc)	Retrieves an object from the cache.
double	getRoundingAmount()	Returns the precision of the lat/long key rounding.
void	remove(GeoLocation loc)	Removes a location entry from the cache.

Methods inherited from class ExpiringCache

addEntry, addNullEntry, checkOverflow, contains, get, get, isExpired, setExpiration

Modifier and Type	Method	Description
protected void	addEntry(T obj)	Adds an entry to the cache.
protected void	addNullEntry(Object key)	Adds a null entry to the cache.
protected void	checkOverflow()	Purges expired entries from the cache.
boolean	contains(Object key)	Returns if the cache contains a particular cache key and the key has not expired.
T	get(Object key)	Returns an unexpired entry from the cache.
T	get(Object key, boolean ifExpired)	Returns an entry from the cache.
boolean	isExpired(Object key)	Queries the cache to determine if an object has expired
void	setExpiration(int expiry)	Sets the cache's expiration interval.

Methods inherited from class Cache

add, addAll, addNull, clear, getAll, getErrors, getHits, getMaxSize, getRequests, hit, isRemote, remove, request, setMaxSize, size

Modifier and Type	Method	Description
final void	add(T entry)	Adds an entry to the cache.
void	addAll(Collection<? extends T> entries)	Adds a number of entries to the cache.
final void	addNull(String key)	Adds a null entry to the cache.
void	clear()	Clears the cache.
Map<Object,T>	getAll(Collection<?> keys)	Returns multiple objects from the cache.
long	getErrors()	Returns the total number of cache errors.
final long	getHits()	Returns the total number of cache hits.
int	getMaxSize()	Returns the maximum size of the cache.
final long	getRequests()	Returns the total number of cache requests.
protected void	hit()	Log a cache hit.
boolean	isRemote()	Returns if the cache is a remote cache.
void	remove(Object key)	Invalidate a cache entry.
protected void	request()	Log a cache request.
final void	setMaxSize(int size)	Sets the maximum size of the cache.
int	size()	Returns the current size of the cache.

Methods inherited from class Object

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

Methods inherited from interface GeoCache

createGeoKey

Modifier and Type	Method	Description
default String	createGeoKey(GeoLocation loc)	Creates a lat/long key by rounding to the specific number of decimal places.

Constructor Details

ExpiringGeoCache

public ExpiringGeoCache(int maxSize,
 int expiryTime,
 double roundAmt)

Creates a new Cache.

Parameters:

maxSize - the maximum number of entries

expiryTime - the expiration time in seconds

roundAmt - the number of decimal places to round to

See Also:

• Cache.setMaxSize(int)
• ExpiringCache.setExpiration(int)

Method Details

getRoundingAmount

public double getRoundingAmount()

Description copied from interface: GeoCache

Returns the precision of the lat/long key rounding.

Specified by:

getRoundingAmount in interface GeoCache<T extends Cacheable>

Returns:

the rounding amount

add

public void add(GeoLocation loc,
 T data)

Adds a geographically located object to the cache.

Specified by:

add in interface GeoCache<T extends Cacheable>

Parameters:

loc - the GeoLocation

data - the data to cache

addNull

public void addNull(GeoLocation loc)

Adds a null entry to the cache.

Specified by:

addNull in interface GeoCache<T extends Cacheable>

Parameters:

loc - the GeoLocation

contains

public boolean contains(GeoLocation loc)

Returns whether the cache contains an entry for a particular location.

Specified by:

contains in interface GeoCache<T extends Cacheable>

Parameters:

loc - the GeoLocation

Returns:

TRUE if the cache contains an entry, otherwise FALSE

get

public T get(GeoLocation loc)

Retrieves an object from the cache.

Specified by:

get in interface GeoCache<T extends Cacheable>

Parameters:

loc - the GeoLocation

Returns:

the Object, or null if not found

remove

public void remove(GeoLocation loc)

Removes a location entry from the cache.

Specified by:

remove in interface GeoCache<T extends Cacheable>

Parameters:

loc - the GeoLocation