Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.schema

Class Table

java.lang.Object

com.aoindustries.aoserv.client.AOServObject<K,T>

com.aoindustries.aoserv.client.GlobalObject<Integer,T>

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

com.aoindustries.aoserv.client.schema.Table

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AOServReadable, AOServStreamable, AOServWritable

public final class Table
extends GlobalObjectIntegerKey<Table>

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Table.TableID	Each set of tables in the protocol used by this client version.

Field Summary

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

pkey

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

USE_ARRAY_OF_DOMAIN, USE_SQL_DATA, USE_SQL_DATA_WRITE

Constructor Summary

Constructors

Constructor	Description
Table()
Table(int id, String name, String sinceVersion, String lastVersion, String display, boolean isPublic, String description)

Method Summary

Modifier and Type	Method	Description
AOServTable<?,? extends AOServObject<?,?>>	getAOServTable(AOServConnector connector)
List<Command>	getAOSHCommands(AOServConnector connector)
protected Object	getColumnImpl(int i)
String	getDescription()
String	getDisplay()
int	getId()
AoservProtocol	getLastVersion(AOServConnector connector)
String	getLastVersion_version()
String	getName()
Column	getSchemaColumn(AOServConnector connector, int index)
Column	getSchemaColumn(AOServConnector connector, String name)
List<Column>	getSchemaColumns(AOServConnector connector)
List<ForeignKey>	getSchemaForeignKeys(AOServConnector connector)
AoservProtocol	getSinceVersion(AOServConnector connector)
String	getSinceVersion_version()
Table.TableID	getTableID()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isPublic()
void	printDescription(AOServConnector connector, TerminalWriter out, boolean isInteractive)
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
String	toStringImpl()	AOServObject.toString() implementation that is allowed to throw exceptions.
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

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

equals, getKey, getPkey, hashCode

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

compare, compare, compare, compare, compareIgnoreCaseConsistentWithEquals, compareTo, compareTo, compareTo, getAccountingCode, getColumn, getColumns, getColumns, getDomainLabel, getDomainLabels, getDomainName, getDto, getEmail, getGecos, getGroupId, getHashedKey, getHashedPassword, getHostname, getInetAddress, getLinuxID, getLinuxUserName, getMacAddress, getMySQLDatabaseName, getMySQLServerName, getMysqlUserName, getPort, getPostgresDatabaseName, getPostgresServerName, getPostgresUserId, getTableSchema, getTimeMillis, getTimeMillis, getUnixPath, getUserId, read, toString, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Table

public Table()

Table

public Table(int id,
             String name,
             String sinceVersion,
             String lastVersion,
             String display,
             boolean isPublic,
             String description)

Method Detail

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AOServObject<Integer,Table>

getId

public int getId()

getName

public String getName()

getSinceVersion_version

public String getSinceVersion_version()

getSinceVersion

public AoservProtocol getSinceVersion(AOServConnector connector)
                               throws SQLException,
                                      IOException

Throws:

SQLException

IOException

getLastVersion_version

public String getLastVersion_version()

getLastVersion

public AoservProtocol getLastVersion(AOServConnector connector)
                              throws SQLException,
                                     IOException

Throws:

SQLException

IOException

getDisplay

public String getDisplay()

isPublic

public boolean isPublic()

getDescription

public String getDescription()

getTableID

public Table.TableID getTableID()

Specified by:

getTableID in class AOServObject<Integer,Table>

init

public void init(ResultSet result)
          throws SQLException

Description copied from class: AOServObject

Initializes this object from the raw database contents.

Specified by:

init in class AOServObject<Integer,Table>

Parameters:

result - the ResultSet containing the row to copy into this object

Throws:

SQLException

read

public void read(StreamableInput in,
                 AoservProtocol.Version protocolVersion)
          throws IOException

Specified by:

read in interface AOServReadable

Specified by:

read in interface AOServStreamable

Specified by:

read in class AOServObject<Integer,Table>

Throws:

IOException

write

public void write(StreamableOutput out,
                  AoservProtocol.Version protocolVersion)
           throws IOException

Specified by:

write in interface AOServStreamable

Specified by:

write in interface AOServWritable

Specified by:

write in class AOServObject<Integer,Table>

Throws:

IOException

toStringImpl

public String toStringImpl()

Description copied from class: AOServObject

AOServObject.toString() implementation that is allowed to throw exceptions.

Implementation Note:
This default implementation calls AOServObject.toString() on the key (from AOServObject.getKey()). When the key is null, uses the default implementation from Object.toString().

Overrides:

toStringImpl in class GlobalObjectIntegerKey<Table>

getAOServTable

public AOServTable<?,? extends AOServObject<?,?>> getAOServTable(AOServConnector connector)

getAOSHCommands

public List<Command> getAOSHCommands(AOServConnector connector)
                              throws IOException,
                                     SQLException

Throws:

IOException

SQLException

getSchemaColumn

public Column getSchemaColumn(AOServConnector connector,
                              String name)
                       throws IOException,
                              SQLException

Throws:

IOException

SQLException

getSchemaColumn

public Column getSchemaColumn(AOServConnector connector,
                              int index)
                       throws IOException,
                              SQLException

Throws:

IOException

SQLException

getSchemaColumns

public List<Column> getSchemaColumns(AOServConnector connector)
                              throws IOException,
                                     SQLException

Throws:

IOException

SQLException

getSchemaForeignKeys

public List<ForeignKey> getSchemaForeignKeys(AOServConnector connector)
                                      throws IOException,
                                             SQLException

Throws:

IOException

SQLException

printDescription

public void printDescription(AOServConnector connector,
                             TerminalWriter out,
                             boolean isInteractive)
                      throws IOException,
                             SQLException

Throws:

IOException

SQLException