All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.xmlmiddleware.xmldbms.maps.RelatedClassTableMap

java.lang.Object
   |
   +----org.xmlmiddleware.xmldbms.maps.MapBase
           |
           +----org.xmlmiddleware.xmldbms.maps.RelatedMapBase
                   |
                   +----org.xmlmiddleware.xmldbms.maps.RelatedClassTableMap

public class RelatedClassTableMap
extends RelatedMapBase
Maps a primary or foreign key that references a class table; not for general use.

A RelatedClassTableMap contains a pointer to the ClassTableMap of the child table, as well as the information needed to join the tables and order the child table in the parent.

RelatedClassMap inherits from RelatedMapBase. See RelatedMapBase for methods to get and set the element type, link, and order information.

A RelatedClassTableMap can contain an element type name different from the element type name in the ClassTableMap it points to. This allows the same class table to be mapped to different element types depending on the parent table. This is the inverse of the mapping created when a <UseClassMap> element in the XML-DBMS mapping language is used inside a <RelatedClass> element.

RelatedClassTableMaps are stored in ClassTableMaps.

Version:
2.0
Author:
Ronald Bourret, 2001
See Also:
RelatedMapBase

Method Index

 o create(ClassTableMap)
Create a new RelatedClassTableMap.
 o getClassTableMap()
Get the ClassTableMap of the related class table.
 o getElementInsertionList()
Get the list of inserted wrapper elements, if any.
 o setElementInsertionList(ElementInsertionList)
Set the list of inserted wrapper elements, if any.
 o setElementTypeName(String, String)
Set the name of the related element type.
 o setElementTypeName(XMLName)
Set the name of the related element type.

Methods

 o create
 public static RelatedClassTableMap create(ClassTableMap classTableMap)
Create a new RelatedClassTableMap.

Parameters:
classTableMap - The related ClassTableMap.
Returns:
The RelatedClassTableMap.
 o getClassTableMap
 public final ClassTableMap getClassTableMap()
Get the ClassTableMap of the related class table.

Returns:
The ClassTableMap.
 o setElementTypeName
 public void setElementTypeName(String uri,
                                String localName)
Set the name of the related element type.

This can be different from the element type name in the ClassTableMap to which the RelatedClassTableMap points. This allows the same class table to be mapped to different element types depending on the parent table. This is the inverse of the mapping created when a <UseClassMap> element in the XML-DBMS mapping language is used inside a <RelatedClass> element.

Parameters:
uri - The namespace URI of the related element type. May be null.
localName - The local name of the related element type.
 o setElementTypeName
 public void setElementTypeName(XMLName elementTypeName)
Set the name of the related element type.

This can be different from the element type name in the ClassTableMap to which the RelatedClassTableMap points. This allows the same class table to be mapped to different element types depending on the parent table. This is the inverse of the mapping created when a <UseClassMap> element in the XML-DBMS mapping language is used inside a <RelatedClass> element.

Parameters:
elementTypeName - The name of the related element type.
Overrides:
setElementTypeName in class RelatedMapBase
 o getElementInsertionList
 public ElementInsertionList getElementInsertionList()
Get the list of inserted wrapper elements, if any.

The element to which this table is mapped is constructed as a child of the last element in the list.

Returns:
The ElementInsertionList. May be null.
 o setElementInsertionList
 public void setElementInsertionList(ElementInsertionList elementInsertionList)
Set the list of inserted wrapper elements, if any.

Parameters:
elementInsertionList - The ElementInsertionList. May be null.

All Packages  Class Hierarchy  This Package  Previous  Next  Index