All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.xmlmiddleware.xmldbms.maps.PropertyMap 

java.lang.Object
   |
   +----org.xmlmiddleware.xmldbms.maps.MapBase
           |
           +----org.xmlmiddleware.xmldbms.maps.PropertyMapBase
                   |
                   +----org.xmlmiddleware.xmldbms.maps.PropertyMap
public class PropertyMap
extends PropertyMapBase
Maps an element type, attribute, or PCDATA to a column in the class table or a separate property table; not for general use.

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

PropertyMaps are stored in ClassMaps and InlineClassMaps.

Version:
2.0
Author:
Ronald Bourret, 1998-1999, 2001
See Also:
PropertyMapBase

Method Index

o create(String, String, int)
Create a new PropertyMap.
o create(XMLName, int)
Create a new PropertyMap.
o getLinkInfo()
Get the information used to link the class table to the property table, if any.
o getTable()
Get the property table to which the property is mapped, if any.
o setColumn(Column)
Set the column to which the property is mapped.
o setTable(Table, LinkInfo)
Map the property to a column in a property table.

Methods

o create 
 public static PropertyMap create(String uri,
                                  String localName,
                                  int type)
Create a new PropertyMap.

Parameters:
uri - Namespace URI of the element type or attribute being mapped. May be null for element types or attribues. Must be null for PCDATA.
localName - Local name of the element type or attribute being mapped. Must be null for PCDATA.
type - Type of the property being mapped. One of PropertyMap.ELEMENTTYPE, PropertyMap.ATTRIBUTE, or PropertyMap.PCDATA.
Returns:
The PropertyMap.
o create 
 public static PropertyMap create(XMLName xmlName,
                                  int type)
Create a new PropertyMap.

Parameters:
xmlName - XMLName of the element type or attribute being mapped. Must be null for PCDATA.
type - Type of the property being mapped. One of PropertyMap.ELEMENTTYPE, PropertyMap.ATTRIBUTE, or PropertyMap.PCDATA.
Returns:
The PropertyMap.
o getTable 
 public final Table getTable()
Get the property table to which the property is mapped, if any.

Returns:
The table. Null if the property is mapped to a column in the class table.
o getLinkInfo 
 public final LinkInfo getLinkInfo()
Get the information used to link the class table to the property table, if any.

Returns:
The LinkInfo. Null if the property is mapped to a column in the class table.
o setTable 
 public void setTable(Table table,
                      LinkInfo linkInfo)
Map the property to a column in a property table.

The arguments must either both be null or both be non-null.

Parameters:
table - The property table. Null to unset the property table.
linkInfo - The link information. Null to unset the link information.
o setColumn 
 public void setColumn(Column column)
Set the column to which the property is mapped.

This column is in the class table or the property table, depending on whether getTable() returns null or not.

Parameters:
column - The column.
Overrides:
setColumn in class PropertyMapBase 
All Packages  Class Hierarchy  This Package  Previous  Next  Index