Package org.geotools.gce.imagemosaic

Class GuavaGranuleImageCache

Object

GuavaGranuleImageCache

All Implemented Interfaces:

GranuleImageCache

public final class GuavaGranuleImageCache
extends Object
implements GranuleImageCache

Default GranuleImageCache: a single-JVM, heap-backed pool over a Guava Cache. Thread-safe.

Nested Class Summary

Nested classes/interfaces inherited from interface GranuleImageCache

GranuleImageCache.MissingRasterException

Constructor Summary

Constructors

Constructor	Description
GuavaGranuleImageCache(long maximumSizeBytes, long defaultThresholdBytes)

Method Summary

Modifier and Type	Method	Description
BufferedImage	get(ImageCacheKey key)	Returns the cached image for the key, or null on a miss; never loads.
long	getDefaultThresholdBytes()	Largest decoded granule eligible for caching, in bytes (a read parameter can override it).
long	getMaximumSizeBytes()	Maximum size of the pool, in bytes.
BufferedImage	getOrLoad(ImageCacheKey key, Callable<BufferedImage> loader)	Returns the cached image for the key, loading it once atomically if absent.
void	invalidateAll()	Drops all cached granule images.
void	invalidateGranule(URL granuleUrl)	Drops every cached read of the given granule, whatever the mosaic, image index or band selection.
void	invalidateMosaic(String mosaicId)	Drops every entry owned by the given mosaic, called when its reader is disposed to free heap at once.
boolean	isEnabled()	Whether caching is on: a non-positive max size means the pool is present but denies caching.
void	reconfigure(long maximumSizeBytes, long defaultThresholdBytes)	Applies new sizing while keeping this instance's identity, so readers holding it through Hints.GRANULE_IMAGE_CACHE see the change with no rebuild on their side.
long	size()	Number of granule images currently held.

Methods inherited from class Object

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

Constructor Details

GuavaGranuleImageCache

public GuavaGranuleImageCache(long maximumSizeBytes,
 long defaultThresholdBytes)

Method Details

reconfigure

public void reconfigure(long maximumSizeBytes,
 long defaultThresholdBytes)

Description copied from interface: GranuleImageCache

Applies new sizing while keeping this instance's identity, so readers holding it through Hints.GRANULE_IMAGE_CACHE see the change with no rebuild on their side. A change in total size may drop the current entries and free their heap at once; the threshold is applied in place.

Specified by:

reconfigure in interface GranuleImageCache

isEnabled

public boolean isEnabled()

Description copied from interface: GranuleImageCache

Whether caching is on: a non-positive max size means the pool is present but denies caching.

Specified by:

isEnabled in interface GranuleImageCache

size

public long size()

Description copied from interface: GranuleImageCache

Number of granule images currently held.

Specified by:

size in interface GranuleImageCache

invalidateAll

public void invalidateAll()

Description copied from interface: GranuleImageCache

Drops all cached granule images.

Specified by:

invalidateAll in interface GranuleImageCache

invalidateGranule

public void invalidateGranule(URL granuleUrl)

Description copied from interface: GranuleImageCache

Drops every cached read of the given granule, whatever the mosaic, image index or band selection.

Specified by:

invalidateGranule in interface GranuleImageCache

invalidateMosaic

public void invalidateMosaic(String mosaicId)

Description copied from interface: GranuleImageCache

Drops every entry owned by the given mosaic, called when its reader is disposed to free heap at once.

Specified by:

invalidateMosaic in interface GranuleImageCache

getMaximumSizeBytes

public long getMaximumSizeBytes()

Description copied from interface: GranuleImageCache

Maximum size of the pool, in bytes.

Specified by:

getMaximumSizeBytes in interface GranuleImageCache

getDefaultThresholdBytes

public long getDefaultThresholdBytes()

Description copied from interface: GranuleImageCache

Largest decoded granule eligible for caching, in bytes (a read parameter can override it).

Specified by:

getDefaultThresholdBytes in interface GranuleImageCache

get

public BufferedImage get(ImageCacheKey key)

Description copied from interface: GranuleImageCache

Returns the cached image for the key, or null on a miss; never loads.

Specified by:

get in interface GranuleImageCache

getOrLoad

public BufferedImage getOrLoad(ImageCacheKey key,
 Callable<BufferedImage> loader)
                        throws Exception

Description copied from interface: GranuleImageCache

Returns the cached image for the key, loading it once atomically if absent. Returns null if the loader signals nothing was read by throwing GranuleImageCache.MissingRasterException; any other loader failure propagates.

Specified by:

getOrLoad in interface GranuleImageCache

Throws:

Exception