All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.xmlmiddleware.xmldbms.maps.ColumnMap

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

public class ColumnMap

extends PropertyMapBase

ColumnMap inherits from PropertyMapBase. See that class for methods to get the column and to get and set the element type name, order information, and attribute multi-valuedness.

ColumnMaps are stored in ClassTableMaps.

Version:

2.0

Author:

Ronald Bourret, 1998-1999, 2001

See Also:

PropertyMapBase

create(Column)

Create a new ColumnMap.

getElementInsertionList()

Get the list of inserted wrapper elements, if any.

setElementInsertionList(ElementInsertionList)

Set the list of inserted wrapper elements, if any.

setXMLName(String, String, int)

Set the name and type of the XML construct being mapped.

setXMLName(XMLName, int)

Set the name and type of the XML construct being mapped.

 public static ColumnMap create(Column column)

Create a new ColumnMap.

Parameters:

column - The column being mapped.

Returns:

The ColumnMap.

 public void setXMLName(String uri,
                        String localName,
                        int type)

Set the name and type of the XML construct being mapped.

Parameters:

uri - Namespace URI of the XML construct to which the column is mapped. May be null for element types or attributes. Must be null for PCDATA.

localName - Local name of the XML construct to which the column mapped. Must be null for PCDATA.

type - Type of the XML construct to which the column mapped. One of ColumnMap.ELEMENTTYPE, ColumnMap.ATTRIBUTE, or ColumnMap.PCDATA.

Overrides:

setXMLName in class PropertyMapBase

 public void setXMLName(XMLName xmlName,
                        int type)

Set the name and type of the XML construct being mapped.

Parameters:

xmlName - XMLName of the XML construct to which the column is mapped. Must be null for PCDATA.

type - Type of the XML construct to which the column mapped. One of ColumnMap.ELEMENTTYPE, ColumnMap.ATTRIBUTE, or ColumnMap.PCDATA.

Overrides:

setXMLName in class PropertyMapBase

 public ElementInsertionList getElementInsertionList()

Get the list of inserted wrapper elements, if any.

If this column is mapped to an element or PCDATA, the element or PCDATA is constructed as a child of the last element in the list. If this table is mapped to an attribute, the attribute is constructed on the last element in the list.

Returns:

The ElementInsertionList. May be null.

 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