com.orientechnologies.orient.core.cache

Interface OCommandCache

All Known Implementing Classes:

OCommandCacheSoftRefs

public interface OCommandCache

Generic query cache interface.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OCommandCache.STRATEGY

Method Summary

Modifier and Type	Method and Description
OCommandCache	clear() Remove all results from the cache.
OCommandCache	disable() Disables cache.
OCommandCache	enable() Enables cache.
Object	get(OSecurityUser iUser, String queryText, int iLimit) Looks up for query result in cache.
OCommandCache.STRATEGY	getEvictStrategy()
int	getMaxResultsetSize()
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.
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.

Method Detail

startup

void startup()

All operations running at cache initialization stage.

shutdown

void shutdown()

All operations running at cache destruction stage.

isEnabled

boolean isEnabled()

Tells whether cache is enabled.

Returns:

true if cache enabled at call time, otherwise - false

enable

OCommandCache enable()

Enables cache.

disable

OCommandCache disable()

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

get

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

Looks up for query result in cache.

put

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

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

remove

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

Removes result of query.

clear

OCommandCache clear()

Remove all results from the cache.

size

int size()

Total number of stored queries.

Returns:

non-negative number

invalidateResultsOfCluster

void invalidateResultsOfCluster(String iCluster)

Invalidates results of given cluster.

Parameters:

iCluster - Cluster name

getMaxResultsetSize

int getMaxResultsetSize()

getEvictStrategy

OCommandCache.STRATEGY getEvictStrategy()