com.tomtom.speedtools.tilemap

Class CachedTileMap<T>

java.lang.Object

com.tomtom.speedtools.tilemap.TileMap<T>

com.tomtom.speedtools.tilemap.CachedTileMap<T>

public final class CachedTileMap<T>
extends TileMap<T>

This class represents a cacheable map. It uses Google Guava for its (basic) caching. Use this class to avoid a huge load on the LBS system (and loads of network traffic) if you will be retrieving the same tiles over and over again. The cache is stored in the heap, so you may wish to set the VM '-Xmx700m' parameter (700m is an example; 700 megs of RAM).

Nested Class Summary

Nested classes/interfaces inherited from class com.tomtom.speedtools.tilemap.TileMap

TileMap.ViewportTileProcessor<T>

Constructor Summary

Constructors

Constructor and Description
CachedTileMap(long maxCachedTiles, com.google.common.cache.CacheLoader<TileKey,T> imgLoad) Constructor.

Method Summary

Modifier and Type	Method and Description
void	cacheTile(TileKey key) Buffer a map tile, given a map tile key.
T	getTile(TileKey key) Get a map tile, given a map tile key.
void	invalidate(TileKey key)
void	invalidateAll()
void	invalidateAll(Iterable<TileKey> keys)
boolean	isCacheEnabled() Returns if the map supports caching.
com.google.common.cache.CacheStats	stats() Return cache statistics for map tiles.

Methods inherited from class com.tomtom.speedtools.tilemap.TileMap

collectViewportTiles, convertLatLonToTileOffset, convertLatLonToViewportXY, convertTileOffsetToLatLon, convertViewportXYToLatLon, findZoomLevelAndMapCenter, isPreCacheEnabled, moveLatLonByViewportXY, processViewportTiles, setPreCachingHint

Methods inherited from class java.lang.Object

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

Constructor Detail

CachedTileMap

public CachedTileMap(long maxCachedTiles,
                     @Nonnull
                     com.google.common.cache.CacheLoader<TileKey,T> imgLoad)

Constructor.

Parameters:

imgLoad - Function for loading image tiles, or default if -1.

maxCachedTiles - Maximum number of tiles to be cached.

Method Detail

getTile

@Nullable
public T getTile(@Nonnull
                           TileKey key)

Get a map tile, given a map tile key.

Specified by:

getTile in class TileMap<T>

Parameters:

key - Map tile key.

Returns:

Map tile.

isCacheEnabled

public boolean isCacheEnabled()

Returns if the map supports caching.

Overrides:

isCacheEnabled in class TileMap<T>

Returns:

True if the map supports caching (does not say anything about the cache size).

cacheTile

public void cacheTile(@Nonnull
                      TileKey key)

Buffer a map tile, given a map tile key.

Overrides:

cacheTile in class TileMap<T>

Parameters:

key - Map tile key.

invalidate

public void invalidate(@Nonnull
                       TileKey key)

invalidateAll

public void invalidateAll(@Nonnull
                          Iterable<TileKey> keys)

invalidateAll

public void invalidateAll()

stats

@Nonnull
public com.google.common.cache.CacheStats stats()

Return cache statistics for map tiles.

Returns:

Cache statistics.