Package com.invirgance.convirgance.jdbc.schema

Class Table

java.lang.Object

com.invirgance.convirgance.jdbc.schema.TabularStructure

com.invirgance.convirgance.jdbc.schema.Table

All Implemented Interfaces:

NamedSchema, Iterable<com.invirgance.convirgance.json.JSONObject>

public class Table
extends TabularStructure
implements Iterable<com.invirgance.convirgance.json.JSONObject>

For working with table metadata. Used when creating logic that involves table metadata, such as comparing table equality, retrieving primary keys/foreign keys. To get a table object use DatabaseSchemaLayout.getAllTables()

Author:

jbanes

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Table.ForeignKey
class	Table.PrimaryKey

Method Summary

Modifier and Type	Method	Description
Table.ForeignKey[]	getForeignKeys()	Returns all the ForeignKeys of this table.
Table.PrimaryKey	getPrimaryKey()	Returns the PrimaryKey of this table.
Iterator<com.invirgance.convirgance.json.JSONObject>	iterator()
SelectStatement	select()	Returns a SelectStatement based on this table.

Methods inherited from class com.invirgance.convirgance.jdbc.schema.TabularStructure

equals, getColumn, getColumns, getName, getQuotedName, getSchema, getType, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

getPrimaryKey

public Table.PrimaryKey getPrimaryKey()

Returns the PrimaryKey of this table.

Returns:

PrimaryKey

getForeignKeys

public Table.ForeignKey[] getForeignKeys()

Returns all the ForeignKeys of this table.

Returns:

an array of ForeignKeys.

select

public SelectStatement select()

Returns a SelectStatement based on this table.

Returns:

A SelectStatement.

iterator

public Iterator<com.invirgance.convirgance.json.JSONObject> iterator()

Specified by:

iterator in interface Iterable<com.invirgance.convirgance.json.JSONObject>