Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.schema

Class Column

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.schema.Column

All Implemented Interfaces:

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

public final class Column
extends GlobalObjectIntegerKey<Column>

Meta-data for every field of every AOServObject is available as a SchemaColumn. This allows AOServObjects to be treated in a uniform manner, while still accessing all of their attributes.

Author:

AO Industries, Inc.

See Also:

Table, AOServObject

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
Column()
Column(int id, String table, String name, String sinceVersion, String lastVersion, short index, String type, boolean isNullable, boolean isUnique, boolean isPublic, String description)

Method Summary

Modifier and Type	Method	Description
protected Object	getColumnImpl(int i)
String	getDescription()
int	getId()
short	getIndex()
AoservProtocol	getLastVersion(AOServConnector connector)
String	getLastVersion_version()
String	getName()
List<ForeignKey>	getReferencedBy(AOServConnector connector)
List<ForeignKey>	getReferences(AOServConnector connector)
AoservProtocol	getSinceVersion(AOServConnector connector)
String	getSinceVersion_version()
Table	getTable(AOServConnector connector)
String	getTable_name()
Table.TableID	getTableID()
Type	getType(AOServConnector connector)
String	getType_name()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isNullable()
boolean	isPublic()
boolean	isUnique()
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

Column

public Column()

Column

public Column(int id,
              String table,
              String name,
              String sinceVersion,
              String lastVersion,
              short index,
              String type,
              boolean isNullable,
              boolean isUnique,
              boolean isPublic,
              String description)

Method Detail

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AOServObject<Integer,Column>

getId

public int getId()

getTable_name

public String getTable_name()

getTable

public Table getTable(AOServConnector connector)
               throws SQLException,
                      IOException

Throws:

SQLException

IOException

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

getIndex

public short getIndex()

getType_name

public String getType_name()

getType

public Type getType(AOServConnector connector)
             throws SQLException,
                    IOException

Throws:

SQLException

IOException

isNullable

public boolean isNullable()

isUnique

public boolean isUnique()

isPublic

public boolean isPublic()

getDescription

public String getDescription()

getTableID

public Table.TableID getTableID()

Specified by:

getTableID in class AOServObject<Integer,Column>

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

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

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

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

getReferencedBy

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

Throws:

IOException

SQLException

getReferences

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

Throws:

IOException

SQLException