ca.uhn.cache.impl
Class Chunk

java.lang.Object
  ca.uhn.cache.impl.Chunk

All Implemented Interfaces:

IChunk

public class Chunk

extends java.lang.Object

implements IChunk

A block of data that is retrieved and cached together. The boundaries of a IChunk are defined according to QueryParameters. Data items may have attributes such as category, date, name, etc. Some of these, for example category and date, will correspond to QueryParameters. A IChunk is a grouping of data items in the same part of the QueryParameter space. How this space is divided is determined by a ISemanticCache.

Version:

$Revision: 1.1 $ updated on $Date: 2005/01/24 22:52:36 $ by $Author: bryan_tripp $

Author:

Bryan Tripp

Constructor Summary

Chunk(java.lang.String theId, VolatilityEnum theVolatility, java.util.Date theLastUpdateTime, java.util.Date theCacheTime, java.util.Date theLastAccessTime, CacheReasonEnum[] theReasons, IQuery theBoundaries)

Method Summary

IQuery	getBoundaries()
java.util.Date	getCacheTime()
java.lang.String	getId()
java.util.Date	getLastAccessTime()
java.util.Date	getLastUpdateTime()
CacheReasonEnum[]	getReasons()
VolatilityEnum	getVolatility()

Methods inherited from class java.lang.Object

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

Constructor Detail

Chunk

public Chunk(java.lang.String theId,
             VolatilityEnum theVolatility,
             java.util.Date theLastUpdateTime,
             java.util.Date theCacheTime,
             java.util.Date theLastAccessTime,
             CacheReasonEnum[] theReasons,
             IQuery theBoundaries)

Parameters:

theId - the id

theVolatility - the volatility

theLastUpdateTime - the last update time

theCacheTime - the cache time

theLastAccessTime - the last access time

theReasons - the reasons

theBoundaries - the boundaries

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface IChunk

Returns:

the unique ID of the chunk

getVolatility

public VolatilityEnum getVolatility()

Specified by:

getVolatility in interface IChunk

Returns:

the greatest volatility of all data in the chunk

getLastUpdateTime

public java.util.Date getLastUpdateTime()

Specified by:

getLastUpdateTime in interface IChunk

Returns:

the most recent time of update of all data in the chunk

getCacheTime

public java.util.Date getCacheTime()

Specified by:

getCacheTime in interface IChunk

Returns:

the time at which the data in the chunk were cached

getLastAccessTime

public java.util.Date getLastAccessTime()

Specified by:

getLastAccessTime in interface IChunk

Returns:

the most recent time at which data in the the chunk were accessed

getReasons

public CacheReasonEnum[] getReasons()

Specified by:

getReasons in interface IChunk

Returns:

a list of reasons why this chunk was cached

getBoundaries

public IQuery getBoundaries()

Specified by:

getBoundaries in interface IChunk

Returns:

IQuery describing the limits of the chunk TODO: possibly replace with method to see if a data item fits here