org.apache.ws.jaxme.sqls
public interface Table
Abstract description of a table.
Nested Class Summary | |
---|---|
static interface | Table.Name |
Method Summary | |
---|---|
Column | getColumn(Column.Name name) Returns the column with the given name or null, if no such column exists. |
Column | getColumn(String name) Returns the column with the given name or null, if no such column exists. |
Iterator | getColumns() Returns the table columns. |
DeleteStatement | getDeleteStatement() Returns an UPDATE statement for updating a column in the table. |
Iterator | getForeignKeys() Returns an {@link Iterator} to the foreign keys defined on the table. |
Iterator | getIndexes() Returns an {@link Iterator} to the indexes defined on the table. |
InsertStatement | getInsertStatement() Returns an INSERT statement for filling all the values. |
Table.Name | getName() Returns the table name. |
Index | getPrimaryKey() Returns the tables primary key, if any, or null, if the table doesn't have a primary key. |
String | getQName() Returns the tables qualified name, which is
|
Schema | getSchema() Returns the table schema. |
SelectStatement | getSelectStatement() Returns a SELECT statement for selecting all the columns. |
UpdateStatement | getUpdateStatement() Returns an UPDATE statement for updating a column in the table. |
Column | newColumn(Column.Name name, Column.Type pType) Creates a new column. |
Column | newColumn(String name, Column.Type pType) Creates a new column. |
ForeignKey | newForeignKey(Table pReferencedTable) Creates a new foreign key referencing the given table. |
Index | newIndex() Creates a new, non-unique index on the table. |
Index | newKey() Creates a new, unique index on the table. |
Index | newPrimaryKey() Creates a new primary key on the table. |
Returns the column with the given name or null, if no such column exists.
Returns the column with the given name or null, if no such column exists.
Returns the table columns.
Returns an UPDATE statement for updating a column in the table.
In other words: If the table FOO has the primary key columns A and B,
then the statement DELETE FROM FOO WHERE A = ? AND B = ?
will be returned.
Throws: IllegalStateException The table doesn't have a primary key.
See Also: newDeleteStatement
Returns an {@link Iterator} to the foreign keys defined on the table.
Returns an {@link Iterator} to the indexes defined on the table. This iterator includes the primary key, if any.
Returns an INSERT statement for filling all the values. In
other words: If the table FOO has the columns A, B, and C,
then the statement INSERT INTO FOO (A,B,C) VALUES (?, ?, ?)
will be returned.
See Also: newInsertStatement
Returns the table name.
Returns the tables primary key, if any, or null, if the table doesn't have a primary key.
Returns the tables qualified name, which is
getSchema().getName() + "." + getName()
. If the
schema is the default schema, returns getName()
.
Returns the table schema.
Returns a SELECT statement for selecting all the columns. In
other words: If the table FOO has the columns A, B, and C,
then the statement SELECT A, B, C FROM FOO
will
be returned.
See Also: newSelectStatement
Returns an UPDATE statement for updating a column in the table.
In other words: If the table FOO has the columns A, B, C and D
with the primary key columns A and B, then the statement
UPDATE FOO SET C = ?, D = ? WHERE A = ? AND B = ?
will be returned.
Throws: IllegalStateException The table doesn't have a primary key.
See Also: newUpdateStatement
Creates a new column.
Creates a new column.
Creates a new foreign key referencing the given table.
Creates a new, non-unique index on the table.
Creates a new, unique index on the table.
Creates a new primary key on the table.
Throws: IllegalStateException A primary key has already been created.