Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client

Class AOServTable<K,V extends AOServObject<K,V>>

java.lang.Object

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

All Implemented Interfaces:

Table<V>, Iterable<V>

Direct Known Subclasses:

BackupReportTable, BankTransactionTable, CachedTable, FileReplicationLogTable, FilesystemCachedTable, GlobalTable, ProcessTable, ServerStatTable, SpamMessageTable

public abstract class AOServTable<K,V extends AOServObject<K,V>>
extends Object
implements Iterable<V>, Table<V>

An AOServTable provides access to one set of AOServObjects. The subclasses often provide additional methods for manipulating the data outside the scope of a single AOServObject.

Author:

AO Industries, Inc.

See Also:

AOServObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AOServTable.OrderBy

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	ASCENDING	Indicates ascending sort.
protected AOServConnector	connector
static boolean	DESCENDING	Indicates descending sort.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addProgressListener(ProgressListener listener)
void	addTableListener(TableListener listener)	Registers a TableListener to be notified when the cached data for this table expires.
void	addTableListener(TableListener listener, long batchTime)	Registers a TableListener to be notified when the cached data for this table expires.
void	addTableLoadListener(TableLoadListener listener, Object param)
void	clearCache()	Clears the cache, freeing up memory.
abstract V	get(Object key)	Deprecated. Always try to lookup by specific keys; the compiler will help you more when types change.
int	getCachedRowCount()	Gets an approximate number of accessible rows in the database.
AOServConnector	getConnector()
protected abstract AOServTable.OrderBy[]	getDefaultOrderBy()	Gets the default sorting for this table.
SQLExpression[]	getDefaultOrderBySQLExpressions()
List<V>	getIndexedRows(int col, int value)	Gets the rows in a more efficient, indexed manner.
List<V>	getIndexedRows(int col, Object value)	Gets the rows in a more efficient, indexed manner.
Map<K,V>	getMap()	Gets a Map-compatible view of this table.
protected V	getNewObject()
protected V	getObject(boolean allowRetry, AoservProtocol.CommandID commID, Object... params)	Gets a single object or null when not found.
protected List<V>	getObjects(boolean allowRetry, AoservProtocol.CommandID commID, AOServWritable param1)	Limited to Integer.MAX_VALUE rows.
protected List<V>	getObjects(boolean allowRetry, AoservProtocol.CommandID commID, Object... params)
protected void	getObjects(boolean allowRetry, List<V> list, AoservProtocol.CommandID commID, Object... params)
protected List<V>	getObjectsNoProgress(boolean allowRetry, AoservProtocol.CommandID commID, Object... params)	Limited to Integer.MAX_VALUE rows.
protected void	getObjectsNoProgress(boolean allowRetry, List<V> list, AoservProtocol.CommandID commID, Object... params)
List<V>	getRows()	Gets the list of all accessible rows.
abstract List<V>	getRowsCopy()	Gets a modifiable copy of the rows, which may then be manipulated, such as for sorting.
int	getSize()	This is size for JavaBeans compatibility.
protected ComparisonSortAlgorithm<Object>	getSortAlgorithm()	Gets the ComparisonSortAlgorithm used to sort the table.
abstract Table.TableID	getTableID()	Gets the unique identifier for this table.
String	getTableName()
Table	getTableSchema()
V	getUniqueRow(int col, int value)
V	getUniqueRow(int col, long value)
V	getUniqueRow(int col, short value)
V	getUniqueRow(int col, Object value)
protected abstract V	getUniqueRowImpl(int col, Object value)	Gets a row given a unique column value.
boolean	handleCommand(String[] args, Reader in, TerminalWriter out, TerminalWriter err, boolean isInteractive)
boolean	hasAnyTableListener()	Checks if this table has at least one listener.
boolean	hasTableListener(TableListener listener)
boolean	isEmpty()
boolean	isLoaded()	Checks if the table is loaded.
Iterator<V>	iterator()
void	printTable(AOServConnector conn, PrintWriter out, boolean isInteractive)	Prints the contents of this table.
void	removeProgressListener(ProgressListener listener)	Removes a ProgressListener from the list of objects being notified as this table is being loaded.
void	removeTableListener(TableListener listener)	Removes a TableListener from the list of objects being notified when the data is updated.
void	removeTableLoadListener(TableLoadListener listener)	Removes a TableLoadListener from the list of objects being notified when the table is being loaded.
int	size()
protected void	sortIfNeeded(List<V> list)	Sorts the table using the default sort columns and orders.
String	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

Field Detail

connector

protected final AOServConnector connector

ASCENDING

public static final boolean ASCENDING

Indicates ascending sort.

See Also:

Constant Field Values

DESCENDING

public static final boolean DESCENDING

Indicates descending sort.

See Also:

Constant Field Values

Constructor Detail

AOServTable

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

Method Detail

addProgressListener

public final void addProgressListener(ProgressListener listener)

hasAnyTableListener

public final boolean hasAnyTableListener()

Checks if this table has at least one listener.

hasTableListener

public final boolean hasTableListener(TableListener listener)

addTableListener

public final void addTableListener(TableListener listener)

Registers a TableListener to be notified when the cached data for this table expires. The default of 1000ms of batching is used.

Specified by:

addTableListener in interface Table<K>

See Also:

addTableListener(TableListener,long)

addTableListener

public final void addTableListener(TableListener listener,
                                   long batchTime)

Registers a TableListener to be notified when the cached data for this table expires. Repitative incoming requests will be batched into fewer events, in increments provided by batchTime. If batchTime is 0, the event is immediately and always distributed. Batched events are performed in concurrent Threads, while immediate events are triggered by the central cache invalidation thread. In other words, don't use a batchTime of zero unless you absolutely need your code to run immediately, because it causes serial processing of the event and may potentially slow down the responsiveness of the server.

Specified by:

addTableListener in interface Table<K>

addTableLoadListener

public final void addTableLoadListener(TableLoadListener listener,
                                       Object param)

clearCache

public void clearCache()

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

getConnector

public final AOServConnector getConnector()

getDefaultOrderBy

protected abstract AOServTable.OrderBy[] getDefaultOrderBy()

Gets the default sorting for this table.

Returns:

null if the sorting is performed by the server or the array of column names

getDefaultOrderBySQLExpressions

public final SQLExpression[] getDefaultOrderBySQLExpressions()
                                                      throws SQLException,
                                                             IOException

Throws:

SQLException

IOException

getNewObject

protected V getNewObject()
                  throws IOException

Throws:

IOException

getObject

protected V getObject(boolean allowRetry,
                      AoservProtocol.CommandID commID,
                      Object... params)
               throws IOException,
                      SQLException

Gets a single object or null when not found.

Throws:

IOException

SQLException

getObjects

protected List<V> getObjects(boolean allowRetry,
                             AoservProtocol.CommandID commID,
                             Object... params)
                      throws IOException,
                             SQLException

Throws:

IOException

SQLException

getObjects

protected void getObjects(boolean allowRetry,
                          List<V> list,
                          AoservProtocol.CommandID commID,
                          Object... params)
                   throws IOException,
                          SQLException

Throws:

IOException

SQLException

getObjects

protected List<V> getObjects(boolean allowRetry,
                             AoservProtocol.CommandID commID,
                             AOServWritable param1)
                      throws IOException,
                             SQLException

Limited to Integer.MAX_VALUE rows.

Throws:

IOException

SQLException

See Also:

getObjects(boolean, java.util.List, com.aoindustries.aoserv.client.schema.AoservProtocol.CommandID, java.lang.Object...)

getObjectsNoProgress

protected void getObjectsNoProgress(boolean allowRetry,
                                    List<V> list,
                                    AoservProtocol.CommandID commID,
                                    Object... params)
                             throws IOException,
                                    SQLException

Throws:

IOException

SQLException

getObjectsNoProgress

protected List<V> getObjectsNoProgress(boolean allowRetry,
                                       AoservProtocol.CommandID commID,
                                       Object... params)
                                throws IOException,
                                       SQLException

Limited to Integer.MAX_VALUE rows.

Throws:

IOException

SQLException

See Also:

getObjectsNoProgress(boolean, java.util.List, com.aoindustries.aoserv.client.schema.AoservProtocol.CommandID, java.lang.Object...)

getSortAlgorithm

protected ComparisonSortAlgorithm<Object> getSortAlgorithm()

Gets the ComparisonSortAlgorithm used to sort the table.

Implementation Note:
Defaults to JavaSort.

sortIfNeeded

protected void sortIfNeeded(List<V> list)
                     throws SQLException,
                            IOException

Sorts the table using the default sort columns and orders. If no defaults have been provided, then the table is not sorted.

Throws:

SQLException

IOException

See Also:

getDefaultOrderBySQLExpressions()

getCachedRowCount

public int getCachedRowCount()
                      throws IOException,
                             SQLException

Gets an approximate number of accessible rows in the database.

Throws:

IOException

SQLException

See Also:

size()

getRows

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

Gets the list of all accessible rows.

Specified by:

getRows in interface Table<K>

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:

getRowsCopy()

getRowsCopy

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

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 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.

Throws:

IOException

SQLException

See Also:

getRows(), getSortAlgorithm()

getTableID

public abstract Table.TableID getTableID()

Gets the unique identifier for this table. Each table has a unique identifier, as defined in SchemaTable.TableID.

Returns:

the identifier for this table

See Also:

Table.TableID

getTableSchema

public final Table getTableSchema()
                           throws IOException,
                                  SQLException

Throws:

IOException

SQLException

getTableName

public final String getTableName()
                          throws IOException,
                                 SQLException

Specified by:

getTableName in interface Table<K>

Throws:

IOException

SQLException

getIndexedRows

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

Gets the rows in a more efficient, indexed manner.

Throws:

UnsupportedOperationException - if not supported by the specific table implementation

IOException

SQLException

getIndexedRows

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

Gets the rows in a more efficient, indexed manner.

Implementation Note:
This default implementation simply throws UnsupportedOperationException.

Throws:

UnsupportedOperationException - if not supported by the specific table implementation

IOException

SQLException

getUniqueRow

public final V getUniqueRow(int col,
                            int value)
                     throws IOException,
                            SQLException

Throws:

IOException

SQLException

getUniqueRow

public final V getUniqueRow(int col,
                            long value)
                     throws IOException,
                            SQLException

Throws:

IOException

SQLException

getUniqueRow

public final V getUniqueRow(int col,
                            Object value)
                     throws IOException,
                            SQLException

Throws:

IOException

SQLException

getUniqueRow

public final V getUniqueRow(int col,
                            short value)
                     throws IOException,
                            SQLException

Throws:

IOException

SQLException

getUniqueRowImpl

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

Gets a row given a unique column value.

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

handleCommand

public boolean handleCommand(String[] args,
                             Reader in,
                             TerminalWriter out,
                             TerminalWriter err,
                             boolean isInteractive)
                      throws IOException,
                             SQLException

Throws:

IOException

SQLException

isLoaded

public boolean isLoaded()

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.

printTable

public final void printTable(AOServConnector conn,
                             PrintWriter out,
                             boolean isInteractive)
                      throws IOException,
                             SQLException

Prints the contents of this table.

Throws:

IOException

SQLException

removeProgressListener

public final void removeProgressListener(ProgressListener listener)

Removes a ProgressListener from the list of objects being notified as this table is being loaded.

removeTableListener

public final void removeTableListener(TableListener listener)

Removes a TableListener from the list of objects being notified when the data is updated.

Specified by:

removeTableListener in interface Table<K>

removeTableLoadListener

public final void removeTableLoadListener(TableLoadListener listener)

Removes a TableLoadListener from the list of objects being notified when the table is being loaded.

toString

public final String toString()

Overrides:

toString in class Object

iterator

public Iterator<V> iterator()

Specified by:

iterator in interface Iterable<K>

getMap

public Map<K,V> getMap()

Gets a Map-compatible view of this table.

get

@Deprecated
public abstract V get(Object key)
               throws IOException,
                      SQLException

Deprecated.

Always try to lookup by specific keys; the compiler will help you more when types change.

Gets the value for the associated key or null if the data doesn't exist or is filtered.

Parameters:

key - when null, will always return null

Throws:

IOException

SQLException

isEmpty

public boolean isEmpty()
                throws IOException,
                       SQLException

Throws:

IOException

SQLException

size

public int size()
         throws IOException,
                SQLException

Throws:

IOException

SQLException

getSize

public final int getSize()
                  throws IOException,
                         SQLException

This is size for JavaBeans compatibility.

Throws:

IOException

SQLException