org.eclipse.datatools.modelbase.sql.tables
Interface BaseTable

All Superinterfaces:
SQLObject, Table
All Known Subinterfaces:
PersistentTable, TemporaryTable
All Known Implementing Classes:
BaseTableImpl, PersistentTableImpl, TemporaryTableImpl

public interface BaseTable
extends Table

A representation of the model object 'Base Table'. 4.14 Tables A table is a collection of rows having one or more columns. [...] A table is either a base table, a derived table, or a transient table. A base table is either a persistent base table, a global temporary table, a created local temporary table, or a declared local temporary table. All base tables are updatable. Every column of a base table is an updatable column. Derived tables and transient tables are either updatable or not updatable. The operations of update and delete are permitted for updatable tables, subject to constraining Access Rules. Some updatable tables, including all base tables whose row type is not derived from a user-defined type that is not instantiable, are also insertable-into, in which case the operation of insert is also permitted, again subject to Access Rules. A base table descriptor describes a base table. In addition to the components of every table descriptor, a base table descriptor includes: - The name of the base table. - An indication of whether the table is a persistent base table, a global temporary table, a created local temporary table, or a declared local temporary table. - If the base table is a global temporary table, a created local temporary table, or a declared local temporary table, then an indication of whether ON COMMIT PRESERVE ROWS was specified or ON COMMIT DELETE ROWS was specified or implied. - The descriptor of each table constraint specified for the table. - A non-empty set of functional dependencies, according to the rules given in Subclause 4.18, "Functional dependencies". - A non-empty set of candidate keys, according to the rules of Subclause 4.19, "Candidate keys". - A preferred candidate key, which may or may not be additionally designated the primary key, according to the Rules in Subclause 4.18, "Functional dependencies".

The following features are supported:

See Also:
SQLTablesPackage.getBaseTable()

Method Summary
 EList getConstraints()
          Returns the value of the 'Constraints' containment reference list.
 java.util.List getForeignKeys()
           
 PrimaryKey getPrimaryKey()
           
 EList getReferencingForeignKeys()
          Returns the value of the 'Referencing Foreign Keys' reference list.
 java.util.List getUniqueConstraints()
           
 
Methods inherited from interface org.eclipse.datatools.modelbase.sql.tables.Table
getColumns, getIndex, getSchema, getSelfRefColumnGeneration, getSubtables, getSupertable, getTriggers, getUdt, isInsertable, isUpdatable, setSchema, setSelfRefColumnGeneration, setSupertable, setUdt
 
Methods inherited from interface org.eclipse.datatools.modelbase.sql.schema.SQLObject
addEAnnotation, addEAnnotationDetail, getDependencies, getDescription, getEAnnotation, getEAnnotationDetail, getLabel, removeEAnnotationDetail, setAnnotationDetail, setDescription, setLabel
 

Method Detail

getConstraints

public EList getConstraints()
Returns the value of the 'Constraints' containment reference list. The list contents are of type TableConstraint. It is bidirectional and its opposite is 'Base Table'.

If the meaning of the 'Constraints' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Constraints' containment reference list.
See Also:
SQLTablesPackage.getBaseTable_Constraints(), TableConstraint.getBaseTable()

getReferencingForeignKeys

public EList getReferencingForeignKeys()
Returns the value of the 'Referencing Foreign Keys' reference list. The list contents are of type ForeignKey. It is bidirectional and its opposite is 'Referenced Table'.

If the meaning of the 'Referencing Foreign Keys' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Referencing Foreign Keys' reference list.
See Also:
SQLTablesPackage.getBaseTable_ReferencingForeignKeys(), ForeignKey.getReferencedTable()

getUniqueConstraints

public java.util.List getUniqueConstraints()


getForeignKeys

public java.util.List getForeignKeys()


getPrimaryKey

public PrimaryKey getPrimaryKey()



Copyright © 2006 Actuate, IBM Corporation, Sybase, Inc. and others. All rights reserved.