Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.schema

Class ForeignKey

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<Integer,ForeignKey>

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

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

com.aoindustries.aoserv.client.schema.ForeignKey

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable

public final class ForeignKey
extends GlobalObjectIntegerKey<ForeignKey>

A SchemaForeignKey represents when a column in one AoservTable references a column in another AoservTable.

Author:

AO Industries, Inc.

See Also:

• Column

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
ForeignKey()	Deprecated, for removal: This API element is subject to removal in a future version. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
Column	getColumn(AoservConnector connector)
int	getColumn_id()
protected Object	getColumnImpl(int i)
Column	getForeignColumn(AoservConnector connector)
int	getForeignColumn_id()
AoservProtocol	getLastVersion(AoservConnector connector)
String	getLastVersion_version()
AoservProtocol	getSinceVersion(AoservConnector connector)
String	getSinceVersion_version()
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

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

equals, getKey, getPkey, hashCode, toStringImpl

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 Details

ForeignKey

@Deprecated(forRemoval=true)
public ForeignKey()

Deprecated, for removal: This API element is subject to removal in a future version.

Only required for implementation, do not use directly.

See Also:

• init(java.sql.ResultSet)
• read(com.aoapps.hodgepodge.io.stream.StreamableInput, com.aoindustries.aoserv.client.schema.AoservProtocol.Version)

Method Details

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,ForeignKey>

getColumn_id

public int getColumn_id()

getColumn

public Column getColumn(AoservConnector connector)
                 throws SQLException,
IOException

Throws:

SQLException

IOException

getForeignColumn_id

public int getForeignColumn_id()

getForeignColumn

public Column getForeignColumn(AoservConnector connector)
                        throws SQLException,
IOException

Throws:

SQLException

IOException

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

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,ForeignKey>

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

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

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

Throws:

IOException