ca.uhn.cache.impl
Class AbstractMethodDataSourceHelper

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

All Implemented Interfaces:

IMethodDataSourceHelper

public abstract class AbstractMethodDataSourceHelper

extends java.lang.Object

implements IMethodDataSourceHelper

Base class for the IMethodDataSourceHelper implementors that are meant to be used with methods that return a Collection, Set or array.

Version:

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

Author:

Alexei Guevara

Constructor Summary

protected

AbstractMethodDataSourceHelper()

Method Summary

IDataItem	buildDataItem(java.io.Serializable theObj) Builds a data item from the provided object.
abstract java.lang.String	buildId(java.io.Serializable theObj) Builds a unique identifier from the provided object.
abstract IQuery	buildProjection(java.lang.Object theObj) Builds the query that represents the projection of the provided object in the parameter space.
IQueryResult	buildQueryResult(java.lang.Object theObject) Builds a query result from the provided object. A IQueryResult is composed of zero or more IDataItems.
abstract java.util.Date	getLastUpdateTime(java.io.Serializable theObj)
abstract VolatilityEnum	getVolatility(java.io.Serializable theObj)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.cache.IMethodDataSourceHelper

buildArguments

Constructor Detail

AbstractMethodDataSourceHelper

protected AbstractMethodDataSourceHelper()

Method Detail

buildQueryResult

public IQueryResult buildQueryResult(java.lang.Object theObject)

Builds a query result from the provided object. A IQueryResult is composed of zero or more IDataItems.

Specified by:

buildQueryResult in interface IMethodDataSourceHelper

Parameters:

theObject - The provided object.

Returns:

The query result.

buildDataItem

public IDataItem buildDataItem(java.io.Serializable theObj)

Builds a data item from the provided object. A IDataItem represents a discrete piece of data.

Parameters:

theObj - The provided object.

Returns:

The data item.

buildId

public abstract java.lang.String buildId(java.io.Serializable theObj)

Builds a unique identifier from the provided object.

Parameters:

theObj - The provided object.

Returns:

The object's unique identifier.

buildProjection

public abstract IQuery buildProjection(java.lang.Object theObj)

Builds the query that represents the projection of the provided object in the parameter space.

Parameters:

theObj - The provided object.

Returns:

The query built.

getVolatility

public abstract VolatilityEnum getVolatility(java.io.Serializable theObj)

Parameters:

theObj - The provided object.

Returns:

The volatility of the provided object.

getLastUpdateTime

public abstract java.util.Date getLastUpdateTime(java.io.Serializable theObj)

Parameters:

theObj - The provided object

Returns:

The time this object was last updated. If this is unknown, it returns the current time