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 org.deltava.util.cache.ExpiringCache

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

Field Summary

Fields inherited from class org.deltava.util.cache.ExpiringCache

_expiry, _lastCreationTime

Fields inherited from class org.deltava.util.cache.Cache

_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 org.deltava.util.cache.ExpiringCache

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

Methods inherited from class org.deltava.util.cache.Cache

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deltava.util.cache.GeoCache

createGeoKey

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