Module com.aoapps.dao.base

Package com.aoapps.dao.base

Class TableCacheTable<K extends Comparable<? super K>,R extends Row<K,?>>

java.lang.Object

com.aoapps.dao.base.AbstractTable<K,R>

com.aoapps.dao.base.TableCacheTable<K,R>

All Implemented Interfaces:

Table<K,R>, Iterable<R>, Collection<R>

public abstract class TableCacheTable<K extends Comparable<? super K>,R extends Row<K,?>>
extends AbstractTable<K,R>

Caches results by querying the entire table upon first use. The cache is per-request and per-user.

1. All rows are loaded and stored unsorted
2. allRowsLoaded is called, given unsorted rows
3. Map is built upon first call to get(K)
4. Rows are sorted upon first call to getRows

Field Summary

Fields

Modifier and Type	Field	Description
protected final ThreadLocal<Set<? extends R>>	unsortedRowsCache

Fields inherited from class com.aoapps.dao.base.AbstractTable

map, sortedMap

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TableCacheTable(Class<K> keyClass, Class<R> rowClass, Model model)

Method Summary

Modifier and Type	Method	Description
protected void	allRowsLoaded(Set<? extends R> rows)	Called when all rows have been loaded at once.
void	clearCaches()	Clears all caches for the current thread.
R	get(K key)
SortedSet<? extends R>	getRows()
protected abstract Set<? extends R>	getRowsNoCache()
Set<? extends R>	getUnsortedRows()
void	tableUpdated()	When the table is updated, all caches are cleared for the current thread.

Methods inherited from class com.aoapps.dao.base.AbstractTable

getMap, getModel, getSortedMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface com.aoapps.dao.Table

add, addAll, canonicalize, clear, contains, containsAll, getIterator, getName, getOrderedRows, getRows, getSize, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Field Details

unsortedRowsCache

protected final ThreadLocal<Set<? extends R extends Row<K,?>>> unsortedRowsCache

Constructor Details

TableCacheTable

protected TableCacheTable(Class<K> keyClass,
 Class<R> rowClass,
 Model model)

Method Details

clearCaches

public void clearCaches()

Clears all caches for the current thread.

tableUpdated

public void tableUpdated()

When the table is updated, all caches are cleared for the current thread.

getUnsortedRows

public Set<? extends R> getUnsortedRows()
                                 throws SQLException

Throws:

SQLException

allRowsLoaded

protected void allRowsLoaded(Set<? extends R> rows)
                      throws SQLException

Called when all rows have been loaded at once. This allows for subclasses to populate any views or caches.

This default implementation does nothing.

Throws:

SQLException

getRows

public SortedSet<? extends R> getRows()
                               throws SQLException

Throws:

SQLException

get

public R get(K key)
      throws NoRowException,
SQLException

Throws:

NoRowException

SQLException

getRowsNoCache

protected abstract Set<? extends R> getRowsNoCache()
                                            throws SQLException

Throws:

SQLException