net.ossindex.common.cache

Class MapDbCache

java.lang.Object

net.ossindex.common.cache.MapDbCache

All Implemented Interfaces:

IOssIndexCache

public class MapDbCache
extends Object
implements IOssIndexCache

An implementation of IOssIndexCache that uses MapDb as a back end.

Author:

Ken Duck

Constructor Summary

Constructors

Constructor and Description
MapDbCache(File root) Create a cache at the specified location

Method Summary

Modifier and Type	Method and Description
void	cache(String requestString, String json) Cache the specified query
void	clear() Clear the cache
void	close() Ensure that the cache persists if required
void	commit() Commit any recent changes into the cache
String	get(String requestString) Get cached results, if they are available
String	get(String requestString, long delay) Return the cached value if the elapsed time is not passed.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapDbCache

public MapDbCache(File root)

Create a cache at the specified location

Parameters:

root - Root directory for cache storage

Method Detail

cache

public void cache(String requestString,
                  String json)

Description copied from interface: IOssIndexCache

Cache the specified query

Specified by:

cache in interface IOssIndexCache

Parameters:

requestString - Request that is being cached

json - Response to request

get

public String get(String requestString)

Description copied from interface: IOssIndexCache

Get cached results, if they are available

Specified by:

get in interface IOssIndexCache

Parameters:

requestString - Request that was cached

Returns:

Response to request

get

public String get(String requestString,
                  long delay)

Description copied from interface: IOssIndexCache

Return the cached value if the elapsed time is not passed. A delay of < 0 indicates that we should just use the cached value

Specified by:

get in interface IOssIndexCache

Parameters:

requestString - Request that is being cached

delay - Elapsed time before we ignore the cached value

Returns:

Response to request

commit

public void commit()

Description copied from interface: IOssIndexCache

Commit any recent changes into the cache

Specified by:

commit in interface IOssIndexCache

close

public void close()

Description copied from interface: IOssIndexCache

Ensure that the cache persists if required

Specified by:

close in interface IOssIndexCache

clear

public void clear()

Description copied from interface: IOssIndexCache

Clear the cache

Specified by:

clear in interface IOssIndexCache