atg.rview
Class CacheInfoEntry

java.lang.Object
  atg.rview.CacheInfoEntry

public abstract class CacheInfoEntry
extends java.lang.Object

Contains information about the runtime state of one cache in the system.

Field Summary

static java.lang.String

CLASS_VERSION

Constructor Summary

CacheInfoEntry()

Method Summary

abstract int	getAccessCount() Returns the number of times the cache was accessed
abstract int	getBytesUsed() Returns the number of bytes currently held by cache entries.
abstract int	getCacheInvalidationCount() Returns the number of times the cache was entirely invalidated
abstract java.lang.String[]	getDependentTables() Returns the list of table names upon which this cache depends.
abstract int	getEntryCount() Returns the number of entries in the cache.
abstract int	getEntryInvalidationCount() Returns the number of times a cache entry was invalidated
abstract int	getGroupCount() Returns the number of entry groups in the cache, where each group comprises entries that have a common key prefix.
abstract int	getGroupEntryCount() Returns the total number of entries in all of the entry groups.
abstract int	getHitCount() Returns the number of accesses that were cache hits
abstract java.lang.String[]	getKeyProperties() Returns the list of property names that make up the keys for the cache entries.
abstract java.lang.Object[][]	getKeys() Returns the keys of all the entries in the cache.
abstract int	getMissCount() Returns the number of accesses that were cache misses
abstract java.lang.String	getName() Returns the name of the cache

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

CacheInfoEntry

public CacheInfoEntry()

Method Detail

getName

public abstract java.lang.String getName()

Returns the name of the cache

getEntryCount

public abstract int getEntryCount()

Returns the number of entries in the cache.

getGroupCount

public abstract int getGroupCount()

Returns the number of entry groups in the cache, where each group comprises entries that have a common key prefix.

getGroupEntryCount

public abstract int getGroupEntryCount()

Returns the total number of entries in all of the entry groups.

getBytesUsed

public abstract int getBytesUsed()

Returns the number of bytes currently held by cache entries.

getAccessCount

public abstract int getAccessCount()

Returns the number of times the cache was accessed

getHitCount

public abstract int getHitCount()

Returns the number of accesses that were cache hits

getMissCount

public abstract int getMissCount()

Returns the number of accesses that were cache misses

getCacheInvalidationCount

public abstract int getCacheInvalidationCount()

Returns the number of times the cache was entirely invalidated

getEntryInvalidationCount

public abstract int getEntryInvalidationCount()

Returns the number of times a cache entry was invalidated

getDependentTables

public abstract java.lang.String[] getDependentTables()

Returns the list of table names upon which this cache depends. If any of these tables change, then this cache may need to be invalidated.

getKeyProperties

public abstract java.lang.String[] getKeyProperties()

Returns the list of property names that make up the keys for the cache entries. For example, if the key property is "id", then each entry in the cache has a key based on the "id" property of the underlying object - i.e., if an object changes and its "id" property is available, then the corresponding entry in the cache can be invalidated (if the "id" property is not known, then the entire cache would have to be invalidated). Returns null if there are no key properties, meaning that any change to any of the dependent tables will require a complete invalidation of the cache.

getKeys

public abstract java.lang.Object[][] getKeys()

Returns the keys of all the entries in the cache. The keys are returned as a double-dimensioned array. Each entry gets its own element in the array. Each element is another object array that represents the entry's key. The key is the list of argument values passed to the subview or function. For selectOne or selectRange, there will be additional values representing the arguments to select(int index) and select(int index, int count). The returned list of keys may be direct pointers to the cache, so applications should not modify this list or any of its contained values.