org.tentackle.sql.metadata

Class ForeignKeyColumnMetaData

java.lang.Object

org.tentackle.sql.metadata.ForeignKeyColumnMetaData

All Implemented Interfaces:

Comparable<ForeignKeyColumnMetaData>

public class ForeignKeyColumnMetaData
extends Object
implements Comparable<ForeignKeyColumnMetaData>

Meta data for a column of a foreign key.

Author:

harald

Field Summary

Fields

Modifier and Type	Field and Description
protected String	foreignKeyColumn
protected ForeignKeyMetaData	foreignKeyMetaData
protected int	position
protected String	primaryKeyColumn

Constructor Summary

Constructors

Constructor and Description
ForeignKeyColumnMetaData(ForeignKeyMetaData foreignKeyMetaData) Creates a foreign key column.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ForeignKeyColumnMetaData o)
String	getForeignKeyColumn() Gets the referencing column.
ForeignKeyMetaData	getForeignKeyMetaData() Gets the foreign key.
int	getPosition() Gets the ordinal position within the index.
String	getPrimaryKeyColumn() Gets the referenced column.
void	setupForeignKeyColumnFromMetaData(ResultSet resultSet) Sets up the foreign key column from the database meta data result.
String	toString()
void	validate() Validates and postprocesses the foreign key column data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

foreignKeyMetaData

protected final ForeignKeyMetaData foreignKeyMetaData

position

protected int position

foreignKeyColumn

protected String foreignKeyColumn

primaryKeyColumn

protected String primaryKeyColumn

Constructor Detail

ForeignKeyColumnMetaData

public ForeignKeyColumnMetaData(ForeignKeyMetaData foreignKeyMetaData)

Creates a foreign key column.

Parameters:

foreignKeyMetaData - the foreign key column belongs to

Method Detail

getForeignKeyMetaData

public ForeignKeyMetaData getForeignKeyMetaData()

Gets the foreign key.

Returns:

the foreign key this column belongs to

getPosition

public int getPosition()

Gets the ordinal position within the index.

Returns:

the position

getForeignKeyColumn

public String getForeignKeyColumn()

Gets the referencing column.

Returns:

the column name

getPrimaryKeyColumn

public String getPrimaryKeyColumn()

Gets the referenced column.

Returns:

the column

setupForeignKeyColumnFromMetaData

public void setupForeignKeyColumnFromMetaData(ResultSet resultSet)
                                       throws SQLException

Sets up the foreign key column from the database meta data result.

Parameters:

resultSet - the column result set

Throws:

SQLException - the processing the result set failed

validate

public void validate()

Validates and postprocesses the foreign key column data.

compareTo

public int compareTo(ForeignKeyColumnMetaData o)

Specified by:

compareTo in interface Comparable<ForeignKeyColumnMetaData>

toString

public String toString()

Overrides:

toString in class Object