OptimisticTreeCache (Hibernate API Documentation) - Hibernate 3.2.4 正式版 API 英文文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.hibernate.cache
Class OptimisticTreeCache

java.lang.Object
  org.hibernate.cache.OptimisticTreeCache

All Implemented Interfaces:: Cache, OptimisticCache

public class OptimisticTreeCache
extends Object
implements OptimisticCache

Represents a particular region within the given JBossCache TreeCache utilizing TreeCache's optimistic locking capabilities.

Author:: Steve Ebersole
See Also:: for more details

Nested Class Summary

static class OptimisticTreeCache.CircumventChecksDataVersion
          Used to signal to a DataVersionAdapter to simply not perform any checks.

static class OptimisticTreeCache.DataVersionAdapter


static class OptimisticTreeCache.NonLockingDataVersion
          Used in regions where no locking should ever occur.

Constructor Summary

OptimisticTreeCache(org.jboss.cache.TreeCache cache, String regionName)


Method Summary

void clear()
          Clear the cache

void destroy()
          Clean up

Object get(Object key)
          Get an item from the cache, nontransactionally

long getElementCountInMemory()
          The count of entries currently contained in the regions in-memory store.

long getElementCountOnDisk()
          The count of entries currently contained in the regions disk store.

String getRegionName()
          Get the name of the cache region

long getSizeInMemory()
          The number of bytes is this cache region currently consuming in memory.

int getTimeout()
          Get a reasonable "lock timeout"

void lock(Object key)
          If this is a clustered cache, lock the item

long nextTimestamp()
          Generate a timestamp

void put(Object key, Object value)
          Add an item to the cache, nontransactionally, with failfast semantics

Object read(Object key)
          Get an item from the cache

void remove(Object key)
          Remove an item from the cache

void setSource(OptimisticCacheSource source)
          Indicates the "source" of the cached data.

Map toMap()
          optional operation

String toString()


void unlock(Object key)
          If this is a clustered cache, unlock the item

void update(Object key, Object value)
          Add an item to the cache

void writeInsert(Object key, Object value, Object currentVersion)
          Called during CacheConcurrencyStrategy.insert(java.lang.Object, java.lang.Object, java.lang.Object) processing for transactional strategies.

void writeLoad(Object key, Object value, Object currentVersion)
          Called during CacheConcurrencyStrategy.put(java.lang.Object, java.lang.Object, long, java.lang.Object, java.util.Comparator, boolean) processing for transactional strategies.

void writeUpdate(Object key, Object value, Object currentVersion, Object previousVersion)
          Called during CacheConcurrencyStrategy.update(java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object) processing for transactional strategies.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptimisticTreeCache

public OptimisticTreeCache(org.jboss.cache.TreeCache cache,
                           String regionName)
                    throws CacheException

Method Detail

setSource

public void setSource(OptimisticCacheSource source)

Description copied from interface: OptimisticCache

Indicates the "source" of the cached data. Currently this will only ever represent an EntityPersister.

Made available to the cache so that it can access certain information about versioning strategy.

Specified by:: setSource in interface OptimisticCache

Parameters:: source - The source.

writeInsert

public void writeInsert(Object key,
                        Object value,
                        Object currentVersion)

Description copied from interface: OptimisticCache

Called during CacheConcurrencyStrategy.insert(java.lang.Object, java.lang.Object, java.lang.Object) processing for transactional strategies. Indicates we have just performed an insert into the DB and now need to cache that entity's data.

Specified by:: writeInsert in interface OptimisticCache

Parameters:: key - The cache key.; value - The data to be cached.; currentVersion - The entity's version; or null if not versioned.

writeUpdate

public void writeUpdate(Object key,
                        Object value,
                        Object currentVersion,
                        Object previousVersion)

Description copied from interface: OptimisticCache

Called during CacheConcurrencyStrategy.update(java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object) processing for transactional strategies. Indicates we have just performed an update against the DB and now need to cache the updated state.

Specified by:: writeUpdate in interface OptimisticCache

Parameters:: key - The cache key.; value - The data to be cached.; currentVersion - The entity's current version; previousVersion - The entity's previous version (before the update); or null if not versioned.

writeLoad

public void writeLoad(Object key,
                      Object value,
                      Object currentVersion)

Description copied from interface: OptimisticCache

Called during CacheConcurrencyStrategy.put(java.lang.Object, java.lang.Object, long, java.lang.Object, java.util.Comparator, boolean) processing for transactional strategies. Indicates we have just loaded an entity's state from the database and need it cached.

Specified by:: writeLoad in interface OptimisticCache

Parameters:: key - The cache key.; value - The data to be cached.; currentVersion - The entity's version; or null if not versioned.