org.apache.jcs.auxiliary.disk.hsql
Class HSQLCache

java.lang.Object
  org.apache.jcs.auxiliary.disk.AbstractDiskCache
      org.apache.jcs.auxiliary.disk.hsql.HSQLCache

All Implemented Interfaces:

AuxiliaryCache, ICache, ICacheType, java.io.Serializable

public class HSQLCache

extends AbstractDiskCache

HSQLDB Based Local Persistence. VERY EXPERIMENTAL, and only partially implemented Requires String keys and does not work with groups.

Version:

1.0

Author:

Aaron Smuts

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class org.apache.jcs.auxiliary.disk.AbstractDiskCache

Field Summary

(package private) HSQLCacheAttributes	cattr
(package private) java.sql.Connection	cConn
boolean	isAlive
private static org.apache.commons.logging.Log	log
private int	numInstances
(package private) java.sql.Statement	sStatement

Fields inherited from class org.apache.jcs.auxiliary.disk.AbstractDiskCache

alive, cacheEventQueue, cacheName, lock, locker, purgatory, purgHits

Fields inherited from interface org.apache.jcs.engine.behavior.ICacheType

CACHE_HUB, DISK_CACHE, LATERAL_CACHE, REMOTE_CACHE

Constructor Summary

HSQLCache(HSQLCacheAttributes cattr)
Constructor for the HSQLCache object

Method Summary

void	doDispose() Description of the Method
ICacheElement	doGet(java.io.Serializable key) Description of the Method
boolean	doRemove(java.io.Serializable key) Returns true if the removal was succesful; or false if there is nothing to remove.
void	doRemoveAll() Description of the Method
void	doUpdate(ICacheElement ce) Description of the Method
java.util.Set	getGroupKeys(java.lang.String groupName) Gets the set of keys of objects currently in the group
int	getSize() Returns the current cache size.
void	reset() Description of the Method
(package private) static byte[]	serialize(java.io.Serializable obj) Returns the serialized form of the given object in a byte array.
(package private) void	setupTABLE() SETUP TABLE FOR CACHE

Methods inherited from class org.apache.jcs.auxiliary.disk.AbstractDiskCache

dispose, get, getCacheName, getCacheType, getStatus, remove, removeAll, update

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.apache.commons.logging.Log log

numInstances

private int numInstances

isAlive

public boolean isAlive

cattr

HSQLCacheAttributes cattr

cConn

java.sql.Connection cConn

sStatement

java.sql.Statement sStatement

Constructor Detail

HSQLCache

public HSQLCache(HSQLCacheAttributes cattr)

Constructor for the HSQLCache object

Parameters:

cattr -

Method Detail

setupTABLE

void setupTABLE()

SETUP TABLE FOR CACHE

doUpdate

public void doUpdate(ICacheElement ce)

Description of the Method

Specified by:

doUpdate in class AbstractDiskCache

doGet

public ICacheElement doGet(java.io.Serializable key)

Description of the Method

Specified by:

doGet in class AbstractDiskCache

Parameters:

key - Key to locate value for.

Returns:

An object matching key, or null.

doRemove

public boolean doRemove(java.io.Serializable key)

Returns true if the removal was succesful; or false if there is nothing to remove. Current implementation always result in a disk orphan.

Specified by:

doRemove in class AbstractDiskCache

Parameters:

key - Key of object to remove.

doRemoveAll

public void doRemoveAll()

Description of the Method

Specified by:

doRemoveAll in class AbstractDiskCache

reset

public void reset()

Description of the Method

doDispose

public void doDispose()

Description of the Method

Specified by:

doDispose in class AbstractDiskCache

getSize

public int getSize()

Returns the current cache size.

Specified by:

getSize in interface AuxiliaryCache

Specified by:

getSize in class AbstractDiskCache

Returns:

The size value

See Also:

ICache#getSize

serialize

static byte[] serialize(java.io.Serializable obj)
                 throws java.io.IOException

Returns the serialized form of the given object in a byte array.

Throws:

java.io.IOException

getGroupKeys

public java.util.Set getGroupKeys(java.lang.String groupName)

Description copied from interface: AuxiliaryCache

Gets the set of keys of objects currently in the group

Specified by:

getGroupKeys in interface AuxiliaryCache

Specified by:

getGroupKeys in class AbstractDiskCache