org.kepler.util.sql

Class Table

java.lang.Object

org.kepler.util.sql.Table

public class Table
extends java.lang.Object

A generic representation of an SQL table. A Table can contain columns, constraints, and foreign keys.

Author:

Daniel Crawl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Table.ColumnConstraint
protected static class	Table.ForeignKey A class for foreign keys.
static class	Table.IndexType Index types.

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	columnNames() Get the column names.
java.util.Set<Column>	columns() Get the columns.
java.util.Set<java.lang.String>	constraintNames() Get the constraint names.
java.util.Set<java.lang.String>	foreignKeyNames() Get the foreign key names.
Column	getColumn(java.lang.String name) Get a specific column.
Table.ColumnConstraint	getConstraint(java.lang.String name) Get a specific constraint.
Table.ForeignKey	getForeignKey(java.lang.String name) Get a specific foreign key.
java.lang.String	getIndexColumns(java.lang.String indexName) Get the column(s) for an index.
Table.IndexType	getIndexType(java.lang.String name) Get the index type.
java.lang.String	getName() Get the table name.
java.util.Set<java.lang.String>	indexes() Get the indexes.
boolean	isForeignKey(java.lang.String columnName) Returns true if column references another table.
void	putColumn(java.lang.String name, Column column) Add a new or replace an existing column with no foreign key or index.
void	putColumn(java.lang.String name, Column column, java.lang.String defaultValue) Add a new or replace an existing column with a default value.
void	putColumn(java.lang.String columnName, Column column, java.lang.String fkTable, java.lang.String fkColumn) Add a new or replace an existing column.
void	putColumn(java.lang.String columnName, Column column, java.lang.String fkTable, java.lang.String fkColumn, java.lang.String defaultValue) Add a new or replace an existing column.
void	putConstraint(java.lang.String constraintName, java.lang.String columnName, java.lang.String constraintValue) Add a new or replace an existing constraint.
void	putForeignKey(java.lang.String fkName, java.lang.String columnName, java.lang.String fkTable, java.lang.String fkColumn) Add a new or replace an existing foreign key.
void	putIndex(java.lang.String columnName) Add an index on one or more columns.
void	putIndex(java.lang.String indexName, java.lang.String columnName) Add a new or replace an existing index.
void	putIndex(java.lang.String indexName, java.lang.String columnName, Table.IndexType type) Add a new or replace an index index specifying the type of index.
void	removeColumn(java.lang.String columnName) Remove a column.
void	removeConstraint(java.lang.String name) Remove a constraint.
void	removeForeignKey(java.lang.String name) Remove a foreign key.
java.lang.String	toString() Get a string representation of the table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

columns

public java.util.Set<Column> columns()

Get the columns.

columnNames

public java.util.Set<java.lang.String> columnNames()

Get the column names.

constraintNames

public java.util.Set<java.lang.String> constraintNames()

Get the constraint names.

foreignKeyNames

public java.util.Set<java.lang.String> foreignKeyNames()

Get the foreign key names.

getColumn

public Column getColumn(java.lang.String name)

Get a specific column.

getConstraint

public Table.ColumnConstraint getConstraint(java.lang.String name)

Get a specific constraint.

getForeignKey

public Table.ForeignKey getForeignKey(java.lang.String name)

Get a specific foreign key.

getIndexColumns

public java.lang.String getIndexColumns(java.lang.String indexName)

Get the column(s) for an index.

getIndexType

public Table.IndexType getIndexType(java.lang.String name)

Get the index type.

getName

public java.lang.String getName()

Get the table name.

isForeignKey

public boolean isForeignKey(java.lang.String columnName)

Returns true if column references another table.

indexes

public java.util.Set<java.lang.String> indexes()

Get the indexes.

putColumn

public void putColumn(java.lang.String name,
                      Column column)

Add a new or replace an existing column with no foreign key or index.

putColumn

public void putColumn(java.lang.String name,
                      Column column,
                      java.lang.String defaultValue)

Add a new or replace an existing column with a default value.

putColumn

public void putColumn(java.lang.String columnName,
                      Column column,
                      java.lang.String fkTable,
                      java.lang.String fkColumn)

Add a new or replace an existing column.

Parameters:

name - the column name

column - the column type

fkTable - the referenced table in foreign key

fkColumn - the referenced column in foreign key

putColumn

public void putColumn(java.lang.String columnName,
                      Column column,
                      java.lang.String fkTable,
                      java.lang.String fkColumn,
                      java.lang.String defaultValue)

Add a new or replace an existing column.

Parameters:

name - the column name

column - the column type

fkTable - the referenced table in foreign key

fkColumn - the referenced column in foreign key

defaultValue - the default value

putConstraint

public void putConstraint(java.lang.String constraintName,
                          java.lang.String columnName,
                          java.lang.String constraintValue)

Add a new or replace an existing constraint.

putIndex

public void putIndex(java.lang.String columnName)

Add an index on one or more columns.

putIndex

public void putIndex(java.lang.String indexName,
                     java.lang.String columnName)

Add a new or replace an existing index.

putIndex

public void putIndex(java.lang.String indexName,
                     java.lang.String columnName,
                     Table.IndexType type)

Add a new or replace an index index specifying the type of index.

putForeignKey

public void putForeignKey(java.lang.String fkName,
                          java.lang.String columnName,
                          java.lang.String fkTable,
                          java.lang.String fkColumn)

Add a new or replace an existing foreign key.

removeColumn

public void removeColumn(java.lang.String columnName)

Remove a column.

removeConstraint

public void removeConstraint(java.lang.String name)

Remove a constraint.

removeForeignKey

public void removeForeignKey(java.lang.String name)

Remove a foreign key.

toString

public java.lang.String toString()

Get a string representation of the table.

Overrides:

toString in class java.lang.Object