Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.email

Class SpamMessageTable

java.lang.Object

com.aoindustries.aoserv.client.AOServTable<Integer,SpamMessage>

com.aoindustries.aoserv.client.email.SpamMessageTable

All Implemented Interfaces:

Table<SpamMessage>, Iterable<SpamMessage>

public final class SpamMessageTable
extends AOServTable<Integer,SpamMessage>

Author:

AO Industries, Inc.

See Also:

SpamMessage

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

Method Summary

Modifier and Type	Method	Description
SpamMessage	get(int pkey)
SpamMessage	get(Object pkey)	Deprecated. Always try to lookup by specific keys; the compiler will help you more when types change.
protected AOServTable.OrderBy[]	getDefaultOrderBy()	Gets the default sorting for this table.
List<SpamMessage>	getIndexedRows(int col, Object value)	Gets the rows in a more efficient, indexed manner.
List<SpamMessage>	getRowsCopy()	Gets a modifiable copy of the rows, which may then be manipulated, such as for sorting.
Table.TableID	getTableID()	Gets the unique identifier for this table.
protected SpamMessage	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)

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

addProgressListener, addTableListener, addTableListener, addTableLoadListener, clearCache, getCachedRowCount, getConnector, getDefaultOrderBySQLExpressions, getIndexedRows, getMap, getNewObject, getObject, getObjects, getObjects, getObjects, getObjectsNoProgress, getObjectsNoProgress, getRows, getSize, getSortAlgorithm, getTableName, getTableSchema, getUniqueRow, getUniqueRow, getUniqueRow, getUniqueRow, hasAnyTableListener, hasTableListener, isEmpty, isLoaded, 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

Method Detail

getDefaultOrderBy

protected AOServTable.OrderBy[] getDefaultOrderBy()

Description copied from class: AOServTable

Gets the default sorting for this table.

Specified by:

getDefaultOrderBy in class AOServTable<Integer,SpamMessage>

Returns:

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

getRowsCopy

public List<SpamMessage> 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<Integer,SpamMessage>

Throws:

IOException

SQLException

See Also:

AOServTable.getRows(), AOServTable.getSortAlgorithm()

getTableID

public Table.TableID getTableID()

Description copied from class: AOServTable

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

Specified by:

getTableID in class AOServTable<Integer,SpamMessage>

Returns:

the identifier for this table

See Also:

Table.TableID

get

@Deprecated
public SpamMessage get(Object pkey)
                throws IOException,
                       SQLException

Deprecated.

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

Description copied from class: AOServTable

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

Specified by:

get in class AOServTable<Integer,SpamMessage>

Parameters:

pkey - when null, will always return null

Throws:

IOException

SQLException

get

public SpamMessage get(int pkey)
                throws IOException,
                       SQLException

Throws:

IOException

SQLException

See Also:

get(java.lang.Object)

getIndexedRows

public List<SpamMessage> 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<Integer,SpamMessage>

Throws:

IOException

SQLException

getUniqueRowImpl

protected SpamMessage 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<Integer,SpamMessage>

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 IllegalArgumentException,
                             IOException,
                             SQLException

Overrides:

handleCommand in class AOServTable<Integer,SpamMessage>

Throws:

IllegalArgumentException

IOException

SQLException