Module com.aoapps.dbc

Package com.aoapps.dbc.meta

Class Table

java.lang.Object

com.aoapps.dbc.meta.Table

public class Table
extends Object

A friendly wrapper around database meta data.

Author:

AO Industries, Inc.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Table(Schema schema, String name, String tableType)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Two tables are equal if they have the same schema name and table name.
Column	getColumn(int ordinalPosition)	Gets the column of the provided ordinal position, where positions start at one.
Column	getColumn(String name)	Gets the column of the provided name.
SortedMap<String,Column>	getColumnMap()	Gets all columns for this schema keyed by unique name.
Optional<Column>	getColumnOptional(int ordinalPosition)	Gets the column of the provided ordinal position, where positions start at one.
Optional<Column>	getColumnOptional(String name)	Gets the column of the provided name.
List<Column>	getColumns()	Gets all columns for this schema in their ordinal position order.
Set<? extends Table>	getExportedTables()	Gets the set of tables that depend on this table.
Set<? extends Table>	getImportedTables()	Gets the set of tables that this table depends on.
String	getName()
Index	getPrimaryKey()	Gets the primary key for this table or null if not found.
Schema	getSchema()
String	getTableType()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Table

protected Table(Schema schema,
 String name,
 String tableType)

Method Details

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Two tables are equal if they have the same schema name and table name.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getSchema

public Schema getSchema()

getName

public String getName()

getTableType

public String getTableType()

getColumnMap

public SortedMap<String,Column> getColumnMap()
                                      throws SQLException

Gets all columns for this schema keyed by unique name.

Throws:

SQLException

See Also:

• DatabaseMetaData.getColumns(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

getColumnOptional

public Optional<Column> getColumnOptional(String name)
                                   throws SQLException

Gets the column of the provided name.

Throws:

SQLException

getColumn

public Column getColumn(String name)
                 throws NoRowException,
SQLException

Gets the column of the provided name.

Throws:

NoRowException - if the column doesn't exist

SQLException

getColumns

public List<Column> getColumns()
                        throws SQLException

Gets all columns for this schema in their ordinal position order. Column with ordinal position one is at index zero.

Throws:

SQLException

See Also:

• getColumnMap()

getColumnOptional

public Optional<Column> getColumnOptional(int ordinalPosition)
                                   throws SQLException

Gets the column of the provided ordinal position, where positions start at one.

Throws:

SQLException

getColumn

public Column getColumn(int ordinalPosition)
                 throws NoRowException,
SQLException

Gets the column of the provided ordinal position, where positions start at one.

Throws:

NoRowException - if the column doesn't exist

SQLException

getPrimaryKey

public Index getPrimaryKey()
                    throws SQLException

Gets the primary key for this table or null if not found.

Throws:

SQLException

getImportedTables

public Set<? extends Table> getImportedTables()
                                       throws SQLException

Gets the set of tables that this table depends on.

This is based on DatabaseMetaData.getImportedKeys(java.lang.String, java.lang.String, java.lang.String).

Throws:

SQLException

getExportedTables

public Set<? extends Table> getExportedTables()
                                       throws SQLException

Gets the set of tables that depend on this table.

This is based on DatabaseMetaData.getExportedKeys(java.lang.String, java.lang.String, java.lang.String).

Throws:

SQLException