ResourceCache

extends FileCacheBase

java.lang.Object
↳	com.microstrategy.utils.cache.CacheBase
	↳	com.microstrategy.utils.cache.CustomizationsAwareCache
		↳	com.microstrategy.utils.cache.FileCacheBase
			↳	com.microstrategy.web.app.utils.cache.ResourceCache

Class Overview

This is a cache for Resource objects. A Resource is basically a wrapper of a file from which you can retrieve the file contents as a string or as a DOM Document.

Summary

[Expand]

Inherited Constants

From class com.microstrategy.utils.cache.CacheBase

[Expand]

Inherited Fields

From class com.microstrategy.utils.cache.CacheBase

Protected Methods
Object	doLoad(CacheHint hint) This abstract method is called by the load method to perform the actual loading.
Object	getKey(CacheHint hint) Returns the key of the cache element based on the hint.

[Expand]

Inherited Methods

From class com.microstrategy.utils.cache.FileCacheBase

From class com.microstrategy.utils.cache.CustomizationsAwareCache

From class com.microstrategy.utils.cache.CacheBase

boolean	canUpdate(CacheHint hint) Overridable.
synchronized void	clear() Clears the cache - all entries are removed.
void	close() Un-register cache from the cache registry.
synchronized void	configure(Properties prop)
boolean	contains(CacheHint hint)
void	delete(CacheHint hint) Removes object from the cache and persistent storage
Object	get(CacheHint hint) Finds and returns cached object based on the hint.
abstract Object	getKey(CacheHint hint) Overridable.
String	getName() Returns cache name.
synchronized int	getRefreshTime() Returns cache refresh time in seconds.
synchronized int	getStatisticTime() Returns the statistic frequency in seconds.
synchronized int	getTimeout() Returns cache timeout in seconds.
abstract Object	load(CacheHint hint) Overridable.
void	logStatistic() Writes cache statistic message to the log.
void	onHintClose(CacheHint hint) This method is supposed to be called by the hint object when it is closed.
void	onTimer() This method is periodically called by the cache registry.
void	put(CacheHint hint, Object ob) Puts the object in the cache.
Object	reLoad(CacheHint hint, Object ob) Overridable.
Object	refresh(CacheHint hint) Re-loads object from the persistent storage
void	remove(CacheHint hint) Removes an object from the cache.
void	save(CacheHint hint, Object ob) Puts the object in the cache and stores it in the memory.
synchronized void	setRefreshTime(int value) Sets cache refresh time in seconds.
synchronized void	setStatisticTime(int value) Sets the statistic frequency in seconds.
synchronized void	setTimeout(int value) Sets cache timeout in seconds.
synchronized int	size() Returns cache size.
void	store(CacheHint hint, Object ob) Overridable.
void	unLoad(CacheHint hint) Overridable.

From class java.lang.Object

From interface com.microstrategy.utils.cache.Cache

abstract void	clear() Clears the cache - all entries are removed.
abstract void	close() Un-register cache from the cache registry.
abstract boolean	contains(CacheHint hint)
abstract void	delete(CacheHint hint) Removes object from the cache and persistent storage
abstract Object	get(CacheHint hint) Finds and returns cached object based on the hint.
abstract String	getName() Returns cache name.
abstract void	onHintClose(CacheHint hint) This method is supposed to be called by the hint object when it is closed.
abstract void	put(CacheHint hint, Object ob) Puts the object in the cache.
abstract Object	refresh(CacheHint hint) Re-loads object from the persistent storage
abstract void	remove(CacheHint hint) Removes an object from the cache.
abstract void	save(CacheHint hint, Object ob) Puts the object in the cache and stores it in the memory.

From interface java.util.Observer

Protected Methods

protected Object doLoad (CacheHint hint)

This abstract method is called by the load method to perform the actual loading. In this method, subclasses needs to load the file and parse it, and return the object they actually want cached.

Throws

CacheException

protected Object getKey (CacheHint hint)

Returns the key of the cache element based on the hint. In this scenario, the hint itself is the key.

Parameters

hint	the hint object.

Returns

the key

Classes

ResourceCache

Class Overview

Summary

Protected Methods

protected Object doLoad (CacheHint hint)

Throws

protected Object getKey (CacheHint hint)

Parameters

Returns