com.metamatrix.platform.service.api
Interface CacheAdmin

All Known Subinterfaces:

QueryServiceInterface

All Known Implementing Classes:

ConnectorService, QueryService

public interface CacheAdmin

Interface for an object that allows the administration of caches.

Field Summary

static java.lang.String	CODE_TABLE_CACHE
static java.lang.String	CONNECTOR_RESULT_SET_CACHE
static java.lang.String	PREPARED_PLAN_CACHE
static java.lang.String	QUERY_SERVICE_RESULT_SET_CACHE

Method Summary

void	clearCache(java.lang.String name, java.util.Properties props) Clear the named cached using properties to set options if necessary
java.util.Map	getCaches() Get names of all caches in this object

Field Detail

CODE_TABLE_CACHE

static final java.lang.String CODE_TABLE_CACHE

See Also:

Constant Field Values

PREPARED_PLAN_CACHE

static final java.lang.String PREPARED_PLAN_CACHE

See Also:

Constant Field Values

QUERY_SERVICE_RESULT_SET_CACHE

static final java.lang.String QUERY_SERVICE_RESULT_SET_CACHE

See Also:

Constant Field Values

CONNECTOR_RESULT_SET_CACHE

static final java.lang.String CONNECTOR_RESULT_SET_CACHE

See Also:

Constant Field Values

Method Detail

getCaches

java.util.Map getCaches()
                        throws MetaMatrixComponentException

Get names of all caches in this object

Returns:

Map where each key is the name of a cache and each value is the type, as defined by constants in this interface.

Throws:

MetaMatrixComponentException - If an error occurs

clearCache

void clearCache(java.lang.String name,
                java.util.Properties props)
                throws MetaMatrixComponentException

Clear the named cached using properties to set options if necessary

Parameters:

name - Name of the cache to clear

props - Optional additional properties which may vary by cache type

Throws:

MetaMatrixComponentException - If an error occurs