Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.schema

Class TableTable

java.lang.Object

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

com.aoindustries.aoserv.client.GlobalTable<Integer,V>

com.aoindustries.aoserv.client.GlobalTableIntegerKey<Table>

com.aoindustries.aoserv.client.schema.TableTable

All Implemented Interfaces:

Table<Table>, Iterable<Table>

public final class TableTable
extends GlobalTableIntegerKey<Table>

Author:

AO Industries, Inc.

See Also:

Table

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
Table	get(int table_id)
Table	get(Table.TableID tableID)
Table	get(Object pkey)	Deprecated. Always try to lookup by specific keys; the compiler will help you more when types change.
Table	get(String name)
protected AOServTable.OrderBy[]	getDefaultOrderBy()	Gets the default sorting for this table.
List<Table>	getRows()	Gets the list of all accessible rows.
Table.TableID	getTableID()	Gets the unique identifier for this table.
boolean	handleCommand(String[] args, Reader in, TerminalWriter out, TerminalWriter err, boolean isInteractive)

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

clearCache, getGlobalRowCount, getIndexedRows, getRowsCopy, getUniqueRowImpl, isLoaded

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

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

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,Table>

Returns:

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

get

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

Deprecated.

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

Supports Integer (table_id), String(name), and SchemaTable.TableID (table_id) keys.

Overrides:

get in class GlobalTableIntegerKey<Table>

Parameters:

pkey - when null, will always return null

Throws:

IOException

SQLException

getRows

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

Description copied from class: AOServTable

Gets the list of all accessible rows.

Specified by:

getRows in interface Table<Table>

Overrides:

getRows in class GlobalTable<Integer,Table>

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()

get

public Table get(int table_id)
          throws IOException,
                 SQLException

Specified by:

get in class GlobalTableIntegerKey<Table>

Throws:

IOException

SQLException

See Also:

get(java.lang.Object)

get

public Table get(String name)
          throws IOException,
                 SQLException

Throws:

IOException

SQLException

See Also:

get(java.lang.Object)

get

public Table get(Table.TableID tableID)
          throws IOException,
                 SQLException

Throws:

IOException

SQLException

See Also:

get(java.lang.Object)

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,Table>

Returns:

the identifier for this table

See Also:

Table.TableID

handleCommand

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

Overrides:

handleCommand in class AOServTable<Integer,Table>

Throws:

SQLException

IOException