com.epimorphics.lda.cache

Interface Cache

All Known Implementing Classes:

LimitedCacheBase, PermaCache

public interface Cache

The Cache interface names the methods used by the Query constructor/issuer to fetch and store results that may be requested again. The implementation of the cache is not prescribed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Cache.Clock A Clock-like object that says what the current time in milliseconds is pretending to be.
static interface	Cache.Controller
static class	Cache.Registry The registry records named cache policies.

Method Summary

Methods

Modifier and Type	Method and Description
void	cacheDescription(List<com.hp.hpl.jena.rdf.model.Resource> results, String view, APIResultSet rs, long expiresAt) Make an entry in the caches that associates the result set rs with the given list of resources and view.
void	cacheSelection(String selectQuery, List<com.hp.hpl.jena.rdf.model.Resource> results, long expiresAt) Make an entry in the cache that binds the given list of results to the given select query string.
void	clear() Clear this cache.
LimitedCacheBase.TimedThing<ResponseResult>	fetch(URI requestURI)
List<com.hp.hpl.jena.rdf.model.Resource>	getCachedResources(String select) Answer the list of resources associated with this select query if any is available (entered and not discarded).
LimitedCacheBase.TimedThing<APIResultSet>	getCachedResultSet(List<com.hp.hpl.jena.rdf.model.Resource> results, String view) Answer the API result set remembered for the given list of results and view, or null if there isn't one.
int	getCount(String countQueryString) Get the total number of items that this query will return.
int	numEntries() Answer how many entries are in this cache.
void	putCount(String countQueryString, int count, long expiresAt) Put the total number of items that this query returns.
void	resetCounts() Reset to suitable zeroes the counts of this cache.
void	show(StringBuilder sb) Append an HTML description of this cache to sb.
void	store(URI requestURI, ResponseResult result, long expiresAt)
String	summary() Answer a summary description of this cache.

Method Detail

fetch

LimitedCacheBase.TimedThing<ResponseResult> fetch(URI requestURI)

store

void store(URI requestURI,
         ResponseResult result,
         long expiresAt)

cacheSelection

void cacheSelection(String selectQuery,
                  List<com.hp.hpl.jena.rdf.model.Resource> results,
                  long expiresAt)

Make an entry in the cache that binds the given list of results to the given select query string.

getCachedResources

List<com.hp.hpl.jena.rdf.model.Resource> getCachedResources(String select)

Answer the list of resources associated with this select query if any is available (entered and not discarded).

cacheDescription

void cacheDescription(List<com.hp.hpl.jena.rdf.model.Resource> results,
                    String view,
                    APIResultSet rs,
                    long expiresAt)

Make an entry in the caches that associates the result set rs with the given list of resources and view.

getCachedResultSet

LimitedCacheBase.TimedThing<APIResultSet> getCachedResultSet(List<com.hp.hpl.jena.rdf.model.Resource> results,
                                                           String view)

Answer the API result set remembered for the given list of results and view, or null if there isn't one.

clear

void clear()

Clear this cache.

resetCounts

void resetCounts()

Reset to suitable zeroes the counts of this cache.

show

void show(StringBuilder sb)

Append an HTML description of this cache to sb.

numEntries

int numEntries()

Answer how many entries are in this cache.

summary

String summary()

Answer a summary description of this cache. In particular, include a unique ID.

getCount

int getCount(String countQueryString)

Get the total number of items that this query will return.

putCount

void putCount(String countQueryString,
            int count,
            long expiresAt)

Put the total number of items that this query returns.