com.ibm.websphere.sdo.mediator.jdbc.metadata
Interface Table


public interface Table

A Table object provides a description of a database table and how it maps into a DataObject


Method Summary
 Column addBigDecimalColumn(java.lang.String name)
          Create and add a Column of type BigDecimal with the given name
 Column addBlobColumn(java.lang.String name)
          Create and add a Column of type Blob with the given name
 Column addBooleanColumn(java.lang.String name)
          Create and add a Column of type Boolean with the given name
 Column addByteColumn(java.lang.String name)
          Create and add a Column of type Byte with the given name
 Column addBytesColumn(java.lang.String name)
          Create and add a Column of type Bytes with the given name
 Column addClobColumn(java.lang.String name)
          Create and add a Column of type Clob with the given name
 Column addColumn(java.lang.String name, int type)
          Create and add a Column object to this Table with the given name and type.
 Column addColumn(java.lang.String name, int type, boolean isNullable)
          Create and add a Column object to this table with the given name, type, and nullability
 Column addDateColumn(java.lang.String name)
          Create and add a Column of type Date with the given name
 Column addDoubleColumn(java.lang.String name)
          Create and add a Column of type Double with the given name
 Column addFloatColumn(java.lang.String name)
          Create and add a Column of type Float with the given name
 Key addForeignKey(Column column)
          Create and add a Foreign Key to this Table consisting of the given Column
 Column addIntegerColumn(java.lang.String name)
          Create and add a Column of type Integer with the given name
 Column addLongColumn(java.lang.String name)
          Create and add a Column of type Long with the given name
 Column addShortColumn(java.lang.String name)
          Create and add a Column of type Short with the given name
 Column addStringColumn(java.lang.String name)
          Create and add a Column of type String with the given name
 Column addTimeColumn(java.lang.String name)
          Create and add a Column of type Time with the given name
 Column addTimestampColumn(java.lang.String name)
          Create and add a Column of type Timestamp with the given name
 void beRoot()
          Make this Table be the root Table in the Metadata.
 Column getCollisionColumn()
          Returns the Column object used for optimistic concurrency control
 Column getColumn(java.lang.String columnName)
          Returns the Column object with the given name
 org.eclipse.emf.common.util.EList getColumns()
          Get the columns contained in this table
 Filter getFilter()
          Get the filter applied to this table
 org.eclipse.emf.common.util.EList getForeignKeys()
          Get the foreign keys for this table
 Metadata getMetadata()
          Returns the @link com.ibm.websphere.sdo.mediator.jdbc.metadata.Metadata object that contains this Table
 java.lang.String getName()
          Get the name of the database table
 Key getPrimaryKey()
          Get the primary key for this table
 java.lang.String getPropertyName()
          Get the Property Name attribute The Property Name determines the name used in the SDO representation of this table.
 java.lang.String getSchemaName()
          Get the Schema Name attribute The Schema Name attribute specifies the database schema that contains this table.
 boolean isExternal()
          If a Table is defined as external, it will not be included in the DataGraph constructed by a generated query.
 java.lang.String qualifiedName()
          Returns the name of this table qualified with the schema name, if applicable.
 void setCollisionColumn(Column value)
          Sets the value of the 'Collision Column' reference.
 void setExternal(boolean value)
          Sets the value of the 'External' attribute.
 void setFilter(Filter value)
          Sets the value of the 'Filter' containment reference.
 void setMetadata(Metadata value)
          Sets the value of the 'Metadata' container reference.
 void setName(java.lang.String value)
          Sets the value of the 'Name' attribute.
 void setPrimaryKey(Column column)
          Set the value of the Primary Key attribute to the specified Column
 void setPrimaryKey(Key value)
          Sets the value of the 'Primary Key' containment reference.
 void setPrimaryKey(java.util.List columns)
          Set the value of the Primary Key attribute to the specified List of Columns
 void setPropertyName(java.lang.String value)
          Sets the value of the 'Property Name' attribute.
 void setSchemaName(java.lang.String value)
          Sets the value of the 'Schema Name' attribute.
 

Method Detail

getPropertyName

public java.lang.String getPropertyName()
Get the Property Name attribute The Property Name determines the name used in the SDO representation of this table. If the Property Name attribute is not specified, it will default to the value of getName()

Returns:
the property name

setPropertyName

public void setPropertyName(java.lang.String value)
Sets the value of the 'Property Name' attribute.

Parameters:
value - the new value of the 'Property Name' attribute.
See Also:
getPropertyName()

getSchemaName

public java.lang.String getSchemaName()
Get the Schema Name attribute The Schema Name attribute specifies the database schema that contains this table.

Returns:
the schema name

setSchemaName

public void setSchemaName(java.lang.String value)
Sets the value of the 'Schema Name' attribute.

Parameters:
value - the new value of the 'Schema Name' attribute.
See Also:
getSchemaName()

qualifiedName

public java.lang.String qualifiedName()
Returns the name of this table qualified with the schema name, if applicable.

Returns:
the qualified name

getName

public java.lang.String getName()
Get the name of the database table

Returns:
the name

setName

public void setName(java.lang.String value)
Sets the value of the 'Name' attribute.

Parameters:
value - the new value of the 'Name' attribute.
See Also:
getName()

getPrimaryKey

public Key getPrimaryKey()
Get the primary key for this table

Returns:
the primary key

setPrimaryKey

public void setPrimaryKey(Key value)
Sets the value of the 'Primary Key' containment reference.

Parameters:
value - the new value of the 'Primary Key' containment reference.
See Also:
getPrimaryKey()

getForeignKeys

public org.eclipse.emf.common.util.EList getForeignKeys()
Get the foreign keys for this table

Returns:
the list of foreign keys

getColumns

public org.eclipse.emf.common.util.EList getColumns()
Get the columns contained in this table

Returns:
the list of columns

getColumn

public Column getColumn(java.lang.String columnName)
Returns the Column object with the given name

Parameters:
columnName - the name of the Column
Returns:
the Column

getFilter

public Filter getFilter()
Get the filter applied to this table

Returns:
the filter

setFilter

public void setFilter(Filter value)
Sets the value of the 'Filter' containment reference.

Parameters:
value - the new value of the 'Filter' containment reference.
See Also:
getFilter()

getMetadata

public Metadata getMetadata()
Returns the @link com.ibm.websphere.sdo.mediator.jdbc.metadata.Metadata object that contains this Table

Returns:
the metadata

setMetadata

public void setMetadata(Metadata value)
Sets the value of the 'Metadata' container reference.

Parameters:
value - the new value of the 'Metadata' container reference.
See Also:
getMetadata()

getCollisionColumn

public Column getCollisionColumn()
Returns the Column object used for optimistic concurrency control

Returns:
the collision column

setCollisionColumn

public void setCollisionColumn(Column value)
Sets the value of the 'Collision Column' reference.

Parameters:
value - the new value of the 'Collision Column' reference.
See Also:
getCollisionColumn()

isExternal

public boolean isExternal()
If a Table is defined as external, it will not be included in the DataGraph constructed by a generated query.

Returns:
the value of the External attribute

setExternal

public void setExternal(boolean value)
Sets the value of the 'External' attribute.

Parameters:
value - the new value of the 'External' attribute.
See Also:
isExternal()

addColumn

public Column addColumn(java.lang.String name,
                        int type,
                        boolean isNullable)
Create and add a Column object to this table with the given name, type, and nullability

Parameters:
name -
type -
isNullable -
Returns:
the new column

addColumn

public Column addColumn(java.lang.String name,
                        int type)
Create and add a Column object to this Table with the given name and type.

Parameters:
name -
type -
Returns:
the new column

addBooleanColumn

public Column addBooleanColumn(java.lang.String name)
Create and add a Column of type Boolean with the given name

Parameters:
name -
Returns:
the new column

addByteColumn

public Column addByteColumn(java.lang.String name)
Create and add a Column of type Byte with the given name

Parameters:
name -
Returns:
the new column

addShortColumn

public Column addShortColumn(java.lang.String name)
Create and add a Column of type Short with the given name

Parameters:
name -
Returns:
the new column

addStringColumn

public Column addStringColumn(java.lang.String name)
Create and add a Column of type String with the given name

Parameters:
name -
Returns:
the new column

addIntegerColumn

public Column addIntegerColumn(java.lang.String name)
Create and add a Column of type Integer with the given name

Parameters:
name -
Returns:
the new column

addDoubleColumn

public Column addDoubleColumn(java.lang.String name)
Create and add a Column of type Double with the given name

Parameters:
name -
Returns:
the new column

addLongColumn

public Column addLongColumn(java.lang.String name)
Create and add a Column of type Long with the given name

Parameters:
name -
Returns:
the new column

addFloatColumn

public Column addFloatColumn(java.lang.String name)
Create and add a Column of type Float with the given name

Parameters:
name -
Returns:
the new column

addBigDecimalColumn

public Column addBigDecimalColumn(java.lang.String name)
Create and add a Column of type BigDecimal with the given name

Parameters:
name -
Returns:
the new column

addDateColumn

public Column addDateColumn(java.lang.String name)
Create and add a Column of type Date with the given name

Parameters:
name -
Returns:
the new column

addTimeColumn

public Column addTimeColumn(java.lang.String name)
Create and add a Column of type Time with the given name

Parameters:
name -
Returns:
the new column

addTimestampColumn

public Column addTimestampColumn(java.lang.String name)
Create and add a Column of type Timestamp with the given name

Parameters:
name -
Returns:
the new column

addBlobColumn

public Column addBlobColumn(java.lang.String name)
Create and add a Column of type Blob with the given name

Parameters:
name -
Returns:
the new column

addClobColumn

public Column addClobColumn(java.lang.String name)
Create and add a Column of type Clob with the given name

Parameters:
name -
Returns:
the new column

addBytesColumn

public Column addBytesColumn(java.lang.String name)
Create and add a Column of type Bytes with the given name

Parameters:
name -
Returns:
the new column

setPrimaryKey

public void setPrimaryKey(Column column)
Set the value of the Primary Key attribute to the specified Column

Parameters:
column -

setPrimaryKey

public void setPrimaryKey(java.util.List columns)
Set the value of the Primary Key attribute to the specified List of Columns

Parameters:
columns -

addForeignKey

public Key addForeignKey(Column column)
Create and add a Foreign Key to this Table consisting of the given Column

Parameters:
column -
Returns:
the new Key

beRoot

public void beRoot()
Make this Table be the root Table in the Metadata. This affects the query generated by the JDBC Data Mediator Service, but does not affect the shape of the DataGraph