org.pfsw.tools.cda.base.model.workset

Class StructuredCache

java.lang.Object

org.pfsw.tools.cda.base.model.workset.StructuredCache

public class StructuredCache
extends java.lang.Object

This cache can be used to store various objects in different categories. When the cache is cleared, all cached objects that implement the IReleasable interface are released.

Constructor Summary

Constructors

Constructor and Description
StructuredCache() Initialize the new instance with default values.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the whole cache (all sections).
void	clearSection(java.lang.String section) Removes all cached objects from the specified section.
protected java.util.Map<java.lang.Object,java.lang.Object>	createSlot(java.lang.String slotName)
java.lang.Object	find(java.lang.String section, java.lang.Object key) Tries to find a cached object that was stored under the given key in the specified cache section.
protected java.util.Map<java.lang.Object,java.lang.Object>	findSlot(java.lang.String slotName)
protected java.util.Map<java.lang.String,java.util.Map<java.lang.Object,java.lang.Object>>	getCache()
protected java.util.Map<java.lang.Object,java.lang.Object>	getSlot(java.lang.String slotName)
protected java.util.Map<java.lang.Object,java.lang.Object>	newSlot()
java.lang.Object	remove(java.lang.String section, java.lang.Object key) Tries to remove a cached object that was stored under the given key in the specified cache section.
protected void	setCache(java.util.Map<java.lang.String,java.util.Map<java.lang.Object,java.lang.Object>> newValue)
protected void	setSlot(java.lang.String slotName, java.util.Map<java.lang.Object,java.lang.Object> slot)
void	store(java.lang.String section, java.lang.Object key, java.lang.Object value) Stores in the specified section of the cache the given key/value pair

Methods inherited from class java.lang.Object

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

Constructor Detail

StructuredCache

public StructuredCache()

Initialize the new instance with default values.

Method Detail

getCache

protected java.util.Map<java.lang.String,java.util.Map<java.lang.Object,java.lang.Object>> getCache()

setCache

protected void setCache(java.util.Map<java.lang.String,java.util.Map<java.lang.Object,java.lang.Object>> newValue)

store

public void store(java.lang.String section,
                  java.lang.Object key,
                  java.lang.Object value)

Stores in the specified section of the cache the given key/value pair

Parameters:

section - The name of the section

key - The key under which the value can be found

value - The value to cache

find

public java.lang.Object find(java.lang.String section,
                             java.lang.Object key)

Tries to find a cached object that was stored under the given key in the specified cache section.

Parameters:

section - The name of the section

key - The key under which the value can be found

Returns:

The desired object or null if not found

remove

public java.lang.Object remove(java.lang.String section,
                               java.lang.Object key)

Tries to remove a cached object that was stored under the given key in the specified cache section.

Parameters:

section - The name of the section

key - The key under which the value can be found

Returns:

The removed object or null if not found

clear

public void clear()

Clears the whole cache (all sections). All cached objects that are implementors of IReleasable will be released.

clearSection

public void clearSection(java.lang.String section)

Removes all cached objects from the specified section. Each cached object (value) that implements the IReleasable interface will be released.

Parameters:

section - The name of the cache section to clear

newSlot

protected java.util.Map<java.lang.Object,java.lang.Object> newSlot()

getSlot

protected java.util.Map<java.lang.Object,java.lang.Object> getSlot(java.lang.String slotName)

findSlot

protected java.util.Map<java.lang.Object,java.lang.Object> findSlot(java.lang.String slotName)

setSlot

protected void setSlot(java.lang.String slotName,
                       java.util.Map<java.lang.Object,java.lang.Object> slot)

createSlot

protected java.util.Map<java.lang.Object,java.lang.Object> createSlot(java.lang.String slotName)