All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.xmlmiddleware.xmldbms.maps.ElementInsertionMap

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

public class ElementInsertionMap
extends MapBase
Describes a wrapper element that needs to be inserted; not for general use.

ElementInsertionMap contains information about an element that is to be inserted between a class table element and an element, attribute, or PCDATA for a column, related class table, or property table. When retrieving data from the database, it is used to reconstruct elements that were eliminated with WrapperClassMap.

Note that an ElementInsertionMap is closer to being the opposite of a WrapperClassMap than it is to providing parallel functionality in the database-centric view of a map. That is, it reconstructs elements, rather than treating child tables as "wrapper" tables.

ElementInsertionMaps are stored in ElementInsertionLists.

Version:
2.0
Author:
Ronald Bourret, 1998-9, 2001

Method Index

 o create(String, String)
Create a new ElementInsertionMap.
 o create(XMLName)
Create a new ElementInsertionMap.
 o getElementTypeName()
Get the name of the element type or attribute being mapped.
 o getOrderInfo()
Get the information used to order the wrapper element in its parent.
 o setOrderInfo(OrderInfo)
Set the information used to order the wrapper element in its parent.

Methods

 o create
 public static ElementInsertionMap create(String uri,
                                          String localName)
Create a new ElementInsertionMap.

Parameters:
uri - Namespace URI of the element type. May be null.
localName - Local name of the element type.
Returns:
The ElementInsertionMap.
 o create
 public static ElementInsertionMap create(XMLName elementTypeName)
Create a new ElementInsertionMap.

Parameters:
elementTypeName - The element type name.
Returns:
The ElementInsertionMap.
 o getElementTypeName
 public final XMLName getElementTypeName()
Get the name of the element type or attribute being mapped.

Returns:
The element type or attribute name. Null if PCDATA is mapped.
 o getOrderInfo
 public final OrderInfo getOrderInfo()
Get the information used to order the wrapper element in its parent.

Returns:
The order information. Null if the wrapper element is not ordered.
 o setOrderInfo
 public void setOrderInfo(OrderInfo orderInfo)
Set the information used to order the wrapper element in its parent.

Parameters:
orderInfo - The order information. Null if the wrapper element is not ordered.

All Packages  Class Hierarchy  This Package  Previous  Next  Index