All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.xmlmiddleware.xmldbms.maps.ElementInsertionList 

java.lang.Object
   |
   +----org.xmlmiddleware.xmldbms.maps.MapBase
           |
           +----org.xmlmiddleware.xmldbms.maps.ElementInsertionList
public class ElementInsertionList
extends MapBase
Lists inlined elements that need to be inserted; not for general use.

ElementInsertionList contains a list of ElementInsertionMaps, each of which describes an inlined element. When data is retrieved from the database, the inlined elements are constructed beneath the class element. The elements are constructed in ascending order. That is, the first element in the list is the first child of the class element.

An ElementInsertionList describes a single chain of inlined elements. Because inlined elements can form a tree -- which occurs when a InlineClassMap contains more than one child InlineClassMap -- the ElementInsertionMaps in an ElementInsertionList can appear in more than one ElementInsertionList. When this occurs, DBMSToDOM is careful not to construct duplicate inlined elements. That is, a class table or inlined element can have at most one inlined child element with a particular name.

ElementInsertionLists are stored in ColumnMaps and RelatedClassTableMaps.

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

Method Index

o addElementInsertionMap(ElementInsertionMap)
Add an ElementInsertionMap to the end of the list.
o clone()
Clone an ElementInsertionList.
o create()
Create a new ElementInsertionList.
o getElementInsertionMap(int)
Get an ElementInsertionMap.
o getElementInsertionMaps()
Get all ElementInsertionMaps.
o insertElementInsertionMap(ElementInsertionMap, int)
Insert an ElementInsertionMap at the specified position.
o removeAllElementInsertionMaps()
Remove all ElementInsertionMaps from the list.
o removeElementInsertionMap(int)
Remove the ElementInsertionMap at the specified position.
o setElementInsertionMap(ElementInsertionMap, int)
Overwrite the ElementInsertionMap at the specified position.
o size()
Get the number of ElementInsertionMaps in the list.

Methods

o create 
 public static ElementInsertionList create()
Create a new ElementInsertionList.

Returns:
The ElementInsertionList.
o clone 
 public Object clone()
Clone an ElementInsertionList.

This method performs a "shallow" clone. That is, the ElementInsertionMaps in the list are not cloned.

Returns:
The cloned ElementInsertionList
Overrides:
clone in class Object
o getElementInsertionMap 
 public ElementInsertionMap getElementInsertionMap(int position)
Get an ElementInsertionMap.

Parameters:
position - The position of the ElementInsertionMap in the list. The position is 0-based.
Returns:
The ElementInsertionMap.
o getElementInsertionMaps 
 public Enumeration getElementInsertionMaps()
Get all ElementInsertionMaps.

Returns:
An Enumeration of ElementInsertionMaps. May be empty.
o addElementInsertionMap 
 public void addElementInsertionMap(ElementInsertionMap elementInsertionMap)
Add an ElementInsertionMap to the end of the list.

Parameters:
elementInsertionMap - The ElementInsertionMap.
o insertElementInsertionMap 
 public void insertElementInsertionMap(ElementInsertionMap elementInsertionMap,
                                       int position)
Insert an ElementInsertionMap at the specified position.

All ElementInsertionMaps at or after the specified position are moved one position later in the list.

Parameters:
elementInsertionMap - The ElementInsertionMap.
position - The position of the ElementInsertionMap in the list. The position is 0-based.
o setElementInsertionMap 
 public void setElementInsertionMap(ElementInsertionMap elementInsertionMap,
                                    int position)
Overwrite the ElementInsertionMap at the specified position.

Parameters:
elementInsertionMap - The ElementInsertionMap.
position - The position of the ElementInsertionMap in the list. The position is 0-based.
o removeElementInsertionMap 
 public void removeElementInsertionMap(int position)
Remove the ElementInsertionMap at the specified position.

All ElementInsertionMaps after the specified position are moved one position earlier in the list.

Parameters:
position - The position of the ElementInsertionMap in the list. The position is 0-based.
o removeAllElementInsertionMaps 
 public void removeAllElementInsertionMaps()
Remove all ElementInsertionMaps from the list.

o size 
 public int size()
Get the number of ElementInsertionMaps in the list.

Returns:
The number of ElementInsertionMaps in the list. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index