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 EIS One-to-Many Mapping (ELUG)"

m (New page: <div style="float:right;border:1px solid #000000;padding:5px">__TOC__ Related Topics</div> This section describes th...)
 
m
Line 3: Line 3:
 
This section describes the various components that you must configure in order to use an EIS one-to-many mapping.
 
This section describes the various components that you must configure in order to use an EIS one-to-many mapping.
  
For information on how to configure EclipseLink mappings options common to two or more mapping types, see [[Configuring%20a%20Mapping%20(ELUG)#CEGFEFJG|Configuring a Mapping]].
+
For information on how to configure EclipseLink mappings options common to two or more mapping types, see [[Configuring%20a%20Mapping%20(ELUG)#CEGFEFJG|Configuring a Mapping]]. For information on how to create EclipseLink mappings, see [[Creating%20a%20Mapping%20(ELUG)#CBBHHHJC|Creating a Mapping]].
 
+
For information on how to create EclipseLink mappings, see [[Creating%20a%20Mapping%20(ELUG)#CBBHHHJC|Creating a Mapping]].
+
 
+
[[#Table 80-1|Configurable Options for EIS One-to-Many Mappings]] lists the configurable options for an EIS one-to-one mapping.
+
 
+
 
+
 
+
==Introduction to EIS One-to-Many Mapping Configuration==
+
  
 
This table lists the configurable options for an EIS one-to-many mapping.
 
This table lists the configurable options for an EIS one-to-many mapping.
Line 17: Line 9:
  
 
<span id="Table 80-1"></span>
 
<span id="Table 80-1"></span>
''''' Configurable Options for EIS One-to-Many Mappings'''''
+
{| class="RuleFormalMax" dir="ltr" title="Configurable Options for EIS One-to-Many Mappings" summary="This table lists the configurable options for EIS One-to-Many Mappings and indicates if the option can be configured with the  Workbench, Java, or both." width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all"
 
+
{| class="RuleFormalMax" dir="ltr" title="Configurable Options for EIS One-to-Many Mappings" summary="This table lists the configurable options for EIS One-to-Many Mappings and categorizes them as Basic and Advanced and indicates if the option can be configured with the  Workbench, Java, or both." width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all"
+
 
|- align="left" valign="top"
 
|- align="left" valign="top"
 
! id="r1c1-t2" align="left" valign="bottom" | '''Option to Configure'''
 
! id="r1c1-t2" align="left" valign="bottom" | '''Option to Configure'''
Line 157: Line 147:
  
 
===How to Configure Foreign Key Pairs Using Workbench===
 
===How to Configure Foreign Key Pairs Using Workbench===
 
 
To specify the source and target XML field pairs for a one-to-many EIS mapping, use this procedure:
 
To specify the source and target XML field pairs for a one-to-many EIS mapping, use this procedure:
  
Line 180: Line 169:
 
| id="r4c1-t3" headers="r1c1-t3" align="left" | ''' Grouping Element'''
 
| id="r4c1-t3" headers="r1c1-t3" align="left" | ''' Grouping Element'''
 
| headers="r4c1-t3 r1c2-t3" align="left" |
 
| headers="r4c1-t3 r1c2-t3" align="left" |
Specify the element in which foreign key pairs are grouped in the source object's EIS record. If you specify only one pair of source and target XML fields, this is optional.If you specify more than one pair of source and target XML fields, this is required.
+
Specify the element in which foreign key pairs are grouped in the source object's EIS record. If you specify only one pair of source and target XML fields, this is optional.
 +
 
 +
If you specify more than one pair of source and target XML fields, this is required.
 
|- align="left" valign="top"
 
|- align="left" valign="top"
 
| id="r5c1-t3" headers="r1c1-t3" align="left" | ''' Field Pairs'''
 
| id="r5c1-t3" headers="r1c1-t3" align="left" | ''' Field Pairs'''
Line 187: Line 178:
 
|}
 
|}
  
<br>
+
 
  
 
==Configuring Delete All Interactions==
 
==Configuring Delete All Interactions==
 
 
The EclipseLink query and expression framework supports delete all queries. If your JCA adapter provides access to an EIS Delete All function, you can configure a delete all interaction to support EclipseLink delete all queries.
 
The EclipseLink query and expression framework supports delete all queries. If your JCA adapter provides access to an EIS Delete All function, you can configure a delete all interaction to support EclipseLink delete all queries.
  
Line 196: Line 186:
  
 
===How to Configure Delete All Interactions Using Workbench===
 
===How to Configure Delete All Interactions Using Workbench===
 
 
To specify the DeleteAll interaction for an EIS one-to-many mapping, use this procedure:
 
To specify the DeleteAll interaction for an EIS one-to-many mapping, use this procedure:
 
 
# Select the mapped attribute in the '''Navigator'''. Its properties appear in the Editor.
 
# Select the mapped attribute in the '''Navigator'''. Its properties appear in the Editor.
 
# Click the '''Delete All Interaction''' tab. The Delete All Interaction tab appears.<span id="Figure 80-2"></span><br>''''' Delete All Interaction Tab'''''<br>[[Image:deletealltab.gif|Delete All Interaction Tab]]<br><br>
 
# Click the '''Delete All Interaction''' tab. The Delete All Interaction tab appears.<span id="Figure 80-2"></span><br>''''' Delete All Interaction Tab'''''<br>[[Image:deletealltab.gif|Delete All Interaction Tab]]<br><br>
Line 250: Line 238:
 
[[Category: Draft]]
 
[[Category: Draft]]
 
[[Category: Task]]
 
[[Category: Task]]
 +
[[Category: EIS]]

Revision as of 12:12, 17 December 2007

This section describes the various components that you must configure in order to use an EIS one-to-many mapping.

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

This table lists the configurable options for an EIS one-to-many mapping.


Option to Configure Workbench
Java

Reference descriptors

Supported

Supported

Foreign key pairs

Supported

Supported

Bidirectional relationship

Supported

Supported

Method or direct field access at the mapping level

Supported

Supported

Read-only mappings

Supported

Supported

Private or independent relationships

Supported

Supported

Indirection (lazy loading)

Supported

Supported

Container policy

Supported

Supported

Mapping comments

Supported

Supported

Selection interaction

Supported

Supported

Delete all interactions

Supported

Supported


For more information, see the following:


Configuring Foreign Key Pairs

In a one-to-many EIS mapping, you relate a source object attribute to a target object attribute by specifying one or more pairs of source and target object fields.

In a one-to-many EIS mapping with key on source (see EIS One-to-Many Mappings with Key on Source) using XML records, EclipseLink puts the target XML field value into the source object's record as a simple value. By default, these values are not grouped, as this example shows.


Source Object XML Record without Grouping

<employee>

    <name>Jane</name>
    <project-id>3</project-id>
    <project-id>4</project-id>
</employee>


If you specify more than one source and target XML field pair, you must specify a grouping element, as this example shows.


Source Object XML Record with Grouping

<employee>
    <name>Jane</name>

    <project>
        <project-id>3</project-id>
        <project-name>Project 3</project-name>
    </project>
    <project>

        <project-id>4</project-id>
        <project-name>Project 4</project-name>
    </project>
</employee>


In a one-to-one EIS mapping with key on target (see EIS One-to-Many Mappings with Key on Target) using XML records, EclipseLink uses the source XML field value in the selection interaction to acquire the appropriate instances of target object.


How to Configure Foreign Key Pairs Using Workbench

To specify the source and target XML field pairs for a one-to-many EIS mapping, use this procedure:

  1. Select the one-to-one EIS mapping in the Navigator. Its properties appear in the Editor.
  2. Click the General tab. The General tab appears.
    Foreign Keys Field on General Tab
    Foreign Keys Field on General Tab

  3. Complete the Foreign Keys fields on the General tab.

Use the following information to complete the Foreign Keys fields on the General tab:

Field Description
Foreign Keys Located On Target

Select if you are creating a one-to-many EIS mapping with key on target (see EIS One-to-Many Mappings with Key on Target).

Foreign Keys Located On Source

Select if you are creating a one-to-many EIS mapping with key on source (see EIS One-to-Many Mappings with Key on Source).

Grouping Element

Specify the element in which foreign key pairs are grouped in the source object's EIS record. If you specify only one pair of source and target XML fields, this is optional.

If you specify more than one pair of source and target XML fields, this is required.

Field Pairs

Click Add to add a pair of source and target XML fields. Specify Field Pair dialog box opens. Click Browse to add a foreign key for the Source XPath and Target XPath fields.


Configuring Delete All Interactions

The EclipseLink query and expression framework supports delete all queries. If your JCA adapter provides access to an EIS Delete All function, you can configure a delete all interaction to support EclipseLink delete all queries.


How to Configure Delete All Interactions Using Workbench

To specify the DeleteAll interaction for an EIS one-to-many mapping, use this procedure:

  1. Select the mapped attribute in the Navigator. Its properties appear in the Editor.
  2. Click the Delete All Interaction tab. The Delete All Interaction tab appears.
    Delete All Interaction Tab
    Delete All Interaction Tab

  3. Complete the fields on the Delete All Interaction tab.

Use the following information to enter data in each field on the Delete All Interaction tab:

Field Description
Function Name The name of the EIS function that this call type (Read Object or Read All) invokes on the EIS.
Input Record Name The name passed to the JCA adapter when creating the input record.
Input Root Element Name The root element name to use for the input DOM.
Input Arguments

The query argument name to map to the interaction field or XPath nodes in the argument record. For example, if you are using XML records, use this option to map input argument name to the XPath name/first-name.

Output Arguments

The result record field or XPath nodes to map to the correct nodes in the record used by the descriptor's mappings. For example, if you are using XML records, use this option to map the output fname to name/first-name.Output arguments are not required if the interaction returns an XML result that matches the descriptor's mappings.

Input Result Path

Use this option if the EIS interaction expects the interaction arguments to be nested in the XML record. For example, specify arguments, if the arguments were to be nested under the root element exec-find-order, then under an arguments element.

Output Result Path The name of the EIS function that this call type (Read Object or Read All) invokes on the EIS.
Properties Any properties required by your EIS platform. For example, property name operation (from AQPlatform.QUEUE_OPERATION) and property value enqueue (from AQPlatform.ENQUEUE).





Copyright Statement

Copyright © Eclipse Foundation, Inc. All Rights Reserved.