planetj.dataengine.cache
Class RowKeyTableCache

java.lang.Object
  planetj.dataengine.cache.RowKeyTableCache

Direct Known Subclasses:

KeyedRowCache

public class RowKeyTableCache

extends java.lang.Object

A cache which holds Objects based on RowKeys and Tables.

Constructor Summary

RowKeyTableCache()
RowKeyCache constructor comment.

Method Summary

boolean	add(RowKey key, TableCollection tables, java.lang.Object o) Adds an object to the cache, based on a RowKey and Table
java.lang.Object	get(RowKey key, TableCollection tables) Gets an Object out of the cache
java.util.List	getAll(Table table) Returns all the Objects for a given table that are in the cache.
java.util.List	getAll(TableCollection tc) Returns all the Objects for a given table collection that are in the cache.
protected java.util.Map	getTableMap(TableCollection tc) Gets the table map for the specified table collection

Methods inherited from class java.lang.Object

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

Constructor Detail

RowKeyTableCache

public RowKeyTableCache()

RowKeyCache constructor comment.

Method Detail

add

public boolean add(RowKey key,
                   TableCollection tables,
                   java.lang.Object o)

Adds an object to the cache, based on a RowKey and Table

Returns:

The old object that existed in the cache

get

public java.lang.Object get(RowKey key,
                            TableCollection tables)

Gets an Object out of the cache

Returns:

The Object in the cache which corresponds to the RowKey and TableCollection, or null if no such Object exists in the cache

getAll

public java.util.List getAll(TableCollection tc)

Returns all the Objects for a given table collection that are in the cache.

getAll

public java.util.List getAll(Table table)

Returns all the Objects for a given table that are in the cache. (Objects which correspond to multiple tables are not returned by this method)

getTableMap

protected java.util.Map getTableMap(TableCollection tc)

Gets the table map for the specified table collection