ddf.catalog.cache.impl

Class CacheKey

java.lang.Object

ddf.catalog.cache.impl.CacheKey

public class CacheKey
extends Object

Class used to create keys for the ResourceCache class.

Constructor Summary

Constructors

Constructor and Description
CacheKey(Metacard metacard) Constructor used for keys generated from a Metacard only.
CacheKey(Metacard metacard, ResourceRequest resourceRequest) Constructor used for keys generated from a Metacard and ResourceRequest.

Method Summary

Modifier and Type	Method and Description
String	generateKey() Generates a cache key based on the metacard (and optionally resource request) object provided to the constructor.

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheKey

public CacheKey(Metacard metacard,
                ResourceRequest resourceRequest)

Constructor used for keys generated from a Metacard and ResourceRequest.

Parameters:

metacard - metacard to use to generate the key

resourceRequest - resource request object to use to generate the key

CacheKey

public CacheKey(Metacard metacard)

Constructor used for keys generated from a Metacard only. Will create a key that maps to the metacard's default resource. To generate a key for other specific metacard resources, use CacheKey(Metacard, ResourceRequest).

Parameters:

metacard - metacard to use to generate the key

Method Detail

generateKey

public String generateKey()

Generates a cache key based on the metacard (and optionally resource request) object provided to the constructor.

Returns:

key key to use when doing ResourceCache lookups