org.ceryle.xnode
Class XNodeCache

java.lang.Object
  java.util.Dictionary<K,V>
      java.util.Hashtable
          org.ceryle.xnode.XNodeCache

All Implemented Interfaces:

Serializable, Cloneable, Map

public class XNodeCache
extends Hashtable

Extends Hashtable as a cache for XNode objects.

To Do

Provide a cache size limit using total storage size and delete cache objects past that threshold. Currently this is done on count only.

Also, generalize this as org.ceryle.util.Cache, then subclass for XNodeIDs and XNodes.

Since:

XNode 1.2

Version:

$Id: XNodeCache.java,v 3.4 2007-06-15 12:10:31 altheim Exp $

Author:

Murray Altheim

See Also:

Serialized Form

Field Summary

static int	DEFAULT_SIZE The value of the default cache size.
static int	hysteresis The value of size-trimming hysteresis (the amount over the limit permitted prior to trimming, used to reduce the cost of trimming).

Constructor Summary

XNodeCache()
Constructor for an XNodeCache using the default cache size (of 50) and automatically checking the limit.

XNodeCache(int limit, boolean autocheck)
Constructor for an XNodeCache with a cache size limit and the boolean controlling whether the limit check is automatic or manual.

Method Summary

protected void	addToCache(XNodeID xid, XNode xnode) Adds the XNode xnode to the cache using the XNodeID xid as the key.
XNode	checkCacheFor(XNodeID xid) Checks the cache for an XNode corresponding to the XNodeID xid, returning null if it is not in the cache, or if caching is inactive.
void	checkLimit() Checks the current cache size against the limit and removes objects as necessary to reach the limit.
void	clear() Clears the document cache.
Object	get(Object key) Throws an exception.
Iterator	getAll() Returns an Iterator over the XNodes in the cache.
Object	put(Object key, Object value) Throws an exception.
void	putAll(Map map) Throws an exception.
Object	remove(Object key) Throws an exception.
boolean	removeFromCache(XNode xnode) Removes the XNode xnode from the document cache, returning true if it was removed.
boolean	removeFromCache(XNodeID xid) Removes the document specified by the XNodeID xid from the cache, returning true if it was removed.
Collection	values() Throws an exception.

Methods inherited from class java.util.Hashtable

clone, contains, containsKey, containsValue, elements, entrySet, equals, hashCode, isEmpty, keys, keySet, rehash, size, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SIZE

public static final int DEFAULT_SIZE

The value of the default cache size. Value is 50.

See Also:

Constant Field Values

hysteresis

public static int hysteresis

The value of size-trimming hysteresis (the amount over the limit permitted prior to trimming, used to reduce the cost of trimming). Default value is 10.

Constructor Detail

XNodeCache

public XNodeCache()

Constructor for an XNodeCache using the default cache size (of 50) and automatically checking the limit.

XNodeCache

public XNodeCache(int limit,
                  boolean autocheck)

Constructor for an XNodeCache with a cache size limit and the boolean controlling whether the limit check is automatic or manual. The minimum acceptable value for limit is 10.

Method Detail

addToCache

protected void addToCache(XNodeID xid,
                          XNode xnode)

Adds the XNode xnode to the cache using the XNodeID xid as the key. Note: If the key is already in use, this replaces the existing cache entry with the new XNode. If caching is inactive or either parameter is null this method does nothing (rather than throw an exception).

checkCacheFor

public XNode checkCacheFor(XNodeID xid)

Checks the cache for an XNode corresponding to the XNodeID xid, returning null if it is not in the cache, or if caching is inactive.

removeFromCache

public boolean removeFromCache(XNodeID xid)

Removes the document specified by the XNodeID xid from the cache, returning true if it was removed.

removeFromCache

public boolean removeFromCache(XNode xnode)

Removes the XNode xnode from the document cache, returning true if it was removed. This is somewhat expensive as we need to iterate through the entire Map.Entry set to locate the key so it can be removed from the keyset and queue.

getAll

public Iterator getAll()

Returns an Iterator over the XNodes in the cache.

clear

public void clear()

Clears the document cache.

Specified by:

clear in interface Map

Overrides:

clear in class Hashtable

checkLimit

public void checkLimit()

Checks the current cache size against the limit and removes objects as necessary to reach the limit. To provide some hysteresis, the size is permitted to exceed the limit by the value of hysteresis prior to trimming.

values

public final Collection values()

Throws an exception. Use getAll() instead.

Specified by:

values in interface Map

Overrides:

values in class Hashtable

remove

public final Object remove(Object key)

Throws an exception. Use removeFromCache(XNodeID) instead.

Specified by:

remove in interface Map

Overrides:

remove in class Hashtable

get

public final Object get(Object key)

Throws an exception. Use checkCacheFor(XNodeID) instead.

Specified by:

get in interface Map

Overrides:

get in class Hashtable

put

public final Object put(Object key,
                        Object value)

Throws an exception. Use addToCache(XNodeID,XNode) instead.

Specified by:

put in interface Map

Overrides:

put in class Hashtable

putAll

public final void putAll(Map map)

Throws an exception. Use addToCache(XNodeID,XNode) instead.

Specified by:

putAll in interface Map

Overrides:

putAll in class Hashtable