public class TableDeclaration
extends java.lang.Object
This represents the declaration of a table, comprised of ColumnDeclaration objects. This object can be used to create, drop, or check the existence of the table.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Constructor and Description |
---|
TableDeclaration(java.lang.String pName)
Constructs a new TableDeclaration
|
Modifier and Type | Method and Description |
---|---|
void |
addColumn(ColumnDeclaration pColumn)
Adds a column declarations to the list of columns for the table.
|
void |
createTable(java.sql.Connection pConnection,
TypeInfoMap pTypeInfoMap)
Executes the CREATE TABLE statement needed to create this table
with the specified column declarations.
|
void |
dropTable(java.sql.Connection pConnection)
Executes the DROP TABLE statement needed to remove the table with
this TableDeclaration's name.
|
ColumnDeclaration |
getColumn(int pIndex)
Returns the ColumnDeclaration at the specified index
|
ColumnDeclaration |
getColumn(java.lang.String pColumnName)
Returns the ColumnDeclaration for the given name, or null if none
found.
|
int |
getColumnCount()
Returns the number of columns added to the table
|
java.lang.String |
getCreateTableStatement(java.sql.Connection pConnection,
TypeInfoMap pTypeInfoMap)
Returns the CREATE TABLE statement that would be used to create
this table.
|
java.lang.String |
getName()
Returns the name of the table
|
boolean |
isCreated(java.sql.Connection pConnection)
Returns true if there is a table with the same name as this
TableDeclaration.
|
public static final java.lang.String CLASS_VERSION
public TableDeclaration(java.lang.String pName)
pName
- the name of the tablepublic void addColumn(ColumnDeclaration pColumn)
public java.lang.String getName()
public int getColumnCount()
public ColumnDeclaration getColumn(int pIndex)
public ColumnDeclaration getColumn(java.lang.String pColumnName)
public void createTable(java.sql.Connection pConnection, TypeInfoMap pTypeInfoMap) throws java.sql.SQLException
pConnection
- the Connection to be used to create the tablepTypeInfoMap
- the TypeInfoMap mapping JDBC types to
database-specific typesjava.sql.SQLException
- if a SQL error occurredpublic java.lang.String getCreateTableStatement(java.sql.Connection pConnection, TypeInfoMap pTypeInfoMap) throws java.sql.SQLException
java.sql.SQLException
public void dropTable(java.sql.Connection pConnection) throws java.sql.SQLException
pConnection
- the Connection to be used to drop the tablejava.sql.SQLException
- if a SQL error occurredpublic boolean isCreated(java.sql.Connection pConnection) throws java.sql.SQLException
pConnection
- the Connection to be used to test existence of
the tablejava.sql.SQLException
- if a SQL error occurred