fedora.server.utilities
Class TableSpec

java.lang.Object
  fedora.server.utilities.TableSpec

public class TableSpec

extends java.lang.Object

Title: TableSpec.java

Description: A holder of table specification information that helps in producing RDBMS-generic DDL "CREATE TABLE" commands.

An application constructs a TableSpec without regard to the underlying database kind, and then the TableSpec is converted to a DB-specific CREATE TABLE DDL command by a DDLConverter before the command is issued via JDBC.

-----------------------------------------------------------------------------

License and Copyright: The contents of this file are subject to the Mozilla Public License Version 1.1 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/.

Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.

The entire file consists of original code. Copyright © 2002-2005 by The Rector and Visitors of the University of Virginia and Cornell University. All rights reserved.

-----------------------------------------------------------------------------

Version:

$Id: TableSpec.java,v 1.8 2005/01/11 20:06:09 cwilper Exp $

Author:

cwilper@cs.cornell.edu

Constructor Summary

TableSpec(java.lang.String name, java.util.List columnSpecs, java.lang.String primaryColumnName)
Constructs a TableSpec given a name, a set of ColumnSpecs, and the name of the primary key column.

TableSpec(java.lang.String name, java.util.List columnSpecs, java.lang.String primaryColumnName, java.lang.String type)
Constructs a TableSpec given a name, a set of ColumnSpecs, the name of the primary key column, and a table type.

Method Summary

void	assertConsistent() Ensures that the TableSpec is internally consistent.
java.util.Iterator	columnSpecIterator() Gets an iterator over the columns.
java.lang.String	getName() Gets the name of the table.
java.lang.String	getPrimaryColumnName() Gets the name of the primary key column.
static java.util.List	getTableSpecs(java.io.InputStream in) Gets a TableSpec for each table element in the stream, where the stream contains a valid XML document containing one or more table elements, wrapped in the root element.
java.lang.String	getType() Gets the type of the table.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableSpec

public TableSpec(java.lang.String name,
                 java.util.List columnSpecs,
                 java.lang.String primaryColumnName)
          throws InconsistentTableSpecException

Constructs a TableSpec given a name, a set of ColumnSpecs, and the name of the primary key column.

Parameters:

name - The table name.

columnSpecs - ColumnSpec objects describing columns in the table.

primaryColumnName - The column that is the primary key for the table.

Throws:

InconsistentTableSpecException - if inconsistencies are detected in table specifications.

TableSpec

public TableSpec(java.lang.String name,
                 java.util.List columnSpecs,
                 java.lang.String primaryColumnName,
                 java.lang.String type)
          throws InconsistentTableSpecException

Constructs a TableSpec given a name, a set of ColumnSpecs, the name of the primary key column, and a table type. Table type specification is not supported by all RDBMS software, and is usually software-specific. When a tableSpec is used to create a table, if the type is understood it is used. Otherwise it is ignored.

Parameters:

name - The table name.

columnSpecs - ColumnSpec objects describing columns in the table.

primaryColumnName - The column that is the primary key for the table.

type - The table type.

Throws:

InconsistentTableSpecException - if inconsistencies are detected in table specifications.

Method Detail

getTableSpecs

public static java.util.List getTableSpecs(java.io.InputStream in)
                                    throws InconsistentTableSpecException,
                                           java.io.IOException

Gets a TableSpec for each table element in the stream, where the stream contains a valid XML document containing one or more table elements, wrapped in the root element.

Input is of the form:

 <database>
   <table name="tableName" primaryKey="primaryColumnName" type="tableType">
     <column name="columnName"
                type="typeSpec"
                autoIncrement="isAutoIncremented"
                index="indexName"
                notNull="isNotNull"
                unique="isUnique"
                default="defaultValue"
                foreignKey="foreignTableName.columnName onDeleteAction"/>
   </table>
 </database>
 

About the attributes:

• tableName - The desired name of the table.
• primaryColumnName - Identifies column that is the primary key for the table. A column that is a primary key must be notNull, and can't be a foreign key.
• type - The table type, which is RDBMS-specific. See TableSpec(String, Set, String, String) for detail.
• columnName - The name of the column.
• typeSpec - The value type of the column. For instance, varchar(255). This is not checked for validity. See ColumnSpec javadoc for detail.
• isAutoIncremented - (true|false) Whether values in the column should be automatically generated by the database upon insert. This requires that the type be some numeric variant, and is RDBMS-specific. NUMERIC will generally work.
• indexName - Specifies that an index should be created on this column and provides the column name.
• isNotNull - (true|false) Whether input should be limited to actual values.
• isUnique - (true|false) Whether input should be limited such that all values in the column are unique.
• default - The value to be used when inserts don't specify a value for the column. This cannot be specified with autoIncrement true.
• foreignTableName.column - Specifies that this is a foreign key column and identifies the (primary key) column in the database containing the rows that values in this column refer to. This cannot be specified with autoIncrement true.
• onDeleteAction - Optionally specifies a "CASCADE" or "SET NULL" action to be taken on matching rows in this table when a row from the parent (foreign) table is deleted. If "CASCADE", matching rows in this table are automatically deleted. If "SET NULL", this column's value will be set to NULL for all matching rows. This value is not checked for validity.

Parameters:

in - The xml-encoded table specs.

Returns:

TableSpec objects.

Throws:

InconsistentTableSpecException - if inconsistencies are detected in table specifications.

java.io.IOException - if an IO error occurs.

assertConsistent

public void assertConsistent()
                      throws InconsistentTableSpecException

Ensures that the TableSpec is internally consistent.

Throws:

InconsistentTableSpecException - If it's inconsistent.

getName

public java.lang.String getName()

Gets the name of the table.

Returns:

The name.

getPrimaryColumnName

public java.lang.String getPrimaryColumnName()

Gets the name of the primary key column.

Returns:

The name.

getType

public java.lang.String getType()

Gets the type of the table.

Returns:

The name.

columnSpecIterator

public java.util.Iterator columnSpecIterator()

Gets an iterator over the columns.

Returns:

An Iterator over ColumnSpec objects.