com.orientechnologies.orient.core.cache

Class OCommandCacheSoftRefs

java.lang.Object

com.orientechnologies.orient.core.cache.OCommandCacheSoftRefs

All Implemented Interfaces:

OCommandCache

public class OCommandCacheSoftRefs
extends Object
implements OCommandCache

Command cache implementation that uses Soft references to avoid overloading Java Heap.

Author:

Luca Garulli (l.garulli--(at)--orientdb.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OCommandCacheSoftRefs.OCachedResult

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.cache.OCommandCache

OCommandCache.STRATEGY

Constructor Summary

Constructors

Constructor and Description
OCommandCacheSoftRefs(OStorage storage)

Method Summary

Modifier and Type	Method and Description
void	changeConfig(ODocument cfg)
OCommandCacheSoftRefs	clear() Remove all results from the cache.
static boolean	clearFiles(OAbstractPaginatedStorage storage)
protected void	configure()
protected boolean	deleteFileIfExists()
OCommandCacheSoftRefs	disable() Disables cache.
OCommandCacheSoftRefs	enable() Enables cache.
Set<Map.Entry<String,OCommandCacheSoftRefs.OCachedResult>>	entrySet()
Object	get(OSecurityUser iUser, String queryText, int iLimit) Looks up for query result in cache.
OCommandCache.STRATEGY	getEvictStrategy()
protected String	getKey(OSecurityUser iUser, String queryText, int iLimit)
int	getMaxResultsetSize()
int	getMinExecutionTime()
void	invalidateResultsOfCluster(String iCluster) Invalidates results of given cluster.
boolean	isEnabled() Tells whether cache is enabled.
void	put(OSecurityUser iUser, String queryText, Object iResult, int iLimit, Set<String> iInvolvedClusters, long iExecutionTime) Pushes record to cache.
void	remove(OSecurityUser iUser, String queryText, int iLimit) Removes result of query.
OCommandCacheSoftRefs	setEvictStrategy(OCommandCache.STRATEGY evictStrategy)
OCommandCacheSoftRefs	setMaxResultsetSize(int maxResultsetSize)
OCommandCacheSoftRefs	setMinExecutionTime(int minExecutionTime)
void	shutdown() All operations running at cache destruction stage.
int	size() Total number of stored queries.
void	startup() All operations running at cache initialization stage.

Methods inherited from class java.lang.Object

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

Constructor Detail

OCommandCacheSoftRefs

public OCommandCacheSoftRefs(OStorage storage)

Method Detail

changeConfig

public void changeConfig(ODocument cfg)

configure

protected void configure()

startup

public void startup()

Description copied from interface: OCommandCache

All operations running at cache initialization stage.

Specified by:

startup in interface OCommandCache

shutdown

public void shutdown()

Description copied from interface: OCommandCache

All operations running at cache destruction stage.

Specified by:

shutdown in interface OCommandCache

deleteFileIfExists

protected boolean deleteFileIfExists()

isEnabled

public boolean isEnabled()

Description copied from interface: OCommandCache

Tells whether cache is enabled.

Specified by:

isEnabled in interface OCommandCache

Returns:

true if cache enabled at call time, otherwise - false

enable

public OCommandCacheSoftRefs enable()

Description copied from interface: OCommandCache

Enables cache.

Specified by:

enable in interface OCommandCache

disable

public OCommandCacheSoftRefs disable()

Description copied from interface: OCommandCache

Disables cache. None of query methods will cause effect on cache in disabled state. Only cache info methods available at that state.

Specified by:

disable in interface OCommandCache

get

public Object get(OSecurityUser iUser,
                  String queryText,
                  int iLimit)

Description copied from interface: OCommandCache

Looks up for query result in cache.

Specified by:

get in interface OCommandCache

put

public void put(OSecurityUser iUser,
                String queryText,
                Object iResult,
                int iLimit,
                Set<String> iInvolvedClusters,
                long iExecutionTime)

Description copied from interface: OCommandCache

Pushes record to cache. Identifier of record used as access key

Specified by:

put in interface OCommandCache

remove

public void remove(OSecurityUser iUser,
                   String queryText,
                   int iLimit)

Description copied from interface: OCommandCache

Removes result of query.

Specified by:

remove in interface OCommandCache

clear

public OCommandCacheSoftRefs clear()

Description copied from interface: OCommandCache

Remove all results from the cache.

Specified by:

clear in interface OCommandCache

size

public int size()

Description copied from interface: OCommandCache

Total number of stored queries.

Specified by:

size in interface OCommandCache

Returns:

non-negative number

invalidateResultsOfCluster

public void invalidateResultsOfCluster(String iCluster)

Description copied from interface: OCommandCache

Invalidates results of given cluster.

Specified by:

invalidateResultsOfCluster in interface OCommandCache

Parameters:

iCluster - Cluster name

getMinExecutionTime

public int getMinExecutionTime()

setMinExecutionTime

public OCommandCacheSoftRefs setMinExecutionTime(int minExecutionTime)

getMaxResultsetSize

public int getMaxResultsetSize()

Specified by:

getMaxResultsetSize in interface OCommandCache

setMaxResultsetSize

public OCommandCacheSoftRefs setMaxResultsetSize(int maxResultsetSize)

getEvictStrategy

public OCommandCache.STRATEGY getEvictStrategy()

Specified by:

getEvictStrategy in interface OCommandCache

setEvictStrategy

public OCommandCacheSoftRefs setEvictStrategy(OCommandCache.STRATEGY evictStrategy)

getKey

protected String getKey(OSecurityUser iUser,
                        String queryText,
                        int iLimit)

entrySet

public Set<Map.Entry<String,OCommandCacheSoftRefs.OCachedResult>> entrySet()

clearFiles

public static boolean clearFiles(OAbstractPaginatedStorage storage)