net.sf.farrago.cwm.relational
Interface RelationalPackage

All Superinterfaces:

RefBaseObject, RefPackage

All Known Implementing Classes:

RelationalPackage$Hib

public interface RelationalPackage
extends RefPackage

Relational package interface. The Relational package describes data accessible through a relational interface such as a native RDBMS, ODBC, or JDBC. The Relational package is based on the [SQL] standard section concerning RDBMS catalogs. The scope of the top level container, Catalog, is intended to cover all the tables a user can use in a single statement. A catalog is also the unit which is managed by a data resource. A catalog contains schemas which themselves contain tables. Tables are made of columns which have an associated data type. The Relational package uses constructs in the ObjectModel package to describe the object extensions added to SQL by the [SQL] standards. The Relational package also addresses the issues of indexing, primary keys and foreign keys by extending the corresponding concepts from the Foundation packages. The Relational package depends on the following packages: org.omg::CWM::ObjectModel::Behavioral org.omg::CWM::ObjectModel::Core org.omg::CWM::ObjectModel::Instance org.omg::CWM::Foundation::DataTypes org.omg::CWM::Foundation::KeysIndexes The Relational package references the ObjectModel and Foundation packages. OCL Representation of Relational Constraints [C-1] temporaryScope is valid only if the isTemporary is True. context Tabl e inv: self.temporaryScope.notEmpty implies self.isTemporary=True [C-2] checkOption is valid only if isReadOnly is False. context View inv: self.checkOption implies self.isReadOnly=False [C-3] scale is valid only if precision is specified. context Column inv: self.scale.nonEmpty implies self.precision.notEmpty

Note: This type should not be subclassed, implemented or directly instantiated by clients. It is generated from a MOF metamodel and implemented by Enki or MDR.

Method Summary

ColumnOptionsColumnSet	getColumnOptionsColumnSet() Returns ColumnOptionsColumnSet association proxy object.
ColumnRefStructuredType	getColumnRefStructuredType() Returns ColumnRefStructuredType association proxy object.
ColumnSetOfStructuredType	getColumnSetOfStructuredType() Returns ColumnSetOfStructuredType association proxy object.
CwmCatalogClass	getCwmCatalog() Returns CwmCatalog class proxy object.
CwmCheckConstraintClass	getCwmCheckConstraint() Returns CwmCheckConstraint class proxy object.
CwmColumnClass	getCwmColumn() Returns CwmColumn class proxy object.
CwmColumnSetClass	getCwmColumnSet() Returns CwmColumnSet class proxy object.
CwmColumnValueClass	getCwmColumnValue() Returns CwmColumnValue class proxy object.
CwmForeignKeyClass	getCwmForeignKey() Returns CwmForeignKey class proxy object.
CwmNamedColumnSetClass	getCwmNamedColumnSet() Returns CwmNamedColumnSet class proxy object.
CwmPrimaryKeyClass	getCwmPrimaryKey() Returns CwmPrimaryKey class proxy object.
CwmProcedureClass	getCwmProcedure() Returns CwmProcedure class proxy object.
CwmQueryColumnSetClass	getCwmQueryColumnSet() Returns CwmQueryColumnSet class proxy object.
CwmRowClass	getCwmRow() Returns CwmRow class proxy object.
CwmRowSetClass	getCwmRowSet() Returns CwmRowSet class proxy object.
CwmSchemaClass	getCwmSchema() Returns CwmSchema class proxy object.
CwmSqldataTypeClass	getCwmSqldataType() Returns CwmSqldataType class proxy object.
CwmSqldistinctTypeClass	getCwmSqldistinctType() Returns CwmSqldistinctType class proxy object.
CwmSqlindexClass	getCwmSqlindex() Returns CwmSqlindex class proxy object.
CwmSqlindexColumnClass	getCwmSqlindexColumn() Returns CwmSqlindexColumn class proxy object.
CwmSqlparameterClass	getCwmSqlparameter() Returns CwmSqlparameter class proxy object.
CwmSqlsimpleTypeClass	getCwmSqlsimpleType() Returns CwmSqlsimpleType class proxy object.
CwmSqlstructuredTypeClass	getCwmSqlstructuredType() Returns CwmSqlstructuredType class proxy object.
CwmTableClass	getCwmTable() Returns CwmTable class proxy object.
CwmTriggerClass	getCwmTrigger() Returns CwmTrigger class proxy object.
CwmUniqueConstraintClass	getCwmUniqueConstraint() Returns CwmUniqueConstraint class proxy object.
CwmViewClass	getCwmView() Returns CwmView class proxy object.
DistinctTypeHasSimpleType	getDistinctTypeHasSimpleType() Returns DistinctTypeHasSimpleType association proxy object.
EnumerationsPackage	getEnumerations() Returns nested package Enumerations.
TableOwningTrigger	getTableOwningTrigger() Returns TableOwningTrigger association proxy object.
TriggerUsingColumnSet	getTriggerUsingColumnSet() Returns TriggerUsingColumnSet association proxy object.

Methods inherited from interface javax.jmi.reflect.RefPackage

refAllAssociations, refAllClasses, refAllPackages, refAssociation, refAssociation, refClass, refClass, refCreateStruct, refCreateStruct, refDelete, refGetEnum, refGetEnum, refPackage, refPackage

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Method Detail

getEnumerations

EnumerationsPackage getEnumerations()

Returns nested package Enumerations. The enumerations and datatypes used in the Relational model.

Returns:

Proxy object related to nested package Enumerations.

getCwmCatalog

CwmCatalogClass getCwmCatalog()

Returns CwmCatalog class proxy object. A Catalog is the unit of logon and identification. It also identifies the scope of SQL statements: the tables contained in a catalog can be used in a single SQL statement.

Returns:

CwmCatalog class proxy object.

getCwmSchema

CwmSchemaClass getCwmSchema()

Returns CwmSchema class proxy object. A schema is a named collection of tables

Returns:

CwmSchema class proxy object.

getCwmColumnSet

CwmColumnSetClass getCwmColumnSet()

Returns CwmColumnSet class proxy object. A set of columns, representing either the result of a query, a view or a physical table.

Returns:

CwmColumnSet class proxy object.

getCwmNamedColumnSet

CwmNamedColumnSetClass getCwmNamedColumnSet()

Returns CwmNamedColumnSet class proxy object. A catalogued set of columns, which may be Table or View. Note for typed tables: It is assumed that the typed table will own a set of columns conforming to the type they are OF. This set of columns allows the manipulation of the table by products which ignore this [SQL] extension. It also allows the columns of type REF, to be copied to a column with a SCOPE reference.

Returns:

CwmNamedColumnSet class proxy object.

getCwmTable

CwmTableClass getCwmTable()

Returns CwmTable class proxy object. A materialized NamedColumnSet.

Returns:

CwmTable class proxy object.

getCwmView

CwmViewClass getCwmView()

Returns CwmView class proxy object. A view is a non-materialized set of rows, defined by the associated query.

Returns:

CwmView class proxy object.

getCwmQueryColumnSet

CwmQueryColumnSetClass getCwmQueryColumnSet()

Returns CwmQueryColumnSet class proxy object. The result set of a query.

Returns:

CwmQueryColumnSet class proxy object.

getCwmSqldataType

CwmSqldataTypeClass getCwmSqldataType()

Returns CwmSqldataType class proxy object. A SQLDataType is used to reference any datatype associated with a column

Returns:

CwmSqldataType class proxy object.

getCwmSqldistinctType

CwmSqldistinctTypeClass getCwmSqldistinctType()

Returns CwmSqldistinctType class proxy object. A datatype defined as a Distinct Type, per [SQL] standard.

Returns:

CwmSqldistinctType class proxy object.

getCwmSqlsimpleType

CwmSqlsimpleTypeClass getCwmSqlsimpleType()

Returns CwmSqlsimpleType class proxy object. A simple datatype used with an SQL column. Examples are Integer, Varchar, LOB, CLOB, etc...

Returns:

CwmSqlsimpleType class proxy object.

getCwmSqlstructuredType

CwmSqlstructuredTypeClass getCwmSqlstructuredType()

Returns CwmSqlstructuredType class proxy object. A Datatype defined as Structured Type, per [SQL] standard.

Returns:

CwmSqlstructuredType class proxy object.

getCwmColumn

CwmColumnClass getCwmColumn()

Returns CwmColumn class proxy object. A column in a result set, a view, a table, or an SQLStructuredType.

Returns:

CwmColumn class proxy object.

getCwmProcedure

CwmProcedureClass getCwmProcedure()

Returns CwmProcedure class proxy object. This class describes Relational DBMS Stored procedures and functions.

Returns:

CwmProcedure class proxy object.

getCwmTrigger

CwmTriggerClass getCwmTrigger()

Returns CwmTrigger class proxy object. An action run by the DBMS when specified events occur on the table owning the Trigger

Returns:

CwmTrigger class proxy object.

getCwmSqlindex

CwmSqlindexClass getCwmSqlindex()

Returns CwmSqlindex class proxy object. An Index on a table.

Returns:

CwmSqlindex class proxy object.

getCwmUniqueConstraint

CwmUniqueConstraintClass getCwmUniqueConstraint()

Returns CwmUniqueConstraint class proxy object. A condition to define uniqueness of rows in a table. An example of UniqueConstraint is a primary key

Returns:

CwmUniqueConstraint class proxy object.

getCwmForeignKey

CwmForeignKeyClass getCwmForeignKey()

Returns CwmForeignKey class proxy object. A Foreign Key associates columns from one table with columns of another table.

Returns:

CwmForeignKey class proxy object.

getCwmSqlindexColumn

CwmSqlindexColumnClass getCwmSqlindexColumn()

Returns CwmSqlindexColumn class proxy object. Associates an index with its columns. This is really an association (link) class. It is associated with one index and one column.

Returns:

CwmSqlindexColumn class proxy object.

getCwmPrimaryKey

CwmPrimaryKeyClass getCwmPrimaryKey()

Returns CwmPrimaryKey class proxy object. There is only one UniqueConstraint of type PrimaryKey per Table. It is implemented specifically by each RDBMS.

Returns:

CwmPrimaryKey class proxy object.

getCwmRow

CwmRowClass getCwmRow()

Returns CwmRow class proxy object. An instance of a ColumnSet.

Returns:

CwmRow class proxy object.

getCwmColumnValue

CwmColumnValueClass getCwmColumnValue()

Returns CwmColumnValue class proxy object. The value in a column instance.

Returns:

CwmColumnValue class proxy object.

getCwmCheckConstraint

CwmCheckConstraintClass getCwmCheckConstraint()

Returns CwmCheckConstraint class proxy object. A rule that specifies the values allowed in one or more columns of every row of a table.

Returns:

CwmCheckConstraint class proxy object.

getCwmRowSet

CwmRowSetClass getCwmRowSet()

Returns CwmRowSet class proxy object. Each instance of RowSet owns a collection of Row instances. The inherited association between Namespace (a superclass of Package) and ModelElement is used to contain Instances.

Returns:

CwmRowSet class proxy object.

getCwmSqlparameter

CwmSqlparameterClass getCwmSqlparameter()

Returns CwmSqlparameter class proxy object. Parameters of stored procedures.

Returns:

CwmSqlparameter class proxy object.

getTriggerUsingColumnSet

TriggerUsingColumnSet getTriggerUsingColumnSet()

Returns TriggerUsingColumnSet association proxy object. This associates a Trigger with the NamedColumnSets it uses in its expressions.

Returns:

TriggerUsingColumnSet association proxy object.

getTableOwningTrigger

TableOwningTrigger getTableOwningTrigger()

Returns TableOwningTrigger association proxy object. Associates a Table with its Triggers. The Trigger will be activated when an action is performed on the Table.

Returns:

TableOwningTrigger association proxy object.

getColumnSetOfStructuredType

ColumnSetOfStructuredType getColumnSetOfStructuredType()

Returns ColumnSetOfStructuredType association proxy object. Associates structured types with NamedColumnSets defined of this type.

Returns:

ColumnSetOfStructuredType association proxy object.

getColumnRefStructuredType

ColumnRefStructuredType getColumnRefStructuredType()

Returns ColumnRefStructuredType association proxy object. Associates Columns of a StructuredType with the Type they reference in the REF clause

Returns:

ColumnRefStructuredType association proxy object.

getColumnOptionsColumnSet

ColumnOptionsColumnSet getColumnOptionsColumnSet()

Returns ColumnOptionsColumnSet association proxy object. Associates Columns with NamedColumnSets they reference in their OPTIONS clause.

Returns:

ColumnOptionsColumnSet association proxy object.

getDistinctTypeHasSimpleType

DistinctTypeHasSimpleType getDistinctTypeHasSimpleType()

Returns DistinctTypeHasSimpleType association proxy object.

Returns:

DistinctTypeHasSimpleType association proxy object.