|
Oracle Fusion Middleware Java API Reference for Oracle TopLink 11g Release 1 (11.1.1) B32476-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.toplink.mappings.DatabaseMapping
oracle.toplink.ox.mappings.XMLAnyCollectionMapping
public class XMLAnyCollectionMapping
Any collection XML mappings map an attribute that contains a heterogenous collection of objects to multiple XML elements. Unlike composite collection XML mappings, the referenced objects may be of different types (including String), and do not need to be related to each other through inheritance or a common interface. The corresponding object attribute should be generic enough for all possible application values. Note that each of the referenced objects (except String) must specify a default root element on their descriptor.
Any collection mappings are useful with the following XML schema constructs:
Setting the XPath: TopLink XML mappings make use of XPath statements to find the relevant data in an XML document. The XPath statement is relative to the context node specified in the descriptor. The XPath may contain node type, path, and positional information. The XPath is specified on the mapping using the setXPath
method. Note that for XML Any Collection Mappings the XPath is optional.
The following XPath statements may be used to specify the location of XML data relating to an object's name attribute:
XPath | Description |
---|---|
contact-methods | The name information is stored in the contact-methods element. |
contact-methods/info | The XPath statement may be used to specify any valid path. |
contact-methods[2] | The XPath statement may contain positional information. In this case the contact information is stored in the second occurrence of the contact-methods element. |
Mapping an element of type xs:anyType as an Any Collection Mapping:
XML Schema
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element />
<xsd:complexType >
<xsd:sequence>
<xsd:element />
</xsd:sequence>
</xsd:complexType>
<xsd:element >
<xsd:complexType>
<xsd:sequence>
<xsd:element />
<xsd:element />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element />
</xsd:schema>
Code Sample
XMLAnyCollectionMapping contactMethodsMapping = new XMLAnyCollectionMapping();
contactMethodsMapping.setAttributeName("contactMethods");
contactMethodsMapping.setXPath("contact-methods");
More Information: For more information about using the XML Any Collection Mapping, see the "Understanding XML Mappings" chapter of the Oracle TopLink Developer's Guide.
Constructor Summary | |
---|---|
XMLAnyCollectionMapping() |
Method Summary | |
---|---|
UnmarshalKeepAsElementPolicy |
getKeepAsElementPolicy() |
boolean |
isMixedContent() |
void |
setContainerPolicy(oracle.toplink.internal.queryframework.ContainerPolicy cp) Set the mapping's container policy. |
void |
setField(DatabaseField field) |
void |
setKeepAsElementPolicy(UnmarshalKeepAsElementPolicy policy) |
void |
setMixedContent(boolean mixed) |
void |
setUseXMLRoot(boolean useXMLRoot) |
void |
setXPath(java.lang.String xpath) |
void |
useCollectionClass(java.lang.Class concreteContainerClass) Configure the mapping to use an instance of the specified container class to hold the target objects. |
void |
useMapClass(java.lang.Class concreteContainerClass, java.lang.String methodName) Configure the mapping to use an instance of the specified container class to hold the target objects. |
boolean |
usesXMLRoot() |
Methods inherited from class oracle.toplink.mappings.DatabaseMapping |
---|
getAttributeAccessor, getAttributeClassification, getAttributeName, getGetMethodName, getProperty, getReferenceDescriptor, getSetMethodName, isLazy, isOptional, isUsingMethodAccess, readOnly, readWrite, setAttributeAccessor, setAttributeName, setGetMethodName, setIsLazy, setIsOptional, setIsReadOnly, setProperty, setSetMethodName, setWeight, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public XMLAnyCollectionMapping()
Method Detail |
---|
public void setXPath(java.lang.String xpath)
public void setContainerPolicy(oracle.toplink.internal.queryframework.ContainerPolicy cp)
setContainerPolicy
in interface ContainerMapping
public void setField(DatabaseField field)
public void useCollectionClass(java.lang.Class concreteContainerClass)
jdk1.2.x: The container class must implement (directly or indirectly) the Collection interface.
jdk1.1.x: The container class must be a subclass of Vector.
useCollectionClass
in interface ContainerMapping
public void useMapClass(java.lang.Class concreteContainerClass, java.lang.String methodName)
Map
is the value returned by a call to the specified zero-argument method. The method must be implemented by the class (or a superclass) of any value to be inserted into the Map
.
The container class must implement (directly or indirectly) the java.util.Map
interface.
To facilitate resolving the method, the mapping's referenceClass must set before calling this method.
useMapClass
in interface ContainerMapping
public void setUseXMLRoot(boolean useXMLRoot)
public boolean usesXMLRoot()
public boolean isMixedContent()
public void setMixedContent(boolean mixed)
public UnmarshalKeepAsElementPolicy getKeepAsElementPolicy()
public void setKeepAsElementPolicy(UnmarshalKeepAsElementPolicy policy)
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |