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

Interface Table


  1. public interface Table
A Table object provides a description of a database table and how it maps into a DataObject

Method Summary

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

Method Detail

getPropertyName

  1. 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

  1. 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:

getSchemaName

  1. 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

  1. 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:

qualifiedName

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

getName

  1. java.lang.String getName()
Get the name of the database table
Returns:
the name

setName

  1. void setName(java.lang.String value)
Sets the value of the ' Name' attribute.
Parameters:
value - the new value of the 'Name' attribute.
See Also:

getPrimaryKey

  1. Key getPrimaryKey()
Get the primary key for this table
Returns:
the primary key

setPrimaryKey

  1. 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:

getForeignKeys

  1. org.eclipse.emf.common.util.EList getForeignKeys( )
Get the foreign keys for this table
Returns:
the list of foreign keys

getColumns

  1. org.eclipse.emf.common.util.EList getColumns( )
Get the columns contained in this table
Returns:
the list of columns

getColumn

  1. 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

  1. Filter getFilter()
Get the filter applied to this table
Returns:
the filter

setFilter

  1. void setFilter(Filter value)
Sets the value of the ' Filter' containment reference.
Parameters:
value - the new value of the 'Filter' containment reference.
See Also:

getMetadata

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

setMetadata

  1. void setMetadata(Metadata value)
Sets the value of the ' Metadata' container reference.
Parameters:
value - the new value of the 'Metadata' container reference.
See Also:

getCollisionColumn

  1. Column getCollisionColumn()
Returns the Column object used for optimistic concurrency control
Returns:
the collision column

setCollisionColumn

  1. void setCollisionColumn(Column value)
Sets the value of the ' Collision Column' reference.
Parameters:
value - the new value of the 'Collision Column' reference.
See Also:

isExternal

  1. 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

  1. void setExternal(boolean value)
Sets the value of the ' External' attribute.
Parameters:
value - the new value of the 'External' attribute.
See Also:

addColumn

  1. Column addColumn(java.lang.String name,
  2. int type,
  3. 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

  1. Column addColumn(java.lang.String name,
  2. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. void setPrimaryKey(Column column)
Set the value of the Primary Key attribute to the specified Column
Parameters:
column -

setPrimaryKey

  1. void setPrimaryKey(java.util.List columns)
Set the value of the Primary Key attribute to the specified List of Columns
Parameters:
columns -

addForeignKey

  1. 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

  1. 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