sirius.db.jdbc.schema

Class Table

java.lang.Object

sirius.db.jdbc.schema.Table

public class Table
extends Object

Represents a database table.

Constructor Summary

Constructors

Constructor and Description
Table()
Table(EntityDescriptor source)

Method Summary

Modifier and Type	Method and Description
String	dump() Provides a full report of all elements of this table.
boolean	equals(Object obj)
List<TableColumn>	getColumns() Returns a mutable list of columns of this table.
ForeignKey	getForeignKey(String name) Returns the foreign key with the given name.
List<ForeignKey>	getForeignKeys() Returns a mutable list of foreign keys of this table.
Key	getKey(String indexName) Returns the key with the given name.
List<Key>	getKeys() Returns a mutable list of keys of this table.
String	getName() Returns the name of the table.
List<String>	getPrimaryKey() Returns the columns which make up the primary key
EntityDescriptor	getSource()
int	hashCode()
void	setName(String name) Sets the name of the table.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Table

public Table(EntityDescriptor source)

Table

public Table()

Method Detail

getSource

public EntityDescriptor getSource()

getPrimaryKey

public List<String> getPrimaryKey()

Returns the columns which make up the primary key

Returns:

the columns of the primary key

getName

public String getName()

Returns the name of the table.

Returns:

the name of the table

setName

public void setName(String name)

Sets the name of the table.

Parameters:

name - the name of the table

getColumns

public List<TableColumn> getColumns()

Returns a mutable list of columns of this table.

Returns:

the list of columns of this table

getKeys

public List<Key> getKeys()

Returns a mutable list of keys of this table.

Returns:

the list of key of this table

getForeignKeys

public List<ForeignKey> getForeignKeys()

Returns a mutable list of foreign keys of this table.

Returns:

the list of foreign keys of this table

getKey

public Key getKey(String indexName)

Returns the key with the given name.

Parameters:

indexName - the name of the key or index

Returns:

the key with the given name or null if no such key exists

getForeignKey

public ForeignKey getForeignKey(String name)

Returns the foreign key with the given name.

Parameters:

name - the name of the foreign key

Returns:

the foreign key with the given name or null if no such key exists

toString

public String toString()

Overrides:

toString in class Object

dump

public String dump()

Provides a full report of all elements of this table.

Returns:

a string containing all elements of this table

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object