oracle.toplink.essentials.internal.identitymaps

Class FullIdentityMap

java.lang.Object

oracle.toplink.essentials.internal.identitymaps.IdentityMap

oracle.toplink.essentials.internal.identitymaps.FullIdentityMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

CacheIdentityMap, WeakIdentityMap

public class FullIdentityMap
extends IdentityMap

Purpose: A FullIdentityMap holds all objects stored within it for the life of the application

Responsibilities:

• Guarantees identity
• Holds all cached objects indefinetly.

Since:

TOPLink/Java 1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Hashtable	cacheKeys Hashtable of CacheKeys stored using their key

Fields inherited from class oracle.toplink.essentials.internal.identitymaps.IdentityMap

maxSize, searchKey

Constructor Summary

Constructors

Constructor and Description
FullIdentityMap(int size)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() INTERNAL: Clones itself.
void	collectLocks(java.util.HashMap threadList) INTERNAL: Used to print all the Locks in every identity map in this session.
java.util.Enumeration	elements() Allow for the cache to be iterated on.
protected CacheKey	getCacheKey(CacheKey searchKey) Return the object indexed in the recevier at the cache key.
java.util.Hashtable	getCacheKeys()
int	getSize() Return the number of objects in the IdentityMap.
int	getSize(java.lang.Class myClass, boolean recurse) Return the number of actual objects of type myClass in the IdentityMap.
java.util.Enumeration	keys() Allow for the cache keys to be iterated on.
protected void	put(CacheKey cacheKey) Store the object in the cache with the cache key.
CacheKey	put(java.util.Vector primaryKey, java.lang.Object object, java.lang.Object writeLockValue, long readTime) Store the object in the cache at its primary key.
java.lang.Object	remove(CacheKey cacheKey) Removes the CacheKey from the Hashtable.
void	resetCacheKey(CacheKey key, java.lang.Object object, java.lang.Object writeLockValue)
void	resetCacheKey(CacheKey key, java.lang.Object object, java.lang.Object writeLockValue, long readTime)
protected void	setCacheKeys(java.util.Hashtable cacheKeys)

Methods inherited from class oracle.toplink.essentials.internal.identitymaps.IdentityMap

acquireDeferredLock, acquireLock, acquireLockNoWait, acquireReadLockOnCacheKey, acquireReadLockOnCacheKeyNoWait, containsKey, createCacheKey, createCacheKey, get, getCacheKey, getCacheKeyWithReadLock, getDefaultIdentityMapClass, getMaxSize, getSearchKey, getWrapper, getWriteLockValue, initialize, remove, setMaxSize, setSearchKey, setWrapper, setWriteLockValue, toString, updateCacheKey, updateMaxSize

Methods inherited from class java.lang.Object

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

Field Detail

cacheKeys

protected java.util.Hashtable cacheKeys

Hashtable of CacheKeys stored using their key

Constructor Detail

FullIdentityMap

public FullIdentityMap(int size)

Method Detail

clone

public java.lang.Object clone()

INTERNAL: Clones itself.

Overrides:

clone in class IdentityMap

collectLocks

public void collectLocks(java.util.HashMap threadList)

INTERNAL: Used to print all the Locks in every identity map in this session. The output of this method will go to log passed in as a parameter.

Specified by:

collectLocks in class IdentityMap

elements

public java.util.Enumeration elements()

Allow for the cache to be iterated on.

Specified by:

elements in class IdentityMap

getCacheKey

protected CacheKey getCacheKey(CacheKey searchKey)

Return the object indexed in the recevier at the cache key. If now object for the key exists, return null.

Specified by:

getCacheKey in class IdentityMap

Returns:

a CacheKey for the primary key or null

getCacheKeys

public java.util.Hashtable getCacheKeys()

getSize

public int getSize()

Return the number of objects in the IdentityMap.

Specified by:

getSize in class IdentityMap

getSize

public int getSize(java.lang.Class myClass,
                   boolean recurse)

Return the number of actual objects of type myClass in the IdentityMap. Recurse = true will include subclasses of myClass in the count.

Specified by:

getSize in class IdentityMap

keys

public java.util.Enumeration keys()

Allow for the cache keys to be iterated on.

Specified by:

keys in class IdentityMap

put

public CacheKey put(java.util.Vector primaryKey,
                    java.lang.Object object,
                    java.lang.Object writeLockValue,
                    long readTime)

Store the object in the cache at its primary key.

Specified by:

put in class IdentityMap

Parameters:

primaryKey - is the primary key for the object.

object - is the domain object to cache.

writeLockValue - is the current write lock value of object, if null the version is ignored.

readTime - the read time of the object to be stored in the cache

put

protected void put(CacheKey cacheKey)

Store the object in the cache with the cache key.

Specified by:

put in class IdentityMap

remove

public java.lang.Object remove(CacheKey cacheKey)

Removes the CacheKey from the Hashtable.

Specified by:

remove in class IdentityMap

Returns:

The object held within the CacheKey or null if no object cached for given primaryKey

resetCacheKey

public void resetCacheKey(CacheKey key,
                          java.lang.Object object,
                          java.lang.Object writeLockValue)

resetCacheKey

public void resetCacheKey(CacheKey key,
                          java.lang.Object object,
                          java.lang.Object writeLockValue,
                          long readTime)

setCacheKeys

protected void setCacheKeys(java.util.Hashtable cacheKeys)