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
default Column	getColumn(String name) Deprecated.
List<Column>	getColumns() Gets the list of columns in ordinal order.
Collection<ForeignKey>	getExportedForeignKeys() Gets the list of exported foreign keys.
default ForeignKey	getForeignKey(String name) Deprecated.
Collection<ForeignKey>	getForeignKeys() Gets the list of foreign keys.
Collection<ForeignKey>	getImportedForeignKeys() Gets the list of imported foreign keys.
default Index	getIndex(String name) Deprecated.
Collection<Index>	getIndexes() Gets the list of indexes.
PrimaryKey	getPrimaryKey() Gets the primary key.
default Privilege<Table>	getPrivilege(String name) Deprecated.
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.
default Trigger	getTrigger(String name) Deprecated.
Collection<Trigger>	getTriggers() Gets the list of triggers.
Optional<? extends Column>	lookupColumn(String name) Gets a column by unqualified name.
Optional<? extends ForeignKey>	lookupForeignKey(String name) Gets a foreign key by name.
Optional<? extends Index>	lookupIndex(String name) Gets an index by unqualified name.
Optional<? extends Privilege<Table>>	lookupPrivilege(String name) Gets a privilege by unqualified name.
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, 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

getColumn

@Deprecated
default Column getColumn(String name)

Deprecated.

Gets a column by unqualified name.

Parameters:

name - Unqualified name

Returns:

Column, or null if not found.

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.

getForeignKey

@Deprecated
default ForeignKey getForeignKey(String name)

Deprecated.

Gets a foreign key by name.

Parameters:

name - Name

Returns:

Foreign key, or null if not found.

getForeignKeys

Collection<ForeignKey> getForeignKeys()

Gets the list of foreign keys. Same as calling getForeignKeys(TableAssociationType.all).

Returns:

Foreign keys 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.

getIndex

@Deprecated
default Index getIndex(String name)

Deprecated.

Gets an index by unqualified name.

Parameters:

name - Name

Returns:

Index, or null if not found.

getIndexes

Collection<Index> getIndexes()

Gets the list of indexes.

Returns:

Indexes of the table.

getPrimaryKey

PrimaryKey getPrimaryKey()

Gets the primary key.

Returns:

Primary key

getPrivilege

@Deprecated
default Privilege<Table> getPrivilege(String name)

Deprecated.

Gets a privilege by unqualified name.

Parameters:

name - Unqualified name

Returns:

Privilege, or null if not found.

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.

getTrigger

@Deprecated
default Trigger getTrigger(String name)

Deprecated.

Gets a trigger by unqualified name.

Parameters:

name - Unqualified name

Returns:

Trigger, or null if not found.

getTriggers

Collection<Trigger> getTriggers()

Gets the list of triggers.

Returns:

Triggers for the table.

lookupColumn

Optional<? extends Column> lookupColumn(String name)

Gets a column by unqualified name.

Parameters:

name - Unqualified name

Returns:

Column.

lookupForeignKey

Optional<? extends ForeignKey> lookupForeignKey(String name)

Gets a foreign key by name.

Parameters:

name - Name

Returns:

Foreign key.

lookupIndex

Optional<? extends Index> lookupIndex(String name)

Gets an index by unqualified name.

Parameters:

name - Name

Returns:

Index.

lookupPrivilege

Optional<? extends Privilege<Table>> lookupPrivilege(String name)

Gets a privilege by unqualified name.

Parameters:

name - Name

Returns:

Privilege.

lookupTrigger

Optional<? extends Trigger> lookupTrigger(String name)

Gets a trigger by unqualified name.

Parameters:

name - Name

Returns:

Trigger.