All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.xmlmiddleware.xmldbms.maps.PropertyMapBase 

java.lang.Object
   |
   +----org.xmlmiddleware.xmldbms.maps.MapBase
           |
           +----org.xmlmiddleware.xmldbms.maps.PropertyMapBase
public class PropertyMapBase
extends MapBase
Base class for PropertyMap and ColumnMap; not for general use.

PropertyMapBase provides accessors and mutators for XML construct name and type and for order information. It is the base class for PropertyMap and ColumnMap.

PropertyMapBase is never used directly. It is only used through PropertyMap and ColumnMap.

Version:
2.0
Author:
Ronald Bourret, 2001
See Also:
PropertyMap, ColumnMap, PropertyTableMap

Variable Index

o ATTRIBUTE
Mapping between a column and an attribute.
o ELEMENTTYPE
Mapping between a column and an element type.
o PCDATA
Mapping between a column and PCDATA.
o UNKNOWN
Unknown mapping.

Method Index

o containsXML()
Does the column contain XML?

Applies only to element types.

o getColumn()
Get the column to which the property is mapped.
o getOrderInfo()
Get the information used to order the element or PCDATA in its parent.
o getTokenListOrderInfo()
Get the information used to order a token list property.
o getType()
Get the type of the XML construct being mapped: ELEMENTTYPE, ATTRIBUTE, or PCDATA.
o getXMLName()
Get the name of the element type or attribute being mapped.
o isTokenList()
Is the value of an element type, attribute, or PCDATA a token list?

This is used to support token-list-valued attributes (as declared in DTDs) and token-list-valued element types and attributes (as declared in XML Schemas with the list data type).

o setContainsXML(boolean)
Set whether the column contains XML.
o setIsTokenList(boolean)
Sets whether the value of an element type, attribute, or PCDATA is a token list.
o setOrderInfo(OrderInfo)
Set the information used to order the element or PCDATA in its parent.
o setTokenListOrderInfo(OrderInfo)
Set the information used to order a token list property.

Variables

o UNKNOWN 
 public static final int UNKNOWN
Unknown mapping.

o ELEMENTTYPE 
 public static final int ELEMENTTYPE
Mapping between a column and an element type.

o ATTRIBUTE 
 public static final int ATTRIBUTE
Mapping between a column and an attribute.

o PCDATA 
 public static final int PCDATA
Mapping between a column and PCDATA.

Methods

o getXMLName 
 public final XMLName getXMLName()
Get the name of the element type or attribute being mapped.

Returns:
The element type or attribute name. Null if PCDATA is mapped.
o getType 
 public final int getType()
Get the type of the XML construct being mapped: ELEMENTTYPE, ATTRIBUTE, or PCDATA.

Returns:
The type.
o getColumn 
 public final Column getColumn()
Get the column to which the property is mapped.

Returns:
The column.
o containsXML 
 public final boolean containsXML()
Does the column contain XML?

Applies only to element types. This always returns false for attributes and PCDATA.

Returns:
Whether the column contains XML.
o setContainsXML 
 public void setContainsXML(boolean containsXML)
Set whether the column contains XML.

This method can only be called for element types.

Parameters:
containsXML - Whether the column contains XML.
o getOrderInfo 
 public final OrderInfo getOrderInfo()
Get the information used to order the element or PCDATA in its parent.

Applies only to element types and PCDATA. The result of calling this method for attributes is undefined.

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

Applies only to element types and PCDATA.

Parameters:
orderInfo - The order information. Null if the property is not ordered.
o getTokenListOrderInfo 
 public final OrderInfo getTokenListOrderInfo()
Get the information used to order a token list property.

Applies only when isTokenList() returns true.

Returns:
The order information. Null if the values are not ordered.
o setTokenListOrderInfo 
 public void setTokenListOrderInfo(OrderInfo tokenListOrderInfo)
Set the information used to order a token list property.

This method may be called only when isTokenList() returns true.

Parameters:
tokenListOrderInfo - The order information. Null if the property is not ordered.
o isTokenList 
 public final boolean isTokenList()
Is the value of an element type, attribute, or PCDATA a token list?

This is used to support token-list-valued attributes (as declared in DTDs) and token-list-valued element types and attributes (as declared in XML Schemas with the list data type).

Returns:
Whether the value of an element type, attribute, or PCDATA is a token list.
o setIsTokenList 
 public void setIsTokenList(boolean isTokenList)
Sets whether the value of an element type, attribute, or PCDATA is a token list.

Parameters:
isTokenList - Whether the value of an element type, attribute, or PCDATA is a token list 
All Packages  Class Hierarchy  This Package  Previous  Next  Index