Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Configuring an XML Mapping (ELUG)"

m (Introduction to XML Mapping Configuration)
Line 20: Line 20:
 
|- align="left" valign="top"
 
|- align="left" valign="top"
 
| id="r2c1-t2" headers="r1c1-t2" align="left" |
 
| id="r2c1-t2" headers="r1c1-t2" align="left" |
XML direct mapping (see [[Introduction%20to%20XML%20Mappings%20(ELUG)|XML Direct Mapping]])
+
[[Introduction%20to%20XML%20Mappings%20(ELUG)|XML Direct Mapping]]
 
| headers="r2c1-t2 r1c2-t2" align="left" |
 
| headers="r2c1-t2 r1c2-t2" align="left" |
 
[[Configuring%20an%20XML%20Direct%20Mapping%20(ELUG)|Configuring an XML Direct Mapping]]<br>
 
[[Configuring%20an%20XML%20Direct%20Mapping%20(ELUG)|Configuring an XML Direct Mapping]]<br>
 
|- align="left" valign="top"
 
|- align="left" valign="top"
 
| id="r3c1-t2" headers="r1c1-t2" align="left" |
 
| id="r3c1-t2" headers="r1c1-t2" align="left" |
XML composite direct collection mapping (see [[Introduction%20to%20XML%20Mappings%20(ELUG)|XML Composite Direct Collection Mapping]])
+
[[Introduction%20to%20XML%20Mappings%20(ELUG)|XML Composite Direct Collection Mapping]]
 
| headers="r3c1-t2 r1c2-t2" align="left" |
 
| headers="r3c1-t2 r1c2-t2" align="left" |
 
[[Configuring%20an%20XML%20Composite%20Direct%20Collection%20Mapping%20(ELUG)|Configuring an XML Composite Direct Collection Mapping]]<br>
 
[[Configuring%20an%20XML%20Composite%20Direct%20Collection%20Mapping%20(ELUG)|Configuring an XML Composite Direct Collection Mapping]]<br>
 
|- align="left" valign="top"
 
|- align="left" valign="top"
 
| id="r4c1-t2" headers="r1c1-t2" align="left" |
 
| id="r4c1-t2" headers="r1c1-t2" align="left" |
XML composite object mapping (see [[Introduction%20to%20XML%20Mappings%20(ELUG)|XML Composite Object Mapping]])
+
[[Introduction%20to%20XML%20Mappings%20(ELUG)|XML Composite Object Mapping]]
 
| headers="r4c1-t2 r1c2-t2" align="left" |
 
| headers="r4c1-t2 r1c2-t2" align="left" |
 
[[Configuring%20an%20XML%20Composite%20Object%20(ELUG)|Configuring an XML Composite Object Mapping]]<br>
 
[[Configuring%20an%20XML%20Composite%20Object%20(ELUG)|Configuring an XML Composite Object Mapping]]<br>
 
|- align="left" valign="top"
 
|- align="left" valign="top"
 
| id="r5c1-t2" headers="r1c1-t2" align="left" |
 
| id="r5c1-t2" headers="r1c1-t2" align="left" |
XML composite collection mapping (see [[Introduction%20to%20XML%20Mappings%20(ELUG)|XML Composite Collection Mapping]])
+
[[Introduction%20to%20XML%20Mappings%20(ELUG)|XML Composite Collection Mapping]]
 
| headers="r5c1-t2 r1c2-t2" align="left" |
 
| headers="r5c1-t2 r1c2-t2" align="left" |
 
[[Configuring%20an%20XML%20Composite%20Collection%20Mapping%20(ELUG)|Configuring an XML Composite Collection Mapping]]<br>
 
[[Configuring%20an%20XML%20Composite%20Collection%20Mapping%20(ELUG)|Configuring an XML Composite Collection Mapping]]<br>
 
|- align="left" valign="top"
 
|- align="left" valign="top"
 
| id="r6c1-t2" headers="r1c1-t2" align="left" |
 
| id="r6c1-t2" headers="r1c1-t2" align="left" |
XML any object mapping (see [[Introduction%20to%20XML%20Mappings%20(ELUG)|XML Any Object Mapping]])
+
[[Introduction%20to%20XML%20Mappings%20(ELUG)|XML Any Object Mapping]]
 
| headers="r6c1-t2 r1c2-t2" align="left" |
 
| headers="r6c1-t2 r1c2-t2" align="left" |
 
[[Configuring%20an%20XML%20Any%20Object%20Mapping%20(ELUG)|Configuring an XML Any Object Mapping]]<br>
 
[[Configuring%20an%20XML%20Any%20Object%20Mapping%20(ELUG)|Configuring an XML Any Object Mapping]]<br>
 
|- align="left" valign="top"
 
|- align="left" valign="top"
 
| id="r7c1-t2" headers="r1c1-t2" align="left" |
 
| id="r7c1-t2" headers="r1c1-t2" align="left" |
XML any collection mapping (see [[Introduction%20to%20XML%20Mappings%20(ELUG)|XML Any Collection Mapping]])
+
[[Introduction%20to%20XML%20Mappings%20(ELUG)|XML Any Collection Mapping]]
 
| headers="r7c1-t2 r1c2-t2" align="left" |
 
| headers="r7c1-t2 r1c2-t2" align="left" |
 
[[Configuring%20an%20XML%20Any%20Collection%20Mapping%20(ELUG)|Configuring an XML Any Collection Mapping]]<br>
 
[[Configuring%20an%20XML%20Any%20Collection%20Mapping%20(ELUG)|Configuring an XML Any Collection Mapping]]<br>
 
|- align="left" valign="top"
 
|- align="left" valign="top"
 
| id="r8c1-t2" headers="r1c1-t2" align="left" |
 
| id="r8c1-t2" headers="r1c1-t2" align="left" |
XML transformation mapping (see [[Introduction%20to%20XML%20Mappings%20(ELUG)|XML Transformation Mapping]]
+
[[Introduction%20to%20XML%20Mappings%20(ELUG)|XML Transformation Mapping]]
 
| headers="r8c1-t2 r1c2-t2" align="left" |
 
| headers="r8c1-t2 r1c2-t2" align="left" |
 
[[Configuring%20an%20XML%20Transformation%20Mapping (ELUG)|Configuring an XML Transformation Mapping]]<br>
 
[[Configuring%20an%20XML%20Transformation%20Mapping (ELUG)|Configuring an XML Transformation Mapping]]<br>
 
|}
 
|}
  
<br>
 
  
 
For more information, see the following:
 
For more information, see the following:
 
* [[Introduction%20to%20Mappings%20(ELUG)|Introduction to Mappings]]
 
* [[Introduction%20to%20Mappings%20(ELUG)|Introduction to Mappings]]
 
* [[Introduction%20to%20XML%20Mappings%20(ELUG)|Introduction to XML Mappings]]
 
* [[Introduction%20to%20XML%20Mappings%20(ELUG)|Introduction to XML Mappings]]
 
 
  
 
==Configuring Common XML Mapping Options==
 
==Configuring Common XML Mapping Options==

Revision as of 14:02, 4 December 2007

This section describes how to configure an XML mapping.

For information on how to configure EclipseLink mappings options common to two or more mapping types, see Configuring a Mapping.


Introduction to XML Mapping Configuration

This table lists the types of XML mappings that you can configure and provides a cross-reference to the type-specific chapter that lists the configurable options supported by that type.

Configuring XML Mappings

Mapping Type See Also...

XML Direct Mapping

Configuring an XML Direct Mapping

XML Composite Direct Collection Mapping

Configuring an XML Composite Direct Collection Mapping

XML Composite Object Mapping

Configuring an XML Composite Object Mapping

XML Composite Collection Mapping

Configuring an XML Composite Collection Mapping

XML Any Object Mapping

Configuring an XML Any Object Mapping

XML Any Collection Mapping

Configuring an XML Any Collection Mapping

XML Transformation Mapping

Configuring an XML Transformation Mapping


For more information, see the following:

Configuring Common XML Mapping Options

This table lists the configurable options shared by two or more XML mapping types. In addition to the configurable options described here, you must also configure the options described for the specific XML Mapping Types, as shown in Configuring XML Mappings.


Common Options for XML Mappings

Option EclipseLink Workbench Java

Configuring XPath

Supported

Supported

#Configuring Reference Descriptor

Supported

Supported

Configuring Container Policy

Supported

Supported

Configuring Method or Direct Field Accessing at the Mapping Level

Supported

Supported

Configuring a Mapping

Supported

Supported

#Configuring Maps to Wildcard

Supported

Unsupported

Configuring a Serialized Object Converter

Supported

Supported

Configuring a Type Conversion Converter

Supported

Supported

Configuring an Object Type Converter

Supported

Supported

Configuring a Simple Type Translator

Supported

Supported

Configuring the Use of a Single Node

Supported

Supported

Configuring the Use of a Single Node

Unsupported

Supported



Configuring Reference Descriptor

For XML attributes that reference other descriptors (instead of a schema element), you may select a specific reference descriptor. If you do not specify a reference descriptor, EclipseLink uses the xsi:Type attribute to determine the reference class object.

This table summarizes which XML mappings support reference descriptor configuration.

XML Mapping Support for Reference Descriptor Configuration

XML Mapping Using the Workbench
How to Use Java

XML direct mapping (see XML Direct Mapping)

Unsupported

Unsupported

XML composite direct collection mapping (seeXML Composite Direct Collection Mapping)

Unsupported

Unsupported

XML composite object mapping (see XML Composite Object Mapping)

Supported

Supported

XML composite collection mapping (see XML Composite Collection Mapping)

Supported

Supported

XML any object mapping (see XML Any Object Mapping)

Unsupported

Unsupported

XML any collection mapping (see XML Any Collection Mapping)

Unsupported

Unsupported

XML transformation mapping (see XML Transformation Mapping)

Unsupported

Unsupported


How to Configure a Reference Descriptor Using Workbench

To specify a reference descriptor for an XML mapping that references another descriptor (instead of a schema element), use this procedure.

  1. Select the mapped attribute in the Navigator. Its properties appear in the Editor.
  2. Click the General tab. The General tab appears. General Tab, Reference Descriptor Field
    General Tab, Reference Descriptor Field

  3. If this XML attribute refers to another descriptor (instead of a schema element), use the Reference Descriptor field to select a descriptor in the project.



Configuring Maps to Wildcard

This attribute applies only to the Workbench. Use this option to solve "No XPath specified" problems (see How to Use the Problems Window) for an XML mapping that does not need an XPath (see Configuring XPath) for it maps to a wildcard.

If the XML mapping is owned by an anyType descriptor (see Configuring for Complex Type of anyType), it cannot map to a wildcard, and you must specify an XPath.

This table summarizes which XML mappings support maps to wildcard configuration.


XML Mapping Support for Maps to Wildcard Configuration

XML Mapping Using the Workbench How to Use Java

XML direct mapping (see XML Direct Mapping)

Supported

Supported

XML composite direct collection mapping (see XML Composite Direct Collection Mapping)

Supported

Supported

XML composite object mapping (see XML Composite Object Mapping)

Supported

Supported

XML composite collection mapping (see XML Composite Collection Mapping)

Supported

Supported

XML any object mapping (see XML Any Object Mapping)

Supported

Supported

XML any collection mapping (see XML Any Collection Mapping)

Supported

Supported

XML transformation mapping (see XML Transformation Mapping)

Supported

Supported



How to Configure Maps to Wildcard Using Workbench

To specify a map a schema element using the xs:any declaration, use this procedure.

  1. Select the mapped attribute in the Navigator. Its properties appear in the Editor.
  2. Mapping Tab, Maps to Wildcard Option
    Mapping Tab, Maps to Wildcard Option

  3. If the XML mapping is not owned by an anyType descriptor (see Configuring for Complex Type of anyType) and maps to a wildcard, then you do not need to specify an XPath (see Configuring XPath). Select the Maps to Wildcard (uses "any" tag) option to clear the missing XPath neediness message.
  4. If the XML mapping is owned by an anyType descriptor, it cannot map to a wildcard and you must specify an XPath. Deselect the Maps to Wildcard (Uses "any" tag) option and ensure that you specify an XPath.




Copyright Statement

Back to the top