Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client

Class CachedTable<K,V extends CachedObject<K,V>>

java.lang.Object

com.aoindustries.aoserv.client.AOServTable<K,V>

com.aoindustries.aoserv.client.CachedTable<K,V>

All Implemented Interfaces:

Table<V>, Iterable<V>

Direct Known Subclasses:

CachedTableAccountNameKey, CachedTableGroupNameKey, CachedTableIntegerKey, CachedTableLongKey, CachedTableStringKey, CachedTableUserNameKey, CachedTableUserNameKey, CachedTableUserNameKey, CachedTableUserNameKey

public abstract class CachedTable<K,V extends CachedObject<K,V>>
extends AOServTable<K,V>

A CachedTable stores all of the available CachedObjects and performs all subsequent data access locally. The server notifies the client when a table is updated, and the caches are then invalidated. Once invalidated, the data is reloaded upon next use.

Author:

AO Industries, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.aoindustries.aoserv.client.AOServTable

AOServTable.OrderBy

Field Summary

Fields inherited from class com.aoindustries.aoserv.client.AOServTable

ASCENDING, connector, DESCENDING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CachedTable(AOServConnector connector, Class<V> clazz)

Method Summary

Modifier and Type	Method	Description
void	clearCache()	Clears the cache, freeing up memory.
List<V>	getIndexedRows(int col, Object value)	Gets the rows in a more efficient, indexed manner.
List<V>	getRows()	Gets the complete list of objects in the table.
List<V>	getRowsCopy()	Gets a modifiable copy of the rows, which may then be manipulated, such as for sorting.
protected V	getUniqueRowImpl(int col, Object value)	Gets a row given a unique column value.
boolean	isLoaded()	Checks if the table is loaded.

Methods inherited from class com.aoindustries.aoserv.client.AOServTable

addProgressListener, addTableListener, addTableListener, addTableLoadListener, get, getCachedRowCount, getConnector, getDefaultOrderBy, getDefaultOrderBySQLExpressions, getIndexedRows, getMap, getNewObject, getObject, getObjects, getObjects, getObjects, getObjectsNoProgress, getObjectsNoProgress, getSize, getSortAlgorithm, getTableID, getTableName, getTableSchema, getUniqueRow, getUniqueRow, getUniqueRow, getUniqueRow, handleCommand, hasAnyTableListener, hasTableListener, isEmpty, iterator, printTable, removeProgressListener, removeTableListener, removeTableLoadListener, size, sortIfNeeded, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CachedTable

protected CachedTable(AOServConnector connector,
                      Class<V> clazz)

Method Detail

getIndexedRows

public List<V> getIndexedRows(int col,
                              Object value)
                       throws IOException,
                              SQLException

Description copied from class: AOServTable

Gets the rows in a more efficient, indexed manner.

Implementation Note:
This default implementation simply throws UnsupportedOperationException.

Overrides:

getIndexedRows in class AOServTable<K,V extends CachedObject<K,V>>

Throws:

IOException

SQLException

getUniqueRowImpl

protected final V getUniqueRowImpl(int col,
                                   Object value)
                            throws IOException,
                                   SQLException

Description copied from class: AOServTable

Gets a row given a unique column value.

Specified by:

getUniqueRowImpl in class AOServTable<K,V extends CachedObject<K,V>>

Parameters:

col - the column index to search

value - when null, no row is matched, even if there is a single row with a uniquely null value

Throws:

IOException

SQLException

getRows

public List<V> getRows()
                throws IOException,
                       SQLException

Gets the complete list of objects in the table.

Specified by:

getRows in interface Table<K>

Overrides:

getRows in class AOServTable<K,V extends CachedObject<K,V>>

Returns:

a List containing all of the rows

Throws:

IOException - if unable to access the server

SQLException - if unable to access the database

See Also:

AOServTable.getRowsCopy()

getRowsCopy

public List<V> getRowsCopy()
                    throws IOException,
                           SQLException

Description copied from class: AOServTable

Gets a modifiable copy of the rows, which may then be manipulated, such as for sorting.

This gives the table implementation a way to create a defensive copy most efficient to its underlying storage mechanism.

Note: It is best to use AOServTable.getSortAlgorithm() when sorting rows, as the choice of sorting can be very important when objects are pulled from non-heap source like filesystem-based objects. It is very easy for the sort itself to end up pulling all objects into heap.

Specified by:

getRowsCopy in class AOServTable<K,V extends CachedObject<K,V>>

Throws:

IOException

SQLException

See Also:

AOServTable.getRows(), AOServTable.getSortAlgorithm()

isLoaded

public final boolean isLoaded()

Description copied from class: AOServTable

Checks if the table is loaded. A table is considered loaded when accessing any part of it will be done entirely locally, avoiding any network traffic.

Overrides:

isLoaded in class AOServTable<K,V extends CachedObject<K,V>>

clearCache

public void clearCache()

Clears the cache, freeing up memory. The data will be reloaded upon next use.

Overrides:

clearCache in class AOServTable<K,V extends CachedObject<K,V>>