com.ibm.websphere.sdo.mediator.jdbc.metadata
Interface Metadata
- public interface Metadata
Method Summary
Modifier and Type | Method and Description |
---|---|
addRelationship(Key parentKey,Key childKey)
Create and add a Relationship object with the given parentKey
and childKey
|
|
addTable(java.lang.String tableName)
Create and add a Table object with the given tableName
|
|
|
getOrderBys()
Return the List of OrderBy objects contained in the Metadata
|
getRelationship(java.lang.String name)
Get the Relationship object with the specified name
|
|
|
getRelationships()
Returns the List of Relationship objects contained in the Metadata
|
|
getRootObject()
The Root Object attribute determines the type name associated with the root
object in a DataGraph.
|
getRootTable()
Returns the root Table object
|
|
getTable(java.lang.String tableName)
Return the Table object with the given tableName
|
|
getTableByPropertyName(java.lang.String propertyName)
Return the Table object with the given propertyName
|
|
|
getTables()
Returns the List of Table objects contained in the Metadata
|
|
getUniqueKeyBufferSize()
Return the value of the Unique Key Buffer Size attribute
|
getUniqueKeyTable()
Returns the Table used for generating unique keys.
|
|
|
save(java.io.OutputStream stream)
Saves the current Metadata in XMI format to the given OutputStream
|
|
save(java.lang.String fileName)
Saves the current Metadata in XMI format to the given file name
|
|
saveToEcore(java.io.OutputStream stream,java.lang.String prefix,java.lang.String packageName)
Convert the current Metadata to an Ecore model and then save it
to the given OutputStream
|
|
saveToEcore(java.lang.String fileName,java.lang.String prefix,java.lang.String packageName)
Convert the current Metadata to an Ecore model and then save it
to the given file name
|
|
setRootObject(java.lang.String value)
Sets the value of the '
Root Object ' attribute
|
|
setRootTable(Table value)
Sets the value of the '
Root Table ' reference
|
|
setUniqueKeyBufferSize(int value)
Sets the value of the '
Unique Key Buffer Size ' attribute
|
|
setUniqueKeyTable(java.lang.String tableName)
Sets the value of the '
Unique Key Table ' containment reference
|
|
setUniqueKeyTable(Table value)
Sets the value of the '
Unique Key Table ' containment reference
|
|
setUseForeignKeyFields(boolean useForeignKeyFields)
Set the value of the useForeignKeyFields property.
|
|
useForeignKeyFields()
When true, the mediator will only traverse relationships to populate
foreign key fields when the relationship has been changed.
|
Method Detail
getRootObject
- java.lang.String getRootObject( )
The Root Object attribute determines the type name associated with the root
object in a DataGraph. By default, this is DataGraphRoot.
Returns:
the name of the root object
setRootObject
- void setRootObject(java.lang.String value)
Sets the value of the '
Root Object
' attribute.
getUniqueKeyTable
- Table getUniqueKeyTable()
Returns the Table used for generating unique keys.
Returns:
the table used for generating unique keys
setUniqueKeyTable
- void setUniqueKeyTable(Table value)
Sets the value of the '
Unique Key Table
' containment reference.
Parameters:
value
- the new value of the 'Unique Key Table' containment reference. See Also:
setUniqueKeyTable
- void setUniqueKeyTable(java.lang.String tableName)
Sets the value of the '
Unique Key Table
' containment reference.
See Also:
getRootTable
- Table getRootTable()
Returns the root Table object
Returns:
the root table
setRootTable
- void setRootTable(Table value)
Sets the value of the '
Root Table
' reference.
getTables
- org.eclipse.emf.common.util.EList getTables( )
Returns the List of Table objects contained in the Metadata
Returns:
the list of tables
getRelationships
- org.eclipse.emf.common.util.EList getRelationships( )
Returns the List of Relationship objects contained in the Metadata
Returns:
the list of relationships
getRelationship
- Relationship getRelationship(java.lang.String name)
Get the Relationship object with the specified name
Parameters:
name
- Returns:
a Relationship
addTable
- Table addTable(java.lang.String tableName)
Create and add a Table object with the given tableName
Parameters:
tableName
- Returns:
the new table
getTable
- Table getTable(java.lang.String tableName)
Return the Table object with the given tableName
Parameters:
tableName
- Returns:
the table
addRelationship
- Relationship addRelationship(Key parentKey,
- Key childKey)
Create and add a Relationship object with the given parentKey
and childKey
Parameters:
parentKey
- the relationship's parent key childKey
- the relationship's child key Returns:
the new relationship
getOrderBys
- org.eclipse.emf.common.util.EList getOrderBys( )
Return the List of OrderBy objects contained in the Metadata
Returns:
the list of OrderBy objects
getUniqueKeyBufferSize
- int getUniqueKeyBufferSize()
Return the value of the Unique Key Buffer Size attribute
Returns:
the unique key buffer size
setUniqueKeyBufferSize
- void setUniqueKeyBufferSize(int value)
Sets the value of the '
Unique Key Buffer Size
' attribute.
Parameters:
value
- the new value of the 'Unique Key Buffer Size' attribute. See Also:
getTableByPropertyName
- Table getTableByPropertyName(java.lang.String propertyName)
Return the Table object with the given propertyName
Returns:
the table
save
- void save(java.lang.String fileName)
- throws java.io.IOException
Saves the current Metadata in XMI format to the given file name
Parameters:
fileName
- the name of the file Throws:
java.io.IOException
save
- void save(java.io.OutputStream stream)
- throws java.io.IOException
Saves the current Metadata in XMI format to the given OutputStream
Parameters:
stream
- the output stream to which the metadata will be saved Throws:
java.io.IOException
saveToEcore
- void saveToEcore(java.lang.String fileName,
- java.lang.String prefix,
- java.lang.String packageName)
- throws InvalidMetadataException
- java.io.IOException
Convert the current Metadata to an Ecore model and then save it
to the given file name
Parameters:
fileName
- the name of the file prefix
- the prefix for the Factory and Package objects packageName
- the package name Throws:
java.io.IOException
saveToEcore
- void saveToEcore(java.io.OutputStream stream,
- java.lang.String prefix,
- java.lang.String packageName)
- throws InvalidMetadataException
- java.io.IOException
Convert the current Metadata to an Ecore model and then save it
to the given OutputStream
Parameters:
stream
- the output stream prefix
- the prefix for the Factory and Package objects packageName
- the package name Throws:
java.io.IOException
useForeignKeyFields
- boolean useForeignKeyFields()
When true, the mediator will only traverse relationships to populate
foreign key fields when the relationship has been changed. By default,
this value is set to false and the mediator will always traverse
relationships for foreign key values.
Returns:
the value of the useForeignKeyFields property
setUseForeignKeyFields
- void setUseForeignKeyFields(boolean useForeignKeyFields)
Set the value of the useForeignKeyFields property.