Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Configuring an EIS Descriptor (ELUG)"
m (→Configuring an EIS Descriptor as a Root or Composite Type) |
m |
||
Line 4: | Line 4: | ||
For information on how to configure descriptor options common to two or more descriptor types, see [[Configuring%20a%20Descriptor%20(ELUG)|Configuring a Descriptor]]. | For information on how to configure descriptor options common to two or more descriptor types, see [[Configuring%20a%20Descriptor%20(ELUG)|Configuring a Descriptor]]. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
This table lists the default configurable options for an EIS descriptor. | This table lists the default configurable options for an EIS descriptor. | ||
Line 15: | Line 9: | ||
<span id="Table 72-1"></span> | <span id="Table 72-1"></span> | ||
− | |||
− | |||
{| class="RuleFormalMax" dir="ltr" title="Configurable Options for EIS Descriptor" summary="This table lists the configurable options common to EIS descriptors" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all" | {| class="RuleFormalMax" dir="ltr" title="Configurable Options for EIS Descriptor" summary="This table lists the configurable options common to EIS descriptors" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all" | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
Line 24: | Line 16: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r2c1-t2" headers="r1c1-t2" align="left" | | | id="r2c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Using%20Workbench%20(ELUG)#How to Configure XML Schema Namespace|How to Configure XML Schema Namespace]] | |
| headers="r2c1-t2 r1c2-t2" align="left" | | | headers="r2c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 31: | Line 23: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r3c1-t2" headers="r1c1-t2" align="left" | | | id="r3c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Using%20Workbench%20(ELUG)#How to Configure an XML Schema Reference|How to Configure an XML Schema Reference]] | |
| headers="r3c1-t2 r1c2-t2" align="left" | | | headers="r3c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 38: | Line 30: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r4c1-t2" headers="r1c1-t2" align="left" | | | id="r4c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[#Configuring Schema Context for an EIS Descriptor|Configuring Schema Context for an EIS Descriptor]] | |
| headers="r4c1-t2 r1c2-t2" align="left" | | | headers="r4c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 45: | Line 37: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r5c1-t2" headers="r1c1-t2" align="left" | | | id="r5c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[#Configuring Default Root Element|Configuring Default Root Element]] | |
| headers="r5c1-t2 r1c2-t2" align="left" | | | headers="r5c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 52: | Line 44: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r6c1-t2" headers="r1c1-t2" align="left" | | | id="r6c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Primary Keys|Configuring Primary Keys]] <sup>Foot 1 </sup> | |
| headers="r6c1-t2 r1c2-t2" align="left" | | | headers="r6c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 59: | Line 51: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r7c1-t2" headers="r1c1-t2" align="left" | | | id="r7c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Read-Only Descriptors|Configuring Read-Only Descriptors]] | |
| headers="r7c1-t2 r1c2-t2" align="left" | | | headers="r7c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 66: | Line 58: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r8c1-t2" headers="r1c1-t2" align="left" | | | id="r8c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Unit of Work Conforming at the Descriptor Level|Configuring Unit of Work Conforming at the Descriptor Level]] | |
| headers="r8c1-t2 r1c2-t2" align="left" | | | headers="r8c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 73: | Line 65: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r9c1-t2" headers="r1c1-t2" align="left" | | | id="r9c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Descriptor Alias|Configuring Descriptor Alias|Configuring Descriptor Alias]] | |
| headers="r9c1-t2 r1c2-t2" align="left" | | | headers="r9c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 80: | Line 72: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r10c1-t2" headers="r1c1-t2" align="left" | | | id="r10c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Descriptor Comments|Configuring Descriptor Comments]]) | |
| headers="r10c1-t2 r1c2-t2" align="left" | | | headers="r10c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 87: | Line 79: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r11c1-t2" headers="r1c1-t2" align="left" | | | id="r11c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[#Configuring Record Format|Configuring Record Format]] | |
| headers="r11c1-t2 r1c2-t2" align="left" | | | headers="r11c1-t2 r1c2-t2" align="left" | | ||
[[Image:unsupport.gif|Unsupported.]]<br> | [[Image:unsupport.gif|Unsupported.]]<br> | ||
Line 94: | Line 86: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r12c1-t2" headers="r1c1-t2" align="left" | | | id="r12c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Using%20Workbench%20(ELUG)#How to Create |How to Create Classes]] | |
| headers="r12c1-t2 r1c2-t2" align="left" | | | headers="r12c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 101: | Line 93: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r13c1-t2" headers="r1c1-t2" align="left" | | | id="r13c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Named Queries at the Descriptor Level|Configuring Named Queries at the Descriptor Level]] | |
| headers="r13c1-t2 r1c2-t2" align="left" | | | headers="r13c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported.]]<br> | [[Image:support.gif|Supported.]]<br> | ||
Line 108: | Line 100: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r14c1-t2" headers="r1c1-t2" align="left" | | | id="r14c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[#Configuring Custom EIS Interactions for Basic Persistence Operations|Configuring Custom EIS Interactions for Basic Persistence Operations]] | |
| headers="r14c1-t2 r1c2-t2" align="left" | | | headers="r14c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported.]]<br> | [[Image:support.gif|Supported.]]<br> | ||
Line 115: | Line 107: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r15c1-t2" headers="r1c1-t2" align="left" | | | id="r15c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Cache Refreshing|Configuring Cache Refreshing]] | |
| headers="r15c1-t2 r1c2-t2" align="left" | | | headers="r15c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 122: | Line 114: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r16c1-t2" headers="r1c1-t2" align="left" | | | id="r16c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Cache Type and Size at the Descriptor Level|Configuring Cache Type and Size at the Descriptor Level]] | |
| headers="r16c1-t2 r1c2-t2" align="left" | | | headers="r16c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 129: | Line 121: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r17c1-t2" headers="r1c1-t2" align="left" | | | id="r17c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Cache Isolation at the Descriptor Level|Configuring Cache Isolation at the Descriptor Level]] | |
| headers="r17c1-t2 r1c2-t2" align="left" | | | headers="r17c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported.]]<br> | [[Image:support.gif|Supported.]]<br> | ||
Line 136: | Line 128: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r18c1-t2" headers="r1c1-t2" align="left" | | | id="r18c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Cache Coordination Change Propagation at the Descriptor Level|Configuring Cache Coordination Change Propagation at the Descriptor Level]] | |
| headers="r18c1-t2 r1c2-t2" align="left" | | | headers="r18c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported.]]<br> | [[Image:support.gif|Supported.]]<br> | ||
Line 143: | Line 135: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r19c1-t2" headers="r1c1-t2" align="left" | | | id="r19c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Cache Expiration at the Descriptor Level|Configuring Cache Expiration at the Descriptor Level]] | |
| headers="r19c1-t2 r1c2-t2" align="left" | | | headers="r19c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported.]]<br> | [[Image:support.gif|Supported.]]<br> | ||
Line 150: | Line 142: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r20c1-t2" headers="r1c1-t2" align="left" | | | id="r20c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Cache Existence Checking at the Descriptor Level|Configuring Cache Existence Checking at the Descriptor Level]] | |
| headers="r20c1-t2 r1c2-t2" align="left" | | | headers="r20c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported.]]<br> | [[Image:support.gif|Supported.]]<br> | ||
Line 157: | Line 149: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r22c1-t2" headers="r1c1-t2" align="left" | | | id="r22c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[#Configuring an EIS Descriptor as a Root or Composite Type|Configuring an EIS Descriptor as a Root or Composite Type]] | |
| headers="r22c1-t2 r1c2-t2" align="left" | | | headers="r22c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 164: | Line 156: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r23c1-t2" headers="r1c1-t2" align="left" | | | id="r23c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Inheritance for a Child (Branch or Leaf) Class Descriptor|Configuring Inheritance for a Child (Branch or Leaf) Class Descriptor]] | |
| headers="r23c1-t2 r1c2-t2" align="left" | | | headers="r23c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported.]]<br> | [[Image:support.gif|Supported.]]<br> | ||
Line 171: | Line 163: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r24c1-t2" headers="r1c1-t2" align="left" | | | id="r24c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Inheritance for a Parent (Root) Descriptor|Configuring Inheritance for a Parent (Root) Descriptor]] | |
| headers="r24c1-t2 r1c2-t2" align="left" | | | headers="r24c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 178: | Line 170: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r25c1-t2" headers="r1c1-t2" align="left" | | | id="r25c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Inherited Attribute Mapping in a Subclass|Configuring Inherited Attribute Mapping in a Subclass]] | |
| headers="r25c1-t2 r1c2-t2" align="left" | | | headers="r25c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported.]]<br> | [[Image:support.gif|Supported.]]<br> | ||
Line 185: | Line 177: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r26c1-t2" headers="r1c1-t2" align="left" | | | id="r26c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring a Domain Object Method as an Event Handler|Configuring a Domain Object Method as an Event Handler]] | |
| headers="r26c1-t2 r1c2-t2" align="left" | | | headers="r26c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported.]]<br> | [[Image:support.gif|Supported.]]<br> | ||
Line 192: | Line 184: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r27c1-t2" headers="r1c1-t2" align="left" | | | id="r27c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring a Descriptor Event Listener as an Event Handler|Configuring a Descriptor Event Listener as an Event Handler]] | |
| headers="r27c1-t2 r1c2-t2" align="left" | | | headers="r27c1-t2 r1c2-t2" align="left" | | ||
[[Image:unsupport.gif|Unsupported.]]<br> | [[Image:unsupport.gif|Unsupported.]]<br> | ||
Line 199: | Line 191: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r28c1-t2" headers="r1c1-t2" align="left" | | | id="r28c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Locking Policy|Configuring Locking Policy]] | |
| headers="r28c1-t2 r1c2-t2" align="left" | | | headers="r28c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 206: | Line 198: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r29c1-t2" headers="r1c1-t2" align="left" | | | id="r29c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Returning Policy|Configuring Returning Policy]] | |
| headers="r29c1-t2 r1c2-t2" align="left" | | | headers="r29c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 213: | Line 205: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r30c1-t2" headers="r1c1-t2" align="left" | | | id="r30c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Instantiation Policy|Configuring Instantiation Policy]] | |
| headers="r30c1-t2 r1c2-t2" align="left" | | | headers="r30c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 220: | Line 212: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r31c1-t2" headers="r1c1-t2" align="left" | | | id="r31c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Copy Policy|Configuring Copy Policy]] | |
| headers="r31c1-t2 r1c2-t2" align="left" | | | headers="r31c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 227: | Line 219: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r32c1-t2" headers="r1c1-t2" align="left" | | | id="r32c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Change Policy|Configuring Change Policy]] | |
| headers="r32c1-t2 r1c2-t2" align="left" | | | headers="r32c1-t2 r1c2-t2" align="left" | | ||
[[Image:unsupport.gif|Unsupported.]]<br> | [[Image:unsupport.gif|Unsupported.]]<br> | ||
Line 234: | Line 226: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r33c1-t2" headers="r1c1-t2" align="left" | | | id="r33c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Wrapper Policy|Configuring Wrapper Policy]] | |
| headers="r33c1-t2 r1c2-t2" align="left" | | | headers="r33c1-t2 r1c2-t2" align="left" | | ||
[[Image:unsupport.gif|Unsupported.]]<br> | [[Image:unsupport.gif|Unsupported.]]<br> | ||
Line 241: | Line 233: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r34c1-t2" headers="r1c1-t2" align="left" | | | id="r34c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Amendment Methods|Configuring Amendment Methods]] | |
| headers="r34c1-t2 r1c2-t2" align="left" | | | headers="r34c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 248: | Line 240: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r35c1-t2" headers="r1c1-t2" align="left" | | | id="r35c1-t2" headers="r1c1-t2" align="left" | | ||
− | + | [[Configuring%20a%20Mapping%20(ELUG)|Configuring a Mapping]] | |
| headers="r35c1-t2 r1c2-t2" align="left" | | | headers="r35c1-t2 r1c2-t2" align="left" | | ||
[[Image:support.gif|Supported]]<br> | [[Image:support.gif|Supported]]<br> | ||
Line 262: | Line 254: | ||
==Configuring Schema Context for an EIS Descriptor== | ==Configuring Schema Context for an EIS Descriptor== | ||
− | |||
Workbench uses the schema context to associate the class that the EIS descriptor describes with a simple or complex type in one of the schemas associated with the EIS project (see [[Using%20Workbench%20(ELUG)#How to Configure an XML Schema Reference|How to Configure an XML Schema Reference]]). This allows Workbench to display the appropriate attributes available for mapping in that context. | Workbench uses the schema context to associate the class that the EIS descriptor describes with a simple or complex type in one of the schemas associated with the EIS project (see [[Using%20Workbench%20(ELUG)#How to Configure an XML Schema Reference|How to Configure an XML Schema Reference]]). This allows Workbench to display the appropriate attributes available for mapping in that context. | ||
Line 270: | Line 261: | ||
===How to Configure Schema Context for an EIS Descriptor Using Workbench=== | ===How to Configure Schema Context for an EIS Descriptor Using Workbench=== | ||
− | |||
To associate an EIS descriptor with a simple or complex type in this project's schema, use this procedure: | To associate an EIS descriptor with a simple or complex type in this project's schema, use this procedure: | ||
− | |||
# Select an EIS descriptor in the '''Navigator'''. Its properties appear in the Editor. | # Select an EIS descriptor in the '''Navigator'''. Its properties appear in the Editor. | ||
# Click the '''Descriptor Info''' tab. The Descriptor Info tab appears.<br><span id="Figure 72-1"></span>''''' Descriptor Info Tab, Schema Context Option'''''<br>[[Image:desschcx.gif|Descriptor Info Tab, Schema Context Option]]<br><br> | # Click the '''Descriptor Info''' tab. The Descriptor Info tab appears.<br><span id="Figure 72-1"></span>''''' Descriptor Info Tab, Schema Context Option'''''<br>[[Image:desschcx.gif|Descriptor Info Tab, Schema Context Option]]<br><br> | ||
# Complete the '''Schema Context''' option on the tab. | # Complete the '''Schema Context''' option on the tab. | ||
− | + | #Click '''Browse''' to select the schema element to associate with this descriptor. For more information, see [[#Configuring a Schema Context|Configuring a Schema Context]]. | |
− | Click '''Browse''' to select the schema element to associate with this descriptor. For more information, see [[#Configuring a Schema Context|Configuring a Schema Context]]. | + | |
====Choosing a Schema Context==== | ====Choosing a Schema Context==== | ||
− | |||
Use the Choose Schema Context dialog box to select a specific schema element (such as when mapping an element). | Use the Choose Schema Context dialog box to select a specific schema element (such as when mapping an element). | ||
Line 296: | Line 283: | ||
===How to Configure Schema Context for an EIS Descriptor Using Java=== | ===How to Configure Schema Context for an EIS Descriptor Using Java=== | ||
− | |||
For an EIS descriptor, the EclipseLink runtime does not need the schema context: the runtime can determine the schema context based on the mappings you configure on the descriptor. No further configuration is required. | For an EIS descriptor, the EclipseLink runtime does not need the schema context: the runtime can determine the schema context based on the mappings you configure on the descriptor. No further configuration is required. | ||
Line 302: | Line 288: | ||
==Configuring Default Root Element== | ==Configuring Default Root Element== | ||
− | |||
You must configure the default root element for an EIS root descriptor (see [[Creating%20an%20EIS%20Descriptor%20(ELUG)#EIS Root Descriptors|EIS Root Descriptors]]) so that the EclipseLink runtime knows the data source data type associated with the class the descriptor describes. Descriptors used only in composite relationship mappings do not require a default root element. | You must configure the default root element for an EIS root descriptor (see [[Creating%20an%20EIS%20Descriptor%20(ELUG)#EIS Root Descriptors|EIS Root Descriptors]]) so that the EclipseLink runtime knows the data source data type associated with the class the descriptor describes. Descriptors used only in composite relationship mappings do not require a default root element. | ||
Line 319: | Line 304: | ||
===How to Configure Default Root Element Using Workbench=== | ===How to Configure Default Root Element Using Workbench=== | ||
− | |||
When you create an EIS project using Workbench, you must use XML records. Consequently, you must configure a default root element so that Workbench knows what element to start with when persisting an instance of the class that the EIS descriptor describes. | When you create an EIS project using Workbench, you must use XML records. Consequently, you must configure a default root element so that Workbench knows what element to start with when persisting an instance of the class that the EIS descriptor describes. | ||
To specify a schema element as the default root element for the descriptor, use this procedure: | To specify a schema element as the default root element for the descriptor, use this procedure: | ||
− | |||
# Select a descriptor in the '''Navigator'''. Its properties appear in the Editor. | # Select a descriptor in the '''Navigator'''. Its properties appear in the Editor. | ||
# Click the '''Descriptor Info''' tab. The Descriptor Info tab appears.<br><span id="Figure 72-3"></span>''''' Descriptor Info Tab, Default Root Element Option'''''<br>[[Image:didocroot.gif|Descriptor Info Tab, Default Root Element Option]]<br><br> | # Click the '''Descriptor Info''' tab. The Descriptor Info tab appears.<br><span id="Figure 72-3"></span>''''' Descriptor Info Tab, Default Root Element Option'''''<br>[[Image:didocroot.gif|Descriptor Info Tab, Default Root Element Option]]<br><br> | ||
+ | #Use the '''Default Root Element''' option to select the root element for this descriptor. Click '''Browse''' to select the schema element to identify as the root element. See [[#onfiguring a Root Element|Configuring a Root Element]] for more information. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
====Choosing a Root Element==== | ====Choosing a Root Element==== | ||
− | |||
Use the Choose Root Element dialog box to select a specific root element. | Use the Choose Root Element dialog box to select a specific root element. | ||
Line 352: | Line 329: | ||
===How to Configure Default Root Element Using Java=== | ===How to Configure Default Root Element Using Java=== | ||
− | |||
When you create an EIS project using Java code, use the <tt>EISDescriptor</tt> method <tt>setDataTypeName</tt> to specify the XML schema complex type name (if you are using XML records) or the JCA record name (if you are using indexed or mapped records) corresponding to the class that the EIS descriptor describes. For more information, see ''EclipseLink API Reference''. | When you create an EIS project using Java code, use the <tt>EISDescriptor</tt> method <tt>setDataTypeName</tt> to specify the XML schema complex type name (if you are using XML records) or the JCA record name (if you are using indexed or mapped records) corresponding to the class that the EIS descriptor describes. For more information, see ''EclipseLink API Reference''. | ||
Line 358: | Line 334: | ||
==Configuring Record Format== | ==Configuring Record Format== | ||
− | |||
The EIS descriptor record format determines the EIS record type to which the descriptor's EIS mappings map. | The EIS descriptor record format determines the EIS record type to which the descriptor's EIS mappings map. | ||
Line 367: | Line 342: | ||
<span id="Table 72-2"></span> | <span id="Table 72-2"></span> | ||
− | |||
− | |||
{| class="HRuleFormal" dir="ltr" title="EIS Record Formats" summary="This table describes the EIS descriptor methods you use to select the type of EIS record that the descriptor’s mappings map to." width="100%" border="1" frame="hsides" rules="rows" cellpadding="3" frame="hsides" rules="rows" | {| class="HRuleFormal" dir="ltr" title="EIS Record Formats" summary="This table describes the EIS descriptor methods you use to select the type of EIS record that the descriptor’s mappings map to." width="100%" border="1" frame="hsides" rules="rows" cellpadding="3" frame="hsides" rules="rows" | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
Line 387: | Line 360: | ||
<tt>useXMLRecordFormat</tt> | <tt>useXMLRecordFormat</tt> | ||
| headers="r4c1-t4 r1c2-t4" align="left" | | | headers="r4c1-t4 r1c2-t4" align="left" | | ||
− | All EIS mappings owned by this descriptor map to EIS XML records.If you use the XML record format, you must specify one or more XML schemas in your EIS project (see [[Using%20Workbench%20(ELUG)#How to Import an XML Schema|How to Import an XML Schema]]). The EclipseLink runtime performs XML data conversion based on one or more XML schemas. In an EIS XML project, Workbench does not directly reference schemas in the deployment XML, but insteadexports mappings configured with respect to the schemas you specify.For information on EclipseLink support for XML namespaces, see [[Introduction%20to%20Projects (ELUG)#XML Namespaces|XML Namespaces]]. | + | All EIS mappings owned by this descriptor map to EIS XML records.If you use the XML record format, you must specify one or more XML schemas in your EIS project (see [[Using%20Workbench%20(ELUG)#How to Import an XML Schema|How to Import an XML Schema]]). The EclipseLink runtime performs XML data conversion based on one or more XML schemas. In an EIS XML project, Workbench does not directly reference schemas in the deployment XML, but insteadexports mappings configured with respect to the schemas you specify. |
+ | |||
+ | For information on EclipseLink support for XML namespaces, see [[Introduction%20to%20Projects (ELUG)#XML Namespaces|XML Namespaces]]. | ||
|} | |} | ||
Line 397: | Line 372: | ||
===How to Configure Record Format Using Java=== | ===How to Configure Record Format Using Java=== | ||
− | + | To configure the EIS record format for an EIS descriptor, use one of the <tt>EISDescriptor</tt> methods listed in the [[#Table 72-2|EIS Record Formats]] table, as shown in this example. | |
− | To configure the EIS record format for an EIS descriptor, use one of the <tt>EISDescriptor</tt> methods listed in [[#Table 72-2|EIS Record Formats]], as shown in this example. | + | |
Line 406: | Line 380: | ||
descriptor.useIndexedRecordFormat(); | descriptor.useIndexedRecordFormat(); | ||
− | |||
+ | |||
+ | ==Configuring Custom EIS Interactions for Basic Persistence Operations== | ||
You can use EclipseLink to define an interaction for each basic persistence operation ('''insert''', '''update''', '''delete''', '''read object''', '''read all''', or '''does exist''') so that when you query and modify your EIS-mapped objects, the EclipseLink runtime will use the appropriate EIS interaction instead of the default EIS interaction. | You can use EclipseLink to define an interaction for each basic persistence operation ('''insert''', '''update''', '''delete''', '''read object''', '''read all''', or '''does exist''') so that when you query and modify your EIS-mapped objects, the EclipseLink runtime will use the appropriate EIS interaction instead of the default EIS interaction. | ||
Line 423: | Line 398: | ||
|} | |} | ||
− | + | ||
+ | |||
===How to Configure Custom EIS Interactions for Basic Persistence Operations Using Workbench=== | ===How to Configure Custom EIS Interactions for Basic Persistence Operations Using Workbench=== | ||
− | |||
To configure custom EIS interactions for basic persistence operations, use the following procedure: | To configure custom EIS interactions for basic persistence operations, use the following procedure: | ||
− | |||
# In the '''Navigator''', select an EIS root descriptor in a EIS project. | # In the '''Navigator''', select an EIS root descriptor in a EIS project. | ||
# Click the '''Queries''' tab in the '''Editor'''. The Queries tab appears. | # Click the '''Queries''' tab in the '''Editor'''. The Queries tab appears. | ||
Line 479: | Line 453: | ||
===How to Configure Custom EIS Interactions for Basic Persistence Operations Using Java=== | ===How to Configure Custom EIS Interactions for Basic Persistence Operations Using Java=== | ||
− | |||
Using Java, you can create any type of EIS interaction that EclipseLink supports (see [[Using%20Basic%20Query%20API%20(ELUG)#Using EIS Interactions|Using EIS Interactions]]). | Using Java, you can create any type of EIS interaction that EclipseLink supports (see [[Using%20Basic%20Query%20API%20(ELUG)#Using EIS Interactions|Using EIS Interactions]]). | ||
Line 520: | Line 493: | ||
==Configuring an EIS Descriptor as a Root or Composite Type== | ==Configuring an EIS Descriptor as a Root or Composite Type== | ||
− | |||
You can designate an EIS descriptor as root (see [[Creating%20an%20EIS%20Descriptor%20(ELUG)#EIS Root Descriptors|EIS Root Descriptors]]) or composite (see [[Creating%20an%20EIS%20Descriptor%20(ELUG)#EIS Composite Descriptors|EIS Composite Descriptors]]). | You can designate an EIS descriptor as root (see [[Creating%20an%20EIS%20Descriptor%20(ELUG)#EIS Root Descriptors|EIS Root Descriptors]]) or composite (see [[Creating%20an%20EIS%20Descriptor%20(ELUG)#EIS Composite Descriptors|EIS Composite Descriptors]]). | ||
Line 539: | Line 511: | ||
===How to Configure an EIS Descriptor as a Root or Composite Type Using Workbench=== | ===How to Configure an EIS Descriptor as a Root or Composite Type Using Workbench=== | ||
− | |||
To configure an EIS descriptor as a root or composite EIS descriptor, use this procedure: | To configure an EIS descriptor as a root or composite EIS descriptor, use this procedure: | ||
− | |||
# In the '''Navigator''', select an EIS composite descriptor. | # In the '''Navigator''', select an EIS composite descriptor. | ||
# Click the '''Root''' or '''Composite''' descriptor button on the mapping toolbar.You can also select the descriptor and choose '''Selected''' > '''Descriptor Type''' > '''Root''' or '''Composite''' from the menu or by right-clicking on the descriptor in the '''Navigator''' and selecting '''Descriptor Type''' > '''Root''' or '''Composite''' from the context menu. | # Click the '''Root''' or '''Composite''' descriptor button on the mapping toolbar.You can also select the descriptor and choose '''Selected''' > '''Descriptor Type''' > '''Root''' or '''Composite''' from the menu or by right-clicking on the descriptor in the '''Navigator''' and selecting '''Descriptor Type''' > '''Root''' or '''Composite''' from the context menu. | ||
Line 548: | Line 518: | ||
===How to Configure an EIS Descriptor as a Root or Composite Type Using Java=== | ===How to Configure an EIS Descriptor as a Root or Composite Type Using Java=== | ||
− | |||
To configure an EIS descriptor as root or composite using Java, create a descriptor amendment method (see [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Amendment Methods|Configuring Amendment Methods]]) and use the following <tt>EISDescriptor</tt> methods: | To configure an EIS descriptor as root or composite using Java, create a descriptor amendment method (see [[Configuring%20a%20Descriptor%20(ELUG)#Configuring Amendment Methods|Configuring Amendment Methods]]) and use the following <tt>EISDescriptor</tt> methods: | ||
Line 563: | Line 532: | ||
[[Category: Draft]] | [[Category: Draft]] | ||
[[Category: Task]] | [[Category: Task]] | ||
+ | [[Category: EIS]] |
Revision as of 11:52, 17 December 2007
Contents
This section describes the various components that you must configure in order to use an EIS descriptor.
For information on how to configure descriptor options common to two or more descriptor types, see Configuring a Descriptor.
This table lists the default configurable options for an EIS descriptor.
Footnote 1 EIS root descriptors only (see Configuring an EIS Descriptor as a Root or Composite Type).
For more information, see Introduction to EIS Descriptors.
Configuring Schema Context for an EIS Descriptor
Workbench uses the schema context to associate the class that the EIS descriptor describes with a simple or complex type in one of the schemas associated with the EIS project (see How to Configure an XML Schema Reference). This allows Workbench to display the appropriate attributes available for mapping in that context.
You must configure the schema context for an EIS root descriptor (see Configuring an EIS Descriptor as a Root or Composite Type) only if you are using the Workbench.
How to Configure Schema Context for an EIS Descriptor Using Workbench
To associate an EIS descriptor with a simple or complex type in this project's schema, use this procedure:
- Select an EIS descriptor in the Navigator. Its properties appear in the Editor.
- Click the Descriptor Info tab. The Descriptor Info tab appears.
Descriptor Info Tab, Schema Context Option - Complete the Schema Context option on the tab.
- Click Browse to select the schema element to associate with this descriptor. For more information, see Configuring a Schema Context.
Choosing a Schema Context
Use the Choose Schema Context dialog box to select a specific schema element (such as when mapping an element).
Choose Schema Context Dialog Box
Select the schema element and click OK.
How to Configure Schema Context for an EIS Descriptor Using Java
For an EIS descriptor, the EclipseLink runtime does not need the schema context: the runtime can determine the schema context based on the mappings you configure on the descriptor. No further configuration is required.
Configuring Default Root Element
You must configure the default root element for an EIS root descriptor (see EIS Root Descriptors) so that the EclipseLink runtime knows the data source data type associated with the class the descriptor describes. Descriptors used only in composite relationship mappings do not require a default root element.
Note: Although you select an element from your project's schema to configure this attribute, you are choosing the element's simple or complex type. |
For more information, see Default Root Element.
How to Configure Default Root Element Using Workbench
When you create an EIS project using Workbench, you must use XML records. Consequently, you must configure a default root element so that Workbench knows what element to start with when persisting an instance of the class that the EIS descriptor describes.
To specify a schema element as the default root element for the descriptor, use this procedure:
- Select a descriptor in the Navigator. Its properties appear in the Editor.
- Click the Descriptor Info tab. The Descriptor Info tab appears.
Descriptor Info Tab, Default Root Element Option - Use the Default Root Element option to select the root element for this descriptor. Click Browse to select the schema element to identify as the root element. See Configuring a Root Element for more information.
Choosing a Root Element
Use the Choose Root Element dialog box to select a specific root element.
Choose Root Element Dialog Box
Select the root element and click OK.
How to Configure Default Root Element Using Java
When you create an EIS project using Java code, use the EISDescriptor method setDataTypeName to specify the XML schema complex type name (if you are using XML records) or the JCA record name (if you are using indexed or mapped records) corresponding to the class that the EIS descriptor describes. For more information, see EclipseLink API Reference.
Configuring Record Format
The EIS descriptor record format determines the EIS record type to which the descriptor's EIS mappings map.
When you create an EIS project using Workbench, EclipseLink configures all EIS descriptors with a record format of XML.
When you create an EIS project in Java, you can configure the EIS descriptor record type to any of the supported types, as this table shows.
EISDescriptor Method | EIS Record Type |
---|---|
useMappedRecordFormat |
All EIS mappings owned by this descriptor map to EIS mapped records. |
useIndexedRecordFormat |
All EIS mappings owned by this descriptor map to EIS indexed records. |
useXMLRecordFormat |
All EIS mappings owned by this descriptor map to EIS XML records.If you use the XML record format, you must specify one or more XML schemas in your EIS project (see How to Import an XML Schema). The EclipseLink runtime performs XML data conversion based on one or more XML schemas. In an EIS XML project, Workbench does not directly reference schemas in the deployment XML, but insteadexports mappings configured with respect to the schemas you specify. For information on EclipseLink support for XML namespaces, see XML Namespaces. |
For more information, see EIS Record Type.
How to Configure Record Format Using Java
To configure the EIS record format for an EIS descriptor, use one of the EISDescriptor methods listed in the EIS Record Formats table, as shown in this example.
Configuring EISDescriptor Record Format
EISDescriptor descriptor = new EISDescriptor(); descriptor.useIndexedRecordFormat();
Configuring Custom EIS Interactions for Basic Persistence Operations
You can use EclipseLink to define an interaction for each basic persistence operation (insert, update, delete, read object, read all, or does exist) so that when you query and modify your EIS-mapped objects, the EclipseLink runtime will use the appropriate EIS interaction instead of the default EIS interaction.
You can configure custom EIS interactions for basic persistence operations only for EIS descriptors designated as root descriptors ( Configuring an EIS Descriptor as a Root or Composite Type).
Using Workbench, you can create XMLInteraction objects, in which there is a single query per interaction (see How to Configure Custom EIS Interactions for Basic Persistence Operations Using Workbench).
Using Java, you can create any EISInteraction type. For some EIS projects, it is common for multiple interactions to be used in a single query. For example, one interaction–to enqueue a request, and another–to dequeue the response. Because Workbench does not support setting multiple interactions on a single query, you must use an amendment method to create and configure the interaction in Java (see How to Configure Custom EIS Interactions for Basic Persistence Operations Using Java).
Note: In a one-to-one or one-to-many EIS mapping, you must also specify a selection interaction that EclipseLink uses to acquire target objects. You can use either the target object's read interaction (the default) or specify a separate selection interaction, if necessary. For more information, see Configuring Selection Interaction). |
How to Configure Custom EIS Interactions for Basic Persistence Operations Using Workbench
To configure custom EIS interactions for basic persistence operations, use the following procedure:
- In the Navigator, select an EIS root descriptor in a EIS project.
- Click the Queries tab in the Editor. The Queries tab appears.
- Click the Custom Calls tab. The Custom Calls tab appears.
Queries, Custom Calls Tab for EIS Calls - Click the appropriate interaction type from the list (Insert, Update, Delete, Read Object, Read All, or Does Exist) and use the following table to enter data in each field
Field | Description |
---|---|
Interaction Type | Using Workbench, you can only use XML Interactions. You cannot change this field. |
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 | 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 |
Use this option if the EIS interaction result record contains the XML data that maps to the objects in a nested structure. For example, specify order, if the results were return under a root element results, then under an order element. |
Properties | Any properties required by your EIS platform. For example, property name operation (from AQPlatform.QUEUE_OPERATION) and property value enqueue (from AQPlatform.ENQUEUE). |
How to Configure Custom EIS Interactions for Basic Persistence Operations Using Java
Using Java, you can create any type of EIS interaction that EclipseLink supports (see Using EIS Interactions).
For some EIS projects, it is common for multiple interactions to be used in a single query: for example, one interaction to enqueue a request and another to dequeue the response. Because Workbench does not support setting multiple interactions on a single query, you must use an amendment method to create and configure the interaction in Java, as this examle shows.
Creating an XML Interaction for an AQ Platform
public static void addXMLInteractions(ClassDescriptor descriptor) { // find order interaction XMLInteraction request = new XMLInteraction(); request.setProperty(AQPlatform.QUEUE_OPERATION, AQPlatform.ENQUEUE); request.setProperty(AQPlatform.QUEUE, "ORDER_INBOUND_QUEUE"); request.setProperty(AQPlatform.SCHEMA, "AQUSER"); request.setInputRootElementName("READ_ORDER"); request.addArgument("@id"); XMLInteraction response = new XMLInteraction(); response.setProperty(AQPlatform.QUEUE_OPERATION, AQPlatform.DEQUEUE); response.setProperty(AQPlatform.QUEUE, "ORDER_OUTBOUND_QUEUE"); response.setProperty(AQPlatform.SCHEMA, "AQUSER"); ReadObjectQuery query = new ReadObjectQuery(); query.addCall(request); query.addCall(response); descriptor.getQueryManager().setReadObjectQuery(query); // place order interaction XMLInteraction insert = new XMLInteraction(); insert.setProperty(AQPlatform.QUEUE_OPERATION, AQPlatform.ENQUEUE); insert.setProperty(AQPlatform.QUEUE, "ORDER_INBOUND_QUEUE"); insert.setProperty(AQPlatform.SCHEMA, "AQUSER"); insert.setInputRootElementName("INSERT_ORDER"); descriptor.getQueryManager().setInsertCall(insert); }
Configuring an EIS Descriptor as a Root or Composite Type
You can designate an EIS descriptor as root (see EIS Root Descriptors) or composite (see EIS Composite Descriptors).
When you designate an EIS descriptor as a root, you tell the EclipseLink runtime that the EIS descriptor's reference class is a parent classš–no other class will reference it by way of a composite object mapping or composite collection mapping. Using an EIS root descriptor, you can configure all supported mappings and you can configure the descriptor with EIS interactions (see Using EIS Interactions). However, if you configure the EIS root descriptor with a composite object mapping or composite collection mapping, the reference descriptor you define must be an EIS composite descriptor; it cannot be another EIS root descriptor.
When you designate an EIS descriptor as a composite (the default), you tell the EclipseLink runtime that the EIS descriptor's reference class may be referenced by a composite object or composite collection mapping (see Configuring an EIS Composite Object Mapping and Configuring an EIS Composite Collection Mapping). Using an EIS composite descriptor, you can configure all supported mappings, but you cannot configure it with EIS interactions.
You can configure inheritance for a descriptor designated as a composite (see Configuring Inheritance for a Child (Branch or Leaf) Class Descriptor), however, in this case, all the descriptors in the inheritance tree must be aggregates. Aggregate and class descriptors cannot exist in the same inheritance tree. For more information, see Aggregate and Composite Descriptors and Inheritance.
If you configure a descriptor as a composite using Workbench, you cannot configure the descriptor with EJB information.
For more information, see the following:
How to Configure an EIS Descriptor as a Root or Composite Type Using Workbench
To configure an EIS descriptor as a root or composite EIS descriptor, use this procedure:
- In the Navigator, select an EIS composite descriptor.
- Click the Root or Composite descriptor button on the mapping toolbar.You can also select the descriptor and choose Selected > Descriptor Type > Root or Composite from the menu or by right-clicking on the descriptor in the Navigator and selecting Descriptor Type > Root or Composite from the context menu.
How to Configure an EIS Descriptor as a Root or Composite Type Using Java
To configure an EIS descriptor as root or composite using Java, create a descriptor amendment method (see Configuring Amendment Methods) and use the following EISDescriptor methods:
- To designate an EIS descriptor as a root descriptor, use EISDescriptor method descriptorIsNormal.
- To designate an EIS descriptor as a composite (nonroot) descriptor, use EISDescriptor method descriptorIsAggregate.