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
Methods Modifier and Type Method and Description Column
addBigDecimalColumn(java.lang.String name)
Create and add a Column of type BigDecimal with the given nameColumn
addBlobColumn(java.lang.String name)
Create and add a Column of type Blob with the given nameColumn
addBooleanColumn(java.lang.String name)
Create and add a Column of type Boolean with the given nameColumn
addByteColumn(java.lang.String name)
Create and add a Column of type Byte with the given nameColumn
addBytesColumn(java.lang.String name)
Create and add a Column of type Bytes with the given nameColumn
addClobColumn(java.lang.String name)
Create and add a Column of type Clob with the given nameColumn
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 nullabilityColumn
addDateColumn(java.lang.String name)
Create and add a Column of type Date with the given nameColumn
addDoubleColumn(java.lang.String name)
Create and add a Column of type Double with the given nameColumn
addFloatColumn(java.lang.String name)
Create and add a Column of type Float with the given nameKey
addForeignKey(Column column)
Create and add a Foreign Key to this Table consisting of the given ColumnColumn
addIntegerColumn(java.lang.String name)
Create and add a Column of type Integer with the given nameColumn
addLongColumn(java.lang.String name)
Create and add a Column of type Long with the given nameColumn
addShortColumn(java.lang.String name)
Create and add a Column of type Short with the given nameColumn
addStringColumn(java.lang.String name)
Create and add a Column of type String with the given nameColumn
addTimeColumn(java.lang.String name)
Create and add a Column of type Time with the given nameColumn
addTimestampColumn(java.lang.String name)
Create and add a Column of type Timestamp with the given namevoid
beRoot()
Make this Table be the root Table in the Metadata.Column
getCollisionColumn()
Returns the Column object used for optimistic concurrency controlColumn
getColumn(java.lang.String columnName)
Returns the Column object with the given nameorg.eclipse.emf.common.util.EList
getColumns()
Get the columns contained in this tableFilter
getFilter()
Get the filter applied to this tableorg.eclipse.emf.common.util.EList
getForeignKeys()
Get the foreign keys for this tableMetadata
getMetadata()
Returns the @link com.ibm.websphere.sdo.mediator.jdbc.metadata.Metadata object that contains this Tablejava.lang.String
getName()
Get the name of the database tableKey
getPrimaryKey()
Get the primary key for this tablejava.lang.String
getPropertyName()
Get the Property Name attributejava.lang.String
getSchemaName()
Get the Schema Name attributeboolean
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
' referencevoid
setExternal(boolean value)
Sets the value of the 'External
' attributevoid
setFilter(Filter value)
Sets the value of the 'Filter
' containment referencevoid
setMetadata(Metadata value)
Sets the value of the 'Metadata
' container referencevoid
setName(java.lang.String value)
Sets the value of the 'Name
' attributevoid
setPrimaryKey(Column column)
Set the value of the Primary Key attribute to the specified Columnvoid
setPrimaryKey(Key value)
Sets the value of the 'Primary Key
' containment referencevoid
setPrimaryKey(java.util.List columns)
Set the value of the Primary Key attribute to the specified List of Columnsvoid
setPropertyName(java.lang.String value)
Sets the value of the 'Property Name
' attributevoid
setSchemaName(java.lang.String value)
Sets the value of the 'Schema Name
' attribute
-
-
-
Method Detail
-
getPropertyName
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
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
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
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
java.lang.String qualifiedName()
Returns the name of this table qualified with the schema name, if applicable.- Returns:
- the qualified name
-
getName
java.lang.String getName()
Get the name of the database table- Returns:
- the name
-
setName
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
Key getPrimaryKey()
Get the primary key for this table- Returns:
- the primary key
-
setPrimaryKey
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
org.eclipse.emf.common.util.EList getForeignKeys()
Get the foreign keys for this table- Returns:
- the list of foreign keys
-
getColumns
org.eclipse.emf.common.util.EList getColumns()
Get the columns contained in this table- Returns:
- the list of columns
-
getColumn
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
Filter getFilter()
Get the filter applied to this table- Returns:
- the filter
-
setFilter
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
Metadata getMetadata()
Returns the @link com.ibm.websphere.sdo.mediator.jdbc.metadata.Metadata object that contains this Table- Returns:
- the metadata
-
setMetadata
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
Column getCollisionColumn()
Returns the Column object used for optimistic concurrency control- Returns:
- the collision column
-
setCollisionColumn
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
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
void setExternal(boolean value)
Sets the value of the 'External
' attribute.- Parameters:
value
- the new value of the 'External' attribute.- See Also:
isExternal()
-
addColumn
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
void setPrimaryKey(Column column)
Set the value of the Primary Key attribute to the specified Column- Parameters:
column
-
-
setPrimaryKey
void setPrimaryKey(java.util.List columns)
Set the value of the Primary Key attribute to the specified List of Columns- Parameters:
columns
-
-
addForeignKey
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
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
-
-