schemacrawler.schema

Interface Table

All Superinterfaces:

AttributedObject, Comparable<NamedObject>, DatabaseObject, DefinedObject, DescribedObject, NamedObject, Serializable, TypedObject<TableType>

All Known Subinterfaces:

View

public interface Table
extends DatabaseObject, TypedObject<TableType>, DefinedObject

Represents a table in the database.

Author:

Sualeh Fatehi

Method Summary

Modifier and Type	Method and Description
List<Column>	getColumns() Gets the list of columns in ordinal order.
Collection<ForeignKey>	getExportedForeignKeys() Gets the list of exported foreign keys.
Collection<ForeignKey>	getForeignKeys() Gets the list of all foreign keys of the table, including imported and exported foreign keys.
Collection<Column>	getHiddenColumns() Gets hidden columns.
Collection<ForeignKey>	getImportedForeignKeys() Gets the list of imported foreign keys.
Collection<Index>	getIndexes() Gets the list of indexes.
PrimaryKey	getPrimaryKey() Gets the primary key.
Collection<Privilege<Table>>	getPrivileges() Gets the list of privileges.
Collection<Table>	getRelatedTables(TableRelationshipType tableRelationshipType) Gets the tables related to this one, based on the specified relationship type.
Collection<TableConstraint>	getTableConstraints() Gets the constraints for the table.
TableType	getTableType() Gets the table type.
Collection<Trigger>	getTriggers() Gets the list of triggers.
boolean	hasPrimaryKey() Checks if the table has a primary key.
com.annimon.stream.Optional<? extends Column>	lookupColumn(String name) Gets a column by unqualified name.
com.annimon.stream.Optional<? extends ForeignKey>	lookupForeignKey(String name) Gets a foreign key by name.
com.annimon.stream.Optional<? extends Index>	lookupIndex(String name) Gets an index by unqualified name.
com.annimon.stream.Optional<? extends Privilege<Table>>	lookupPrivilege(String name) Gets a privilege by unqualified name.
com.annimon.stream.Optional<? extends Trigger>	lookupTrigger(String name) Gets a trigger by unqualified name.

Methods inherited from interface schemacrawler.schema.DatabaseObject

getSchema

Methods inherited from interface schemacrawler.schema.NamedObject

getFullName, getLookupKey, getName

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface schemacrawler.schema.AttributedObject

getAttribute, getAttribute, getAttributes, hasAttribute, lookupAttribute, removeAttribute, setAttribute

Methods inherited from interface schemacrawler.schema.DescribedObject

getRemarks, hasRemarks

Methods inherited from interface schemacrawler.schema.TypedObject

getType

Methods inherited from interface schemacrawler.schema.DefinedObject

getDefinition, hasDefinition

Method Detail

getColumns

List<Column> getColumns()

Gets the list of columns in ordinal order.

Returns:

Columns of the table

getExportedForeignKeys

Collection<ForeignKey> getExportedForeignKeys()

Gets the list of exported foreign keys. That is, only those whose primary key is referenced in another table.

Returns:

Exported foreign keys of the table.

getForeignKeys

Collection<ForeignKey> getForeignKeys()

Gets the list of all foreign keys of the table, including imported and exported foreign keys.

Returns:

Foreign keys of the table.

getHiddenColumns

Collection<Column> getHiddenColumns()

Gets hidden columns.

Returns:

Columns of the table

getImportedForeignKeys

Collection<ForeignKey> getImportedForeignKeys()

Gets the list of imported foreign keys. That is, only those that reference a primary key another table.

Returns:

Imported foreign keys of the table.

getIndexes

Collection<Index> getIndexes()

Gets the list of indexes.

Returns:

Indexes of the table.

getPrimaryKey

PrimaryKey getPrimaryKey()

Gets the primary key.

Returns:

Primary key

getPrivileges

Collection<Privilege<Table>> getPrivileges()

Gets the list of privileges.

Returns:

Privileges for the table.

getRelatedTables

Collection<Table> getRelatedTables(TableRelationshipType tableRelationshipType)

Gets the tables related to this one, based on the specified relationship type. Child tables are those who have a foreign key from this table. Parent tables are those to which this table has a foreign key.

Parameters:

tableRelationshipType - Table relationship type

Returns:

Related tables.

getTableConstraints

Collection<TableConstraint> getTableConstraints()

Gets the constraints for the table.

Returns:

Constraints for the table

getTableType

TableType getTableType()

Gets the table type.

Returns:

Table type.

getTriggers

Collection<Trigger> getTriggers()

Gets the list of triggers.

Returns:

Triggers for the table.

hasPrimaryKey

boolean hasPrimaryKey()

Checks if the table has a primary key.

Returns:

True if the table has a primary key.

lookupColumn

com.annimon.stream.Optional<? extends Column> lookupColumn(String name)

Gets a column by unqualified name.

Parameters:

name - Unqualified name

Returns:

Column.

lookupForeignKey

com.annimon.stream.Optional<? extends ForeignKey> lookupForeignKey(String name)

Gets a foreign key by name.

Parameters:

name - Name

Returns:

Foreign key.

lookupIndex

com.annimon.stream.Optional<? extends Index> lookupIndex(String name)

Gets an index by unqualified name.

Parameters:

name - Name

Returns:

Index.

lookupPrivilege

com.annimon.stream.Optional<? extends Privilege<Table>> lookupPrivilege(String name)

Gets a privilege by unqualified name.

Parameters:

name - Name

Returns:

Privilege.

lookupTrigger

com.annimon.stream.Optional<? extends Trigger> lookupTrigger(String name)

Gets a trigger by unqualified name.

Parameters:

name - Name

Returns:

Trigger.