View source for Configuring a Relational Direct-to-XMLType Mapping (ELUG)

<div style="float:right;border:1px solid #000000;padding:5px">__TOC__
[[Special:Whatlinkshere/Introduction to Relational Mappings (ELUG)|Related Topics]]</div>

For information on how to create EclipseLink mappings, see [[Creating%20a%20Mapping%20(ELUG)|Creating a Mapping]].

This table lists the configurable options for a relational direct-to-<tt>XMLType</tt> mapping.


<span id="Table 35-1"></span>
{| class="RuleFormalMax" dir="ltr" title="Configurable Options for Relational Direct-To-XMLType Mapping" summary="This table lists the configurable options common to Relational Direct-To-XMLType Mapping and categorizes them as Basic and Advanced and indicates if the option can be configured with the TopLink Workbench, Java, or both." width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all"
|- align="left" valign="top"
! id="r1c1-t2" align="left" valign="bottom" | '''Option to Configure'''
! id="r1c2-t2" align="left" valign="bottom" | '''Workbench'''
! id="r1c3-t2" align="left" valign="bottom" | '''Java'''
|- align="left" valign="top"
| id="r2c1-t2" headers="r1c1-t2" align="left" |
[[Configuring%20a%20Relational%20Mapping%20(ELUG)#Configuring a Database Field|Database field]]
| headers="r2c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r2c1-t2 r1c3-t2" align="left" |
[[Image:support.gif|Supported]]
|- align="left" valign="top"
| id="r3c1-t2" headers="r1c1-t2" align="left" |
[[Configuring%20a%20Mapping%20(ELUG)#Cofiguring Method or direct field access|Method or direct field access]]
| headers="r3c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r3c1-t2 r1c3-t2" align="left" |
[[Image:support.gif|Supported]]
|- align="left" valign="top"
| id="r4c1-t2" headers="r1c1-t2" align="left" |
[[Configuring%20a%20Mapping%20(ELUG)#Configuring Read-Only Mappings|Read-only]]
| headers="r4c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r4c1-t2 r1c3-t2" align="left" |
[[Image:support.gif|Supported]]
|- align="left" valign="top"
| id="r5c1-t2" headers="r1c1-t2" align="left" |
[[#Configuring Read Whole Document|Configuring Read Whole Document]]
| headers="r5c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r5c1-t2 r1c3-t2" align="left" |
[[Image:support.gif|Supported]]
|- align="left" valign="top"
| id="r6c1-t2" headers="r1c1-t2" align="left" |
[[Configuring%20a%20Mapping%20(ELUG)#Configuring Mapping Comments|Mapping comments]]
| headers="r6c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r6c1-t2 r1c3-t2" align="left" |
[[Image:unsupport.gif|Supported]]
|}


This example shows how to create a direct-to-XMLType mapping and add it to a descriptor using Java code.

<span id="Example 37-1"></span>
''''' Direct-to-XMLType Mapping'''''
 public void customize(ClassDescriptor descriptor) { 
    DirectToXMLTypeMapping mapping = new DirectToXMLTypeMapping();  
 
    // configure mapping
    mapping.setAttributeName("document");
 
    // add mapping to descriptor
    descriptor.addMapping(mapping);
 }


For more information, see the following:
* [[Introduction%20to%20Relational%20Mappings%20(ELUG)#Direct-to-XMLType Mapping|Direct-to-XMLType Mapping]]
* [[Configuring%20a%20Relational%20Mapping%20(ELUG)|Configuring a Relational Mapping]]
* [[Configuring%20a%20Mapping%20(ELUG)|Configuring a Mapping]].



==Configuring Read Whole Document==

When mapping an XML Type to a Document Object Model (DOM), by default EclipseLink uses the database representation of the DOM. This allows for lazy loading of the XML data from the database.

However, if you require the entire DOM, (or if you require the DOM to be available in a disconnected fashion from the database connection) use the '''Read Whole''' option to retrieve the entire DOM from the database.



===How to Configure Read Whole Document Using Workbench===

To specify that this mapping reads the whole XML document, use this procedure:
# Select the mapping in the '''Navigator'''. Its properties appear in the Editor.
# Click '''General'''. The General tab appears.<br><span id="Figure 35-1"></span>''''' Direct to XML Mapping Property Sheet, Read Whole Document Option'''''<br>[[Image:readwhl.gif|Direct to XML Mapping Property Sheet, Read Whole Document Option]]
# Choose the '''Read Whole Document''' option to read the whole XML document. If you do not select this option, the connection must remain open for EclipseLink to read the database values.



===How to Configure Read Whole Document Using Java===

Use the following <tt>DirectToXMLTypeMapping</tt> methods:
* <tt>setShouldReadWholeDocument</tt>
* <tt>shouldReadWholeDocument</tt>

For more information about the available methods for <tt>DirectToXMLTypeMapping</tt>, see the ''EclipseLink API Reference''.



----
''[[EclipseLink User's Guide Copyright Statement|Copyright Statement]]''


[[Category: EclipseLink User's Guide]]
[[Category: Release 1]]
[[Category: Task]]
[[Category: ORM]]