|
EclipseLink 2.3.2, build 'v20111125-r10461' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.mappings.DatabaseMapping
org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping
org.eclipse.persistence.oxm.mappings.XMLCompositeDirectCollectionMapping
public class XMLCompositeDirectCollectionMapping
Composite direct collection XML mappings map a collection of simple types (String, Number, Date, etc.) to and from a sequence of composite XML nodes.
Composite direct collection XML mappings can be used in the following scenarios:
Setting the XPath: TopLink XML mappings make use of an XPath statement 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.
The following XPath statements may be used to specify the location of XML data relating to an object's name attribute:
XPath | Description |
---|---|
@tasks | The "@" character indicates that the node is an attribute. This XPath applies only to the single attribute node case; each member of the collection is mapped to a single node. |
tasks/@task | The "@" character indicates that the node is an attribute. The information is stored in the attribute node of the tasks element. |
text() | "text()" indicates that the node is a text node. In this case the task value in the text node belongs to the context node. |
tasks/text() | The task information is stored in the text node of the tasks element. |
tasks/task/text() | The XPath statement may be used to specify any valid path. |
task[2]/text() | The XPath statement may contain positional information. In this case the task information is stored in the text node of the second occurrence of the task element. |
Mapping to a Single Text Node: By default, TopLink maps each member of a collection
to it's own node. It is possible, however, to mapping a collection to a single node; here the contents of
the node is treated as a space-separated list. This behavior is set on the mapping using the
setUsesSingleNode
method, with 'true' as the parameter.
XML Schema
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="employee" type="employee-type"/>
<xsd:complexType name="employee-type">
<xsd:sequence>
<xsd:element name="tasks" type="tasks-type"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="tasks-type">
<xsd:list itemType="xsd:string"/>
</xsd:simpleType>
</xsd:schema>
Code Sample
XMLCompositeDirectCollectionMapping tasksMapping = new XMLCompositeDirectCollectionMapping();
tasksMapping.setAttributeName("tasks");
tasksMapping.setXPath("tasks/text()");
tasksMapping.setUsesSingleNode(true);
Specifying the Content Type of a Collection: By default, TopLink will treat the node values read in by a composite direct collection XML mapping as objects of type String. You can override this behavior by specifying the type of the collection's contents.
XML Schema
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="employee" type="employee-type"/>
<xsd:complexType name="employee-type">
<xsd:sequence>
<xsd:element name="vacation" type="xsd:string" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
Code Sample
XMLCompositeDirectCollectionMapping tasksMapping = new XMLCompositeDirectCollectionMapping();
tasksMapping.setAttributeName("vacationDays");
tasksMapping.setXPath("vacation/text()");
tasksMapping.setAttributeElementClass(Calendar.class);
Mapping to a List of Unions:
XML Schema
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="vacation" type="listOfUnions"/>
<xsd:simpleType name="listOfUnions">
<xsd:list>
<xsd:simpleType>
<xsd:union memberTypes="xsd:date xsd:integer"/>
</xsd:simpleType>
</xsd:list>
</xsd:simpleType>
</xsd:schema>
Code Sample
XMLCompositeDirectCollectionMapping mapping = new XMLCompositeDirectCollectionMapping();
mapping.setAttributeName("myattribute");
XMLUnionField field = new XMLUnionField("listOfUnions/text()");
mapping.addSchemaType(new QName(url,XMLConstants.INT));
mapping.addSchemaType(new QName(url,XMLConstants.DATE));
mapping.setField(field);
mapping.useSingleElement(false);
More Information: For more information about using the XML Composite Direct Collection Mapping, see the "Understanding XML Mappings" chapter of the Oracle TopLink Developer's Guide.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.eclipse.persistence.mappings.DatabaseMapping |
---|
DatabaseMapping.WriteType |
Field Summary | |
---|---|
protected boolean |
reuseContainer
|
Fields inherited from class org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping |
---|
elementDataTypeName, field, valueConverter |
Fields inherited from class org.eclipse.persistence.mappings.DatabaseMapping |
---|
attributeAccessor, attributeName, derivedIdMapping, derivesId, descriptor, fields, isCacheable, isJPAId, isLazy, isMapKeyMapping, isOptional, isPrimaryKeyMapping, isReadOnly, isRemotelyInitialized, mapsIdValue, NO_FIELDS, NO_WEIGHT, properties, weight, WEIGHT_AGGREGATE, WEIGHT_DIRECT, WEIGHT_TO_ONE, WEIGHT_TRANSFORM |
Constructor Summary | |
---|---|
XMLCompositeDirectCollectionMapping()
|
Method Summary | |
---|---|
AbstractNullPolicy |
getNullPolicy()
Get the AbstractNullPolicy from the Mapping. |
boolean |
getReuseContainer()
Return true if the original container on the object should be used if present. |
java.lang.String |
getXPath()
Get the XPath String |
void |
initialize(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: Initialize the mapping. |
boolean |
isCDATA()
|
boolean |
isCollapsingStringValues()
PUBLIC: Returns true if this mapping should collapse all string values before adding them to the collection. |
boolean |
isNormalizingStringValues()
PUBLIC: Returns true if this mapping is normalizing string values on unmarshal before adding them to the collection. |
boolean |
isWriteOnly()
INTERNAL: Some mappings support no attribute (transformation). |
boolean |
isXMLMapping()
INTERNAL: |
void |
preInitialize(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: Allow for initialization of properties and validation. |
void |
setAttributeValueInObject(java.lang.Object object,
java.lang.Object value)
INTERNAL: Set the value of the attribute mapped by this mapping. |
void |
setCollapsingStringValues(boolean collapse)
PUBLIC: Indicates that this mapping should collapse all string values before adding them to the collection on unmarshal. |
void |
setIsCDATA(boolean CDATA)
|
void |
setIsWriteOnly(boolean b)
|
void |
setNormalizingStringValues(boolean normalize)
PUBLIC: Indicates that this mapping should normalize all string values before adding them to the collection on unmarshal. |
void |
setNullPolicy(AbstractNullPolicy value)
Set the AbstractNullPolicy on the mapping The default policy is NullPolicy. |
void |
setReuseContainer(boolean reuseContainer)
Specify whether the original container on the object should be used if present. |
void |
setXPath(java.lang.String xpathString)
Set the Mapping field name attribute to the given XPath String |
void |
useCollectionClassName(java.lang.String concreteContainerClassName)
|
java.lang.Object |
valueFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord row,
org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager,
ObjectBuildingQuery sourceQuery,
org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey,
org.eclipse.persistence.internal.sessions.AbstractSession executionSession,
boolean isTargetProtected,
java.lang.Boolean[] wasCacheUsed)
INTERNAL: Build the nested collection from the database row. |
void |
writeFromObjectIntoRow(java.lang.Object object,
org.eclipse.persistence.internal.sessions.AbstractRecord row,
org.eclipse.persistence.internal.sessions.AbstractSession session,
DatabaseMapping.WriteType writeType)
INTERNAL: |
void |
writeSingleValue(java.lang.Object value,
java.lang.Object parent,
XMLRecord record,
org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: A method that marshals a single value to the provided Record based on this mapping's XPath. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected boolean reuseContainer
Constructor Detail |
---|
public XMLCompositeDirectCollectionMapping()
Method Detail |
---|
public boolean isXMLMapping()
isXMLMapping
in class DatabaseMapping
public void initialize(org.eclipse.persistence.internal.sessions.AbstractSession session) throws DescriptorException
initialize
in class AbstractCompositeDirectCollectionMapping
DescriptorException
public void setXPath(java.lang.String xpathString)
xpathString
- Stringpublic java.lang.String getXPath()
public void useCollectionClassName(java.lang.String concreteContainerClassName)
public java.lang.Object valueFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, ObjectBuildingQuery sourceQuery, org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey, org.eclipse.persistence.internal.sessions.AbstractSession executionSession, boolean isTargetProtected, java.lang.Boolean[] wasCacheUsed) throws DatabaseException
valueFromRow
in class AbstractCompositeDirectCollectionMapping
DatabaseException
public void writeFromObjectIntoRow(java.lang.Object object, org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.sessions.AbstractSession session, DatabaseMapping.WriteType writeType)
writeFromObjectIntoRow
in class AbstractCompositeDirectCollectionMapping
public void writeSingleValue(java.lang.Object value, java.lang.Object parent, XMLRecord record, org.eclipse.persistence.internal.sessions.AbstractSession session)
XMLMapping
writeSingleValue
in interface XMLMapping
value
- - The value to be marshalledrecord
- - The Record the value is being marshalled too.public void setIsCDATA(boolean CDATA)
public boolean isCDATA()
public void setIsWriteOnly(boolean b)
setIsWriteOnly
in interface XMLMapping
public boolean isWriteOnly()
DatabaseMapping
isWriteOnly
in interface XMLMapping
isWriteOnly
in class DatabaseMapping
public void setAttributeValueInObject(java.lang.Object object, java.lang.Object value) throws DescriptorException
DatabaseMapping
setAttributeValueInObject
in class DatabaseMapping
DescriptorException
public void preInitialize(org.eclipse.persistence.internal.sessions.AbstractSession session) throws DescriptorException
DatabaseMapping
preInitialize
in class DatabaseMapping
DescriptorException
public AbstractNullPolicy getNullPolicy()
XMLNillableMapping
getNullPolicy
in interface XMLNillableMapping
public void setNullPolicy(AbstractNullPolicy value)
XMLNillableMapping
setNullPolicy
in interface XMLNillableMapping
public boolean getReuseContainer()
public void setReuseContainer(boolean reuseContainer)
public boolean isNormalizingStringValues()
public void setNormalizingStringValues(boolean normalize)
normalize
- public void setCollapsingStringValues(boolean collapse)
normalize
- public boolean isCollapsingStringValues()
normalize
-
|
EclipseLink 2.3.2, build 'v20111125-r10461' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |