net.aditsu.depeche

Class TableInfo

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<Column>

net.aditsu.depeche.ColumnInfo

net.aditsu.depeche.TableInfo

All Implemented Interfaces:

Serializable, Iterable<Column>, Collection<Column>, List<Column>

Direct Known Subclasses:

MutableTableInfo

public class TableInfo
extends ColumnInfo

Information about a database table

Author:

aditsu

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
Column	getAutoColumn() Returns the autoincrement column if it exists and is unique, or null otherwise
int	getAutoColumnIndex() Returns the index of the autoincrement column if it exists and is unique, or -1 otherwise
FKey	getExpKey(String name) Returns the exported key with the given name; it throws an exception if there are zero or multiple such exported keys
FKey	getExpKey(Table t) Returns the exported key that references the given table; it throws an exception if there are zero or multiple such exported keys
Map<ExpKey,FKey>	getExpKeys() Returns this table's exported keys mapped by their fk table and name
FKey	getFKey(String name) Returns the foreign key with the given name; it throws an exception if there is no such foreign key
FKey	getFKey(Table t) Returns the foreign key that references the given table; it throws an exception if there are zero or multiple such foreign keys
Map<String,FKey>	getFKeys() Returns this table's foreign keys mapped by their name
KeyInfo	getPKeyInfo() Returns a KeyInfo object listing this table's primary key columns
String	getPkName() Returns the name of the primary key constraint (may be null)

Methods inherited from class net.aditsu.depeche.ColumnInfo

get, get, getColumnIndex, getColumnLabels, getColumnNames, getLabel, getName, getTable, hasColumn, size

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Method Detail

getAutoColumnIndex

public int getAutoColumnIndex()

Returns the index of the autoincrement column if it exists and is unique, or -1 otherwise

getAutoColumn

public Column getAutoColumn()

Returns the autoincrement column if it exists and is unique, or null otherwise

getPKeyInfo

public KeyInfo getPKeyInfo()

Returns a KeyInfo object listing this table's primary key columns

getPkName

public String getPkName()

Returns the name of the primary key constraint (may be null)

getFKeys

public Map<String,FKey> getFKeys()

Returns this table's foreign keys mapped by their name

getExpKeys

public Map<ExpKey,FKey> getExpKeys()

Returns this table's exported keys mapped by their fk table and name

getFKey

public FKey getFKey(Table t)

Returns the foreign key that references the given table; it throws an exception if there are zero or multiple such foreign keys

Parameters:

t - primary key table

getFKey

public FKey getFKey(String name)

Returns the foreign key with the given name; it throws an exception if there is no such foreign key

Parameters:

name - key name

getExpKey

public FKey getExpKey(Table t)

Returns the exported key that references the given table; it throws an exception if there are zero or multiple such exported keys

Parameters:

t - foreign key table

getExpKey

public FKey getExpKey(String name)

Returns the exported key with the given name; it throws an exception if there are zero or multiple such exported keys

Parameters:

name - key name