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 a Relational Mapping (ELUG)"
m |
m |
||
Line 1: | Line 1: | ||
<div style="float:right;border:1px solid #000000;padding:5px">__TOC__ | <div style="float:right;border:1px solid #000000;padding:5px">__TOC__ | ||
− | [[Special:Whatlinkshere/Configuring a Relational Mapping (ELUG)|Related Topics]]</div> | + | [[Special:Whatlinkshere/Configuring a Relational Mapping (ELUG)|Related Topics]]</div>This section describes how to configure a relational mapping. |
− | + | ||
− | + | ||
− | This section describes how to configure a relational mapping. | + | |
For information on how to configure EclipseLink mappings options common to two or more mapping types, see [[Configuring%20a%20Mapping%20(ELUG)|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)|Configuring a Mapping]]. | ||
For information on how to create EclipseLink mappings, see [[Creating%20a%20Mapping%20(ELUG)|Creating a Mapping]]. | For information on how to create EclipseLink mappings, see [[Creating%20a%20Mapping%20(ELUG)|Creating a Mapping]]. | ||
− | |||
− | |||
− | |||
− | |||
This table lists the types of relational mappings that you can configure and provides a cross-reference to the type-specific chapter that lists the configurable options supported by that type. | This table lists the types of relational mappings that you can configure and provides a cross-reference to the type-specific chapter that lists the configurable options supported by that type. | ||
Line 17: | Line 10: | ||
<span id="Table 33-1"></span> | <span id="Table 33-1"></span> | ||
− | |||
− | |||
{| class="HRuleFormalMax" dir="ltr" title="Configuring Relational Mappings" summary="This table provides a cross-reference to additional configuration options for each specific relational mapping type." width="100%" border="1" frame="hsides" rules="rows" cellpadding="3" frame="hsides" rules="rows" | {| class="HRuleFormalMax" dir="ltr" title="Configuring Relational Mappings" summary="This table provides a cross-reference to additional configuration options for each specific relational mapping type." width="100%" border="1" frame="hsides" rules="rows" cellpadding="3" frame="hsides" rules="rows" | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
Line 25: | 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" | | ||
− | [[Introduction%20to%20Relational%20Mappings%20(ELUG)|Direct-to-Field Mapping]] | + | [[Introduction%20to%20Relational%20Mappings%20(ELUG)#Direct-to-Field Mapping|Direct-to-Field Mapping]] |
| headers="r2c1-t2 r1c2-t2" align="left" | | | headers="r2c1-t2 r1c2-t2" align="left" | | ||
[[Configuring a Relational Direct-to-Field Mapping (ELUG)|Configuring a Relational Direct-to-Field Mapping]] | [[Configuring a Relational Direct-to-Field Mapping (ELUG)|Configuring a Relational Direct-to-Field Mapping]] | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r3c1-t2" headers="r1c1-t2" align="left" | | | id="r3c1-t2" headers="r1c1-t2" align="left" | | ||
− | [[Introduction%20to%20Relational%20Mappings%20(ELUG)|Transformation Mapping]] | + | [[Introduction%20to%20Relational%20Mappings%20(ELUG)#Transformation Mapping|Transformation Mapping]] |
| headers="r3c1-t2 r1c2-t2" align="left" | | | headers="r3c1-t2 r1c2-t2" align="left" | | ||
[[Configuring%20a%20Relational%20Transformation%20Mapping%20(ELUG)|Configuring a Relational Transformation Mapping]] | [[Configuring%20a%20Relational%20Transformation%20Mapping%20(ELUG)|Configuring a Relational Transformation Mapping]] | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r4c1-t2" headers="r1c1-t2" align="left" | | | id="r4c1-t2" headers="r1c1-t2" align="left" | | ||
− | [[Introduction%20to%20Relational%20Mappings%20(ELUG | + | [[Introduction%20to%20Relational%20Mappings%20(ELUG|#Direct-to-XMLType Mapping|Direct-to-XMLType Mapping]] |
| headers="r4c1-t2 r1c2-t2" align="left" | | | headers="r4c1-t2 r1c2-t2" align="left" | | ||
[[Configuring a Relational Direct-to-XMLType Mapping (ELUG)|Configuring a Relational Direct-to-XMLType Mapping]] | [[Configuring a Relational Direct-to-XMLType Mapping (ELUG)|Configuring a Relational Direct-to-XMLType Mapping]] | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r5c1-t2" headers="r1c1-t2" align="left" | | | id="r5c1-t2" headers="r1c1-t2" align="left" | | ||
− | [[Introduction%20to%20Relational%20Mappings%20(ELUG)|One-to-One Mapping]] | + | [[Introduction%20to%20Relational%20Mappings%20(ELUG)#One-to-One Mapping|One-to-One Mapping]] |
| headers="r5c1-t2 r1c2-t2" align="left" | | | headers="r5c1-t2 r1c2-t2" align="left" | | ||
[[Configuring%20a%20Relational%20One-to-One%20Mapping%20(ELUG)|Configuring a Relational One-to-One Mapping]] | [[Configuring%20a%20Relational%20One-to-One%20Mapping%20(ELUG)|Configuring a Relational One-to-One Mapping]] | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r6c1-t2" headers="r1c1-t2" align="left" | | | id="r6c1-t2" headers="r1c1-t2" align="left" | | ||
− | [[Introduction%20to%20Relational%20Mappings%20(ELUG)|Variable One-to-One Mapping]] | + | [[Introduction%20to%20Relational%20Mappings%20(ELUG)#Variable One-to-One Mapping|Variable One-to-One Mapping]] |
| headers="r6c1-t2 r1c2-t2" align="left" | | | headers="r6c1-t2 r1c2-t2" align="left" | | ||
[[Configuring%20a%20Relational%20Variable%20One-to-One%20Mapping%20(ELUG)|Configuring a Relational Variable One-to-One Mapping]] | [[Configuring%20a%20Relational%20Variable%20One-to-One%20Mapping%20(ELUG)|Configuring a Relational Variable One-to-One Mapping]] | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r7c1-t2" headers="r1c1-t2" align="left" | | | id="r7c1-t2" headers="r1c1-t2" align="left" | | ||
− | [[Introduction%20to%20Relational%20Mappings%20(ELUG)|One-to-Many Mapping]] | + | [[Introduction%20to%20Relational%20Mappings%20(ELUG)#One-to-Many Mapping|One-to-Many Mapping]] |
| headers="r7c1-t2 r1c2-t2" align="left" | | | headers="r7c1-t2 r1c2-t2" align="left" | | ||
[[Configuring a Relational One-to-Many Mapping (ELUG)|Configuring a Relational One-to-Many Mapping]] | [[Configuring a Relational One-to-Many Mapping (ELUG)|Configuring a Relational One-to-Many Mapping]] | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r8c1-t2" headers="r1c1-t2" align="left" | | | id="r8c1-t2" headers="r1c1-t2" align="left" | | ||
− | [[Introduction%20to%20Relational%20Mappings%20(ELUG)|Many-to-Many Mapping]] | + | [[Introduction%20to%20Relational%20Mappings%20(ELUG)#Many-to-Many Mapping|Many-to-Many Mapping]] |
| headers="r8c1-t2 r1c2-t2" align="left" | | | headers="r8c1-t2 r1c2-t2" align="left" | | ||
[[Configuring a Relational Many-to-Many Mapping (ELUG)|Configuring a Relational Many-to-Many Mapping]] | [[Configuring a Relational Many-to-Many Mapping (ELUG)|Configuring a Relational Many-to-Many Mapping]] | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r9c1-t2" headers="r1c1-t2" align="left" | | | id="r9c1-t2" headers="r1c1-t2" align="left" | | ||
− | [[Introduction%20to%20Relational%20Mappings%20(ELUG)|Aggregate Collection Mapping]] | + | [[Introduction%20to%20Relational%20Mappings%20(ELUG)#Aggregate Collection Mapping|Aggregate Collection Mapping]] |
| headers="r9c1-t2 r1c2-t2" align="left" | | | headers="r9c1-t2 r1c2-t2" align="left" | | ||
[[Configuring%20a%20Relational%20Aggregate%20Collection%20Mapping%20(ELUG)|Configuring a Relational Aggregate Collection Mapping]] | [[Configuring%20a%20Relational%20Aggregate%20Collection%20Mapping%20(ELUG)|Configuring a Relational Aggregate Collection Mapping]] | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r10c1-t2" headers="r1c1-t2" align="left" | | | id="r10c1-t2" headers="r1c1-t2" align="left" | | ||
− | [[Introduction%20to%20Relational%20Mappings%20(ELUG)|Direct Collection Mapping]] | + | [[Introduction%20to%20Relational%20Mappings%20(ELUG)#Direct Collection Mapping|Direct Collection Mapping]] |
| headers="r10c1-t2 r1c2-t2" align="left" | | | headers="r10c1-t2 r1c2-t2" align="left" | | ||
[[Configuring a Relational Direct Collection Mapping (ELUG)|Configuring a Relational Direct Collection Mapping]] | [[Configuring a Relational Direct Collection Mapping (ELUG)|Configuring a Relational Direct Collection Mapping]] | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r11c1-t2" headers="r1c1-t2" align="left" | | | id="r11c1-t2" headers="r1c1-t2" align="left" | | ||
− | [[Introduction%20to%20Relational%20Mappings%20(ELUG)|Direct Map Mapping]] | + | [[Introduction%20to%20Relational%20Mappings%20(ELUG)#Direct Map Mapping|Direct Map Mapping]] |
| headers="r11c1-t2 r1c2-t2" align="left" | | | headers="r11c1-t2 r1c2-t2" align="left" | | ||
[[Configuring%20a%20Relational%20Direct%20Map%20Mapping%20(ELUG)|Configuring a Relational Direct Map Mapping]] | [[Configuring%20a%20Relational%20Direct%20Map%20Mapping%20(ELUG)|Configuring a Relational Direct Map Mapping]] | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r12c1-t2" headers="r1c1-t2" align="left" | | | id="r12c1-t2" headers="r1c1-t2" align="left" | | ||
− | [[Introduction%20to%20Relational%20Mappings%20(ELUG)|Aggregate Object Mapping]] | + | [[Introduction%20to%20Relational%20Mappings%20(ELUG)#Aggregate Object Mapping|Aggregate Object Mapping]] |
| headers="r12c1-t2 r1c2-t2" align="left" | | | headers="r12c1-t2 r1c2-t2" align="left" | | ||
[[Configuring a Relational Aggregate Object Mapping (ELUG)|Configuring a Relational Aggregate Object Mapping]] | [[Configuring a Relational Aggregate Object Mapping (ELUG)|Configuring a Relational Aggregate Object Mapping]] | ||
Line 92: | Line 83: | ||
<span id="Table 33-2"></span> | <span id="Table 33-2"></span> | ||
− | |||
− | |||
{| class="RuleFormalMax" dir="ltr" title="Common Relational Mapping Options" summary="This table lists the configurable options shared by two or more relational mapping types and categorizes them as Basic and Advanced and indicates if the option can be configured with EclipseLink Workbench, Java, or both." width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all" | {| class="RuleFormalMax" dir="ltr" title="Common Relational Mapping Options" summary="This table lists the configurable options shared by two or more relational mapping types and categorizes them as Basic and Advanced and indicates if the option can be configured with EclipseLink 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" | ||
Line 115: | Line 104: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r4c1-t3" headers="r1c1-t3" align="left" | | | id="r4c1-t3" headers="r1c1-t3" align="left" | | ||
− | [[Configuring%20a%20Mapping%20(ELUG) | + | [[Configuring%20a%20Mapping%20(ELUG)#Configuring Container Policy|Container policy ]] |
| headers="r4c1-t3 r1c2-t3" align="left" | | | headers="r4c1-t3 r1c2-t3" align="left" | | ||
[[Image:support.gif|Supported]] | [[Image:support.gif|Supported]] | ||
Line 136: | Line 125: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r7c1-t3" headers="r1c1-t3" align="left" | | | id="r7c1-t3" headers="r1c1-t3" align="left" | | ||
− | [[Configuring%20a%20Mapping%20(ELUG) | + | [[Configuring%20a%20Mapping%20(ELUG)#Configuring Read-Only Mappings|Read-only mapping ]] |
| headers="r7c1-t3 r1c2-t3" align="left" | | | headers="r7c1-t3 r1c2-t3" align="left" | | ||
[[Image:support.gif|Supported]] | [[Image:support.gif|Supported]] | ||
Line 178: | Line 167: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r13c1-t3" headers="r1c1-t3" align="left" | | | id="r13c1-t3" headers="r1c1-t3" align="left" | | ||
− | [[Configuring%20a%20Mapping%20(ELUG)#Configuring an Object Type Converter| | + | [[Configuring%20a%20Mapping%20(ELUG)#Configuring an Object Type Converter|Object type conversion] |
| headers="r13c1-t3 r1c2-t3" align="left" | | | headers="r13c1-t3 r1c2-t3" align="left" | | ||
[[Image:support.gif|Supported]] | [[Image:support.gif|Supported]] | ||
Line 229: | Line 218: | ||
<span id="Table 33-3"></span> | <span id="Table 33-3"></span> | ||
− | |||
− | |||
{| class="RuleFormal" dir="ltr" title="Relational Mapping Support for Database Field" summary="This table summarizes which mappings support Database Field" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all" | {| class="RuleFormal" dir="ltr" title="Relational Mapping Support for Database Field" summary="This table summarizes which mappings support Database Field" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all" | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
Line 238: | Line 225: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r2c1-t4" headers="r1c1-t4" align="left" | | | id="r2c1-t4" headers="r1c1-t4" align="left" | | ||
− | [[Introduction%20to%20Relational%20Mappings%20(ELUG)|Direct-to-Field Mapping]] | + | [[Introduction%20to%20Relational%20Mappings%20(ELUG)#Direct-to-Field Mapping|Direct-to-Field Mapping]] |
| headers="r2c1-t4 r1c2-t4" align="left" | | | headers="r2c1-t4 r1c2-t4" align="left" | | ||
[[Image:support.gif|Supported.]] | [[Image:support.gif|Supported.]] | ||
Line 245: | Line 232: | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| id="r3c1-t4" headers="r1c1-t4" align="left" | | | id="r3c1-t4" headers="r1c1-t4" align="left" | | ||
− | [[Introduction%20to%20Relational%20Mappings%20(ELUG)|Direct-to-XMLType Mapping]] | + | [[Introduction%20to%20Relational%20Mappings%20(ELUG)#Direct-to-XMLType Mapping|Direct-to-XMLType Mapping]] |
| headers="r3c1-t4 r1c2-t4" align="left" | | | headers="r3c1-t4 r1c2-t4" align="left" | | ||
[[Image:support.gif|Supported.]] | [[Image:support.gif|Supported.]] | ||
Line 257: | Line 244: | ||
EclipseLink supports the following Java types: | EclipseLink supports the following Java types: | ||
− | |||
* <tt>java.lang</tt><nowiki>: </nowiki><tt>Boolean</tt>, <tt>Float</tt>, <tt>Integer</tt>, <tt>String</tt>, <tt>Double</tt>, <tt>Long</tt>, <tt>Short</tt>, <tt>Byte</tt>, <tt>Byte[ ]</tt>, <tt>Character</tt>, <tt>Character[ ]</tt><nowiki>; all the primitives associated with these classes</nowiki> | * <tt>java.lang</tt><nowiki>: </nowiki><tt>Boolean</tt>, <tt>Float</tt>, <tt>Integer</tt>, <tt>String</tt>, <tt>Double</tt>, <tt>Long</tt>, <tt>Short</tt>, <tt>Byte</tt>, <tt>Byte[ ]</tt>, <tt>Character</tt>, <tt>Character[ ]</tt><nowiki>; all the primitives associated with these classes</nowiki> | ||
* <tt>java.math</tt><nowiki>: </nowiki><tt>BigInteger</tt>, <tt>BigDecimal</tt> | * <tt>java.math</tt><nowiki>: </nowiki><tt>BigInteger</tt>, <tt>BigDecimal</tt> | ||
Line 263: | Line 249: | ||
* <tt>java.util</tt><nowiki>: </nowiki><tt>Date</tt>, <tt>Calendar</tt> | * <tt>java.util</tt><nowiki>: </nowiki><tt>Date</tt>, <tt>Calendar</tt> | ||
− | While executing reads, the mappings in [[#Table 33-6]] | + | While executing reads, the mappings in the [[#Table 33-6| Relational Mapping Support for Reference Descriptor]] tableperform the simple one-way data conversions that the [[#Table 33-4|Type Conversions Provided by Direct-to-Field Mappings]] table describes. For two-way or more complex conversions, You must [[Introduction%20to%20Relational%20Mappings%20(ELUG)#Converters and Transformers|use converters]]). |
− | The mappings in this table also allow you to specify a null value. This may be required if primitive types are used in the object, and the database field allows <tt>null</tt> values. For more information, see [[Configuring%20a%20Mapping%20(ELUG)|Configuring a Default Null Value at the Mapping Level]]. | + | The mappings in this table also allow you to specify a null value. This may be required if primitive types are used in the object, and the database field allows <tt>null</tt> values. For more information, see [[Configuring%20a%20Mapping%20(ELUG)#Configuring a Default Null Value at the Mapping Level|Configuring a Default Null Value at the Mapping Level]]. |
Line 427: | Line 413: | ||
Neither timezone nor milliseconds are stored in the database. | Neither timezone nor milliseconds are stored in the database. | ||
|} | |} | ||
− | |||
Line 435: | Line 420: | ||
===How to Configure a Database Field Using Workbench=== | ===How to Configure a Database Field Using Workbench=== | ||
− | |||
Use this procedure to select a specific database field for a direct mapping. | Use this procedure to select a specific database field for a direct mapping. | ||
− | |||
# Select the direct mapping attribute in the '''Navigator'''. Its properties appear in the Editor. | # Select the direct mapping attribute in the '''Navigator'''. Its properties appear in the Editor. | ||
# Click the '''General''' tab. The General tab appears.<br>'''''Direct Mapping General Tab, Database Field Option'''''<br>[[Image:mpdtfdfd.gif|Direct Mapping General Tab, Database Field Option]] | # Click the '''General''' tab. The General tab appears.<br>'''''Direct Mapping General Tab, Database Field Option'''''<br>[[Image:mpdtfdfd.gif|Direct Mapping General Tab, Database Field Option]] | ||
Line 446: | Line 429: | ||
{| class="Note oac_no_warn" width="80%" border="1" frame="hsides" rules="groups" cellpadding="3" frame="hsides" rules="groups" | {| class="Note oac_no_warn" width="80%" border="1" frame="hsides" rules="groups" cellpadding="3" frame="hsides" rules="groups" | ||
| align="left" | | | align="left" | | ||
− | + | '''Note'''<nowiki>:</nowiki> For direct-to-field mappings of an aggregate descriptor (see [[Configuring%20a%20Relational%20Descriptor%20(ELUG)|Configuring a Relational Descriptor as a Class or Aggregate Type]]), this field is for display only and cannot be changed. | |
|} | |} | ||
Line 452: | Line 435: | ||
==Configuring Reference Descriptor== | ==Configuring Reference Descriptor== | ||
− | |||
In relational mappings that extend <tt>org.eclipse.persistence.mappings.ForeignReferenceMapping</tt>, attributes reference other EclipseLink descriptors–not the data source. You can select any descriptor in the project. | In relational mappings that extend <tt>org.eclipse.persistence.mappings.ForeignReferenceMapping</tt>, attributes reference other EclipseLink descriptors–not the data source. You can select any descriptor in the project. | ||
Line 459: | Line 441: | ||
<span id="Table 33-6"></span> | <span id="Table 33-6"></span> | ||
− | |||
− | |||
{| class="RuleFormal" dir="ltr" title="Relational Mapping Support for Reference Descriptor" summary="This table summarizes which mappings support Reference Descriptor" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all" | {| class="RuleFormal" dir="ltr" title="Relational Mapping Support for Reference Descriptor" summary="This table summarizes which mappings support Reference Descriptor" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all" | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
Line 522: | Line 502: | ||
{| class="Note oac_no_warn" width="80%" border="1" frame="hsides" rules="groups" cellpadding="3" frame="hsides" rules="groups" | {| class="Note oac_no_warn" width="80%" border="1" frame="hsides" rules="groups" cellpadding="3" frame="hsides" rules="groups" | ||
| align="left" | | | align="left" | | ||
− | + | '''Note'''<nowiki>:</nowiki> For aggregate mappings the '''Reference Descriptor''' must be an ''aggregate''. See [[Configuring%20a%20Relational%20Descriptor%20(ELUG)|Configuring a Relational Descriptor as a Class or Aggregate Type]] for more information. For variable one-to-one mappings, the Reference Descriptor must be an ''interface''. See [[Configuring%20a%20Relational%20Variable%20One-to-One%20Mapping%20(ELUG)|Configuring a Relational Variable One-to-One Mapping]] for more information. | |
|} | |} | ||
Line 541: | Line 521: | ||
==Configuring Batch Reading== | ==Configuring Batch Reading== | ||
− | |||
Batch reading can be used in most of the relational mappings. This feature should be used only if it is known that the related objects are always required with the source object. | Batch reading can be used in most of the relational mappings. This feature should be used only if it is known that the related objects are always required with the source object. | ||
Line 548: | Line 527: | ||
<span id="Table 33-7"></span> | <span id="Table 33-7"></span> | ||
− | |||
− | |||
{| class="RuleFormal" dir="ltr" title="Relational Mapping Support for Batch Reading" summary="This table summarizes which mappings support batch reading" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all" | {| class="RuleFormal" dir="ltr" title="Relational Mapping Support for Batch Reading" summary="This table summarizes which mappings support batch reading" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all" | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
Line 602: | Line 579: | ||
===How to Configure Batch Reading Using Workbench=== | ===How to Configure Batch Reading Using Workbench=== | ||
− | |||
To use batch reading in a relationship mapping, use this procedure: | To use batch reading in a relationship 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 '''General''' tab. The General tab appears.<br>'''''General Tab, Batch Reading Option'''''<br>[[Image:oogenbat.gif|General Tab, Batch Reading Option]] | # Click the '''General''' tab. The General tab appears.<br>'''''General Tab, Batch Reading Option'''''<br>[[Image:oogenbat.gif|General Tab, Batch Reading Option]] | ||
+ | #To specify that this mapping using batch reading, select the '''Batch Reading''' option. | ||
− | |||
− | |||
− | |||
− | |||
===How to Configure Batch Reading Using Java=== | ===How to Configure Batch Reading Using Java=== | ||
− | |||
This example shows how to use a <tt>DescriptorCustomizer</tt> class to add batch reading to a mapping. | This example shows how to use a <tt>DescriptorCustomizer</tt> class to add batch reading to a mapping. | ||
− | |||
<span id="Example 33-1"></span> | <span id="Example 33-1"></span> | ||
Line 632: | Line 602: | ||
==Configuring Query Key Order== | ==Configuring Query Key Order== | ||
− | |||
You can configure EclipseLink to maintain collections in order by query key. | You can configure EclipseLink to maintain collections in order by query key. | ||
Line 639: | Line 608: | ||
<span id="Table 33-8"></span> | <span id="Table 33-8"></span> | ||
− | |||
− | |||
{| class="RuleFormal" dir="ltr" title="Relational Mapping Support for Query Key Order" summary="This table summarizes which mappings support Query Key Order" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all" | {| class="RuleFormal" dir="ltr" title="Relational Mapping Support for Query Key Order" summary="This table summarizes which mappings support Query Key Order" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all" | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
Line 672: | Line 639: | ||
===How to Configure Query Key Order Using Workbench=== | ===How to Configure Query Key Order Using Workbench=== | ||
− | |||
To specify the order of a mapping's query keys, use this procedure: | To specify the order of a mapping's query keys, 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 '''Ordering''' tab. The Ordering tab appears.<br>'''''Ordering Tab'''''<br>[[Image:onetomany_coll_ord.gif|Ordering Tab]] | # Click the '''Ordering''' tab. The Ordering tab appears.<br>'''''Ordering Tab'''''<br>[[Image:onetomany_coll_ord.gif|Ordering Tab]] | ||
− | # Complete the | + | # Complete the '''Ordering''' options on the tab. |
− | + | ||
− | + | ||
{| class="HRuleInformal" dir="ltr" title="This table identifies each field on the tab." summary="This table identifies each field on the tab." width="100%" border="1" frame="hsides" rules="rows" cellpadding="3" frame="hsides" rules="rows" | {| class="HRuleInformal" dir="ltr" title="This table identifies each field on the tab." summary="This table identifies each field on the tab." width="100%" border="1" frame="hsides" rules="rows" cellpadding="3" frame="hsides" rules="rows" | ||
Line 697: | Line 660: | ||
===How to Configure Query Key Order Using Java=== | ===How to Configure Query Key Order Using Java=== | ||
− | |||
This example shows how to use the <tt>DescriptorCustomizer</tt> class to add complex ordering to a mapping. | This example shows how to use the <tt>DescriptorCustomizer</tt> class to add complex ordering to a mapping. | ||
− | |||
<span id="'Example 33-2"></span> | <span id="'Example 33-2"></span> | ||
− | '''' Configuring Query Key Order''''' | + | ''''' Configuring Query Key Order''''' |
public void customize(ClassDescriptor descriptor) { | public void customize(ClassDescriptor descriptor) { | ||
Line 748: | Line 709: | ||
This table summarizes which relational mappings support this option. | This table summarizes which relational mappings support this option. | ||
− | |||
− | |||
− | |||
{| class="RuleFormal" dir="ltr" title="Relational Mapping Support for Table Reference" summary="This table summarizes which mappings support Table Reference" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all" | {| class="RuleFormal" dir="ltr" title="Relational Mapping Support for Table Reference" summary="This table summarizes which mappings support Table Reference" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all" | ||
Line 808: | Line 766: | ||
===How to Configure Table and Field References (Foreign and Target Foreign Keys) Using Workbench=== | ===How to Configure Table and Field References (Foreign and Target Foreign Keys) Using Workbench=== | ||
To specify a table for a mapping reference, use this procedure: | To specify a table for a mapping reference, 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 '''Table Reference''' tab. The Reference tab appears.<br>'''''Table Reference Tab, Table Reference Field'''''<br>[[Image:onetomany_tab_ref.gif|Table Reference Tab, Table Reference Field]] | # Click the '''Table Reference''' tab. The Reference tab appears.<br>'''''Table Reference Tab, Table Reference Field'''''<br>[[Image:onetomany_tab_ref.gif|Table Reference Tab, Table Reference Field]] | ||
Line 841: | Line 798: | ||
'''See Also''' | '''See Also''' | ||
− | : [[#Configuring Table and Field References (Foreign and Target Foreign Keys)| | + | : [[#Configuring Table and Field References (Foreign and Target Foreign Keys)|Configuring Table and Field References (Foreign and Target Foreign Keys)]] |
Line 932: | Line 889: | ||
[[Category: Draft]] | [[Category: Draft]] | ||
[[Category: Task]] | [[Category: Task]] | ||
+ | [[Category: ORM]] |
Revision as of 14:38, 14 December 2007
Contents
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 types of relational mappings that you can configure and provides a cross-reference to the type-specific chapter that lists the configurable options supported by that type.
If you are creating... | See... |
---|---|
For more information, see the following:
Configuring Common Relational Mapping Options
This table lists the configurable options shared by two or more relational mapping types.
Option to Configure | Workbench | Java |
---|---|---|
[[Configuring a Mapping (ELUG)#Configuring an Object Type Converter|Object type conversion] |
||
Configuring a Database Field
You can associate an object attribute with a database field.
This table summarizes which relational mappings support this option.
Mapping | Using the Workbench | How to Use Java |
---|---|---|
When choosing the database field, you must consider Java and database field type compatibility.
EclipseLink supports the following Java types:
- java.lang: Boolean, Float, Integer, String, Double, Long, Short, Byte, Byte[ ], Character, Character[ ]; all the primitives associated with these classes
- java.math: BigInteger, BigDecimal
- java.sql: Date, Time, Timestamp
- java.util: Date, Calendar
While executing reads, the mappings in the Relational Mapping Support for Reference Descriptor tableperform the simple one-way data conversions that the Type Conversions Provided by Direct-to-Field Mappings table describes. For two-way or more complex conversions, You must use converters).
The mappings in this table also allow you to specify a null value. This may be required if primitive types are used in the object, and the database field allows null values. For more information, see Configuring a Default Null Value at the Mapping Level.
Type Conversions Provided by Direct-to-Field Mappings
Java type | Database type |
---|---|
Integer, Float, Double, Byte, Short, BigDecimal, BigInteger, int, float, double, byte, short |
NUMBER, NUMERIC, DECIMAL, FLOAT, DOUBLE, INT, SMALLINT, BIT, BOOLEAN |
Boolean, boolean |
BOOLEAN, BIT, SMALLINT, NUMBER, NUMERIC, DECIMAL, FLOAT, DOUBLE, INT |
String |
VARCHAR, CHAR, VARCHAR2, CLOB, TEXT, LONG, LONG VARCHAR, MEMOThe following types apply only to Oracle9: NVARCHAR2, NCLOB, NCHAR |
byte[ ] |
BLOB, LONG RAW, IMAGE, RAW, VARBINARY, BINARY, LONG VARBINARY |
Time |
TIME |
java.sql.Date |
DATE |
Timestamp, java.util.Date, Calendar |
TIMESTAMP |
Support for oracle.sql.TimeStamp
EclipseLink provides additional support for mapping Java date and time data types to Oracle Database DATE, TIMESTAMP, and TIMESTAMPTZ data types when you use the Oracle JDBC driver with Oracle9i Database Server or later and the Oracle9Platform in EclipseLink.
In a direct-to-field mapping, you are not required to specify the database type of the field value; EclipseLink determines the appropriate data type conversion.
This table lists the supported direct-to-field mapping combinations.
Supported Oracle Database Date and Time Direct-to-Field Mappings
Java Type | Database Type | Description |
---|---|---|
java.sql.Time |
TIMESTAMP |
Full bidirectional support. |
TIMESTAMPTZ |
Full bidirectional support. | |
DATE |
Full bidirectional support. | |
java.sql.Date |
TIMESTAMP |
Full bidirectional support. |
TIMESTAMPTZ |
Full bidirectional support. | |
DATE |
Full bidirectional support. | |
java.sql.Timestamp |
TIMESTAMP |
Full bidirectional support. |
TIMESTAMPTZ |
Full bidirectional support. | |
DATE |
Nanoseconds are not stored in the database. | |
java.util.Date |
TIMESTAMP |
Full bidirectional support. |
TIMESTAMPTZ |
Full bidirectional support. | |
DATE |
Milliseconds are not stored in the database. | |
java.util.Calendar |
TIMESTAMP |
Native SQL or binding gives Calendar timezone.Note: The TIMESTAMP database value has no timezone – the Calendar object provides the local timezone by default. If the database is not in this timezone, you must obtain the database timezone by some other means and update the Calendar object accordingly. For this reason, TIMESTAMPTZ may be a better choice. |
TIMESTAMPTZ |
Native SQL or binding stores timezone; standard SQL is based on the local timezone. | |
DATE |
Neither timezone nor milliseconds are stored in the database. |
Note that some of these mappings result in a loss of precision: avoid these combinations if you require this level of precision. For example, if you create a direct-to-field mapping between a java.sql.Date attribute and a TIMESTAMPTZ database field, there is no loss of precision. However, if you create a direct-to-field mapping between a java.sql.Timestamp attribute and a DATE database field, the nanoseconds or milliseconds of the attribute are not stored in the database.
How to Configure a Database Field Using Workbench
Use this procedure to select a specific database field for a direct mapping.
- Select the direct mapping attribute in the Navigator. Its properties appear in the Editor.
- Click the General tab. The General tab appears.
Direct Mapping General Tab, Database Field Option - Use the Database Field field to select a field for this direct mapping. You must have previously associated the descriptor with a database table as described in Configuring Associated Tables.
Note: For direct-to-field mappings of an aggregate descriptor (see Configuring a Relational Descriptor as a Class or Aggregate Type), this field is for display only and cannot be changed. |
Configuring Reference Descriptor
In relational mappings that extend org.eclipse.persistence.mappings.ForeignReferenceMapping, attributes reference other EclipseLink descriptors–not the data source. You can select any descriptor in the project.
This table summarizes which relational mappings support this option.
Mapping | Using the Workbench | How to Use Java |
---|---|---|
How to Configure a Reference Descriptor Using Workbench
To specify a reference descriptor for a relational mapping, use this procedure.
- Select the mapped attribute in the Navigator. Its properties appear in the Editor.
- Click the General tab. The General tab appears.
General Tab, Reference Descriptor Field - Use the Reference Descriptor field to select the descriptor referenced by this relationship mapping.
Note: For aggregate mappings the Reference Descriptor must be an aggregate. See Configuring a Relational Descriptor as a Class or Aggregate Type for more information. For variable one-to-one mappings, the Reference Descriptor must be an interface. See Configuring a Relational Variable One-to-One Mapping for more information. |
You can specify a reference descriptor that is not in the current Workbench project. For example, to create a mapping to an Employee class that does not exist in the current project, do the following:
- Add the Employee class to your current project. See Working with Projects.
- Create the relationship mapping to the Employee descriptor.
- Deactivate the Employee descriptor. See Active and Inactive Descriptors.
When you generate the deployment XML for your project, the mapping to the Employee class will be included, but not the Employee class.
See Also
Configuring Batch Reading
Batch reading can be used in most of the relational mappings. This feature should be used only if it is known that the related objects are always required with the source object.
This table summarizes which relational mappings support this option.
Mapping | Using the Workbench | Using Java |
---|---|---|
How to Configure Batch Reading Using Workbench
To use batch reading in a relationship mapping, use this procedure:
- Select the mapped attribute in the Navigator. Its properties appear in the Editor.
- Click the General tab. The General tab appears.
General Tab, Batch Reading Option - To specify that this mapping using batch reading, select the Batch Reading option.
How to Configure Batch Reading Using Java
This example shows how to use a DescriptorCustomizer class to add batch reading to a mapping.
Query Optimization Using Batching
public void customize(ClassDescriptor descriptor) { OneToManyMapping phoneNumbersMapping = new OneToManyMapping(); phoneNumbersMapping = (OneToManyMapping)descriptor.getMappingForAttributeName("phones"); phoneNumbersMapping.useBatchReading(); }
Configuring Query Key Order
You can configure EclipseLink to maintain collections in order by query key.
This table summarizes which relational mappings support this option.
Mapping | Using the Workbench | Using Java |
---|---|---|
How to Configure Query Key Order Using Workbench
To specify the order of a mapping's query keys, use this procedure:
- Select the mapped attribute in the Navigator. Its properties appear in the Editor.
- Click the Ordering tab. The Ordering tab appears.
Ordering Tab - Complete the Ordering options on the tab.
Field | Description |
---|---|
Query Key |
Specify the query key to order by. Click Add to add query keys to, or Remove to remove query keys from the ordering operation.Click Up or Down to change the sort order of selected query keys. |
Order | Specify if EclipseLink orders the selected query key in Ascending or Descending (alphabetical) order. |
How to Configure Query Key Order Using Java
This example shows how to use the DescriptorCustomizer class to add complex ordering to a mapping.
Configuring Query Key Order
public void customize(ClassDescriptor descriptor) { OneToManyMapping phoneNumbersMapping = new OneToManyMapping(); phoneNumbersMapping = (OneToManyMapping)descriptor.getMappingForAttributeName("phones"); phoneNumbersMapping.addAscendingOrdering("areaCode"); ExpressionBuilder phone = phoneNumbersMapping.getSelectionQuery().getExpressionBuilder(); phoneNumbersMapping.getSelectionQuery().addOrdering( phone.get("type").toUpperCase().ascending()); }
Note: You can provide the same functionality by using a descriptor amendment method (see Using the Descriptor Amendment Methods). |
Configuring Table and Field References (Foreign and Target Foreign Keys)
A foreign key is a combination of one or more database columns that reference a unique key, usually the primary key, in another table. Foreign keys can be any number of fields (similar to a primary key), all of which are treated as a unit. A foreign key and the parent key it references must have the same number and type of fields.
Mappings that extend org.eclipse.persistence.mappings.ForeignReferenceMapping use foreign keys to find information in the database so that the target object(s) can be instantiated. For example, if every Employee has an attribute address that contains an instance of Address (which has its own descriptor and table) then, the one-to-one mapping for the address attribute would specify foreign key information to find an Address for a particular Employee.
EclipseLink classifies foreign keys into two categories in mappings–foreign keys and target foreign keys:
- In a foreign key, the key is found in the table associated with the mapping's own descriptor. For example, an Employee foreign key to ADDRESS would be in the EMPLOYEE table.
- In a target foreign key, the reference is from the target object's table back to the key from the mapping's descriptor's table. For example, the ADDRESS table would have a foreign key to EMPLOYEE.
Caution: Make sure you fully understand the distinction between foreign key and target foreign key before defining a mapping. |
The table reference is the database table that contains the foreign key references.
This table summarizes which relational mappings support this option.
Mapping | Using the Workbench | Using Java |
---|---|---|
Using Workbench, you can either import this table from your database or create it. If you import tables from the database (see Importing Tables from a Database), EclipseLink creates references that correspond to existing database constraints (if supported by the driver). You can also define references in EclipseLink without creating similar constraints on the database.
How to Configure Table and Field References (Foreign and Target Foreign Keys) Using Workbench
To specify a table for a mapping reference, use this procedure:
- Select the mapped attribute in the Navigator. Its properties appear in the Editor.
- Click the Table Reference tab. The Reference tab appears.
Table Reference Tab, Table Reference Field - Complete the fields on the Table Reference tab.
Use the following information to select the field references on the tab:
Field | Description |
---|---|
Table Reference | Select an existing table, or click New to create a new table reference. |
Source and Target Field |
Click Add to create new foreign key reference. To delete an existing key pair reference, select the Source and Target fields and click Remove. |
Source Field | Select the database field from the source table for this foreign key reference. |
Target Field | Select the database field from the target table for this foreign key reference. |
Target Foreign Key | Specify whether or not the reference is from the target object's table back to the key from the mapping's descriptor's table. |
See Also
How to Configure Table and Field References (Foreign and Target Foreign Keys) Using Java
Use the addTargetForeignKeyFieldName method (and pass the name of the field name of the target foreign key and the source of the primary key in the source table) to specify foreign key information.
For composite source primary keys, use the addTargetForeignKeyFieldName method for each of the fields that comprise the primary key.
This esxample shows how to use the DescriptorCustomizer class to add complex join to a mapping.
Adding Complex Join to a Mapping
public void customize(ClassDescriptor descriptor) { OneToManyMapping phoneNumbersMapping = new OneToManyMapping(); phoneNumbersMapping = (OneToManyMapping)descriptor.getMappingForAttributeName("cellPhones"); ExpressionBuilder phone = phoneNumbersMapping.getSelectionQuery().getExpressionBuilder(); phoneNumbersMapping.addTargetForeignKeyFieldName("PHONE.EMP_ID", "EMP.ID"); phoneNumbersMapping.getSelectionQuery( phone.getField("PHONE.EMP_ID").equal(phone.getParameter("EMP.ID"). and(phone.getField("PHONE.TYPE').equal("CELL"))); }
Note: You can provide the same functionality by using a descriptor amendment method (see Using the Descriptor Amendment Methods). |
Configuring Joining at the Mapping Level
EclipseLink supports configuring an inner or outer join at the mapping level for a ForeignReferenceMapping. When a class that owns the mapping is read, the EclipseLink runtime will always get the class and the target of the reference mapping with one database hit.
Use this feature only if the target object is always required with the source object, or when indirection (lazy loading) is not used. For more information, see Indirection (Lazy Loading).
You can also configure join reading at the query level. For more information, see Join Reading and Object-Level Read Queries.
For more information about joins, see Expressions for Joining and Complex Relationships.
How to Configure Joining at the Mapping Level Using Workbench
To use joining in a relationship mapping, use this procedure:
- Select the mapped attribute in the Navigator. Its properties appear in the Editor.
- Click the General tab. The General tab appears.
General Tab, Use Joining Option
General Tab, Use Joining Option - To use joining with this relationship, select the Use Joining option.
See Also
How to Configure Joining at the Mapping Level Using Java
This example shows how to use the DescriptorCustomizer class to add complex join at the mapping level.
Adding Join at the Mapping Level
public void customize(ClassDescriptor descriptor) { OneToManyMapping addressMapping = new OneToManyMapping(); addressMapping = (OneToManyMapping)descriptor.getMappingForAttributeName("address"); addressMapping.useJoining(); ... }
Note: You can provide the same functionality by using a descriptor amendment method (see Using the Descriptor Amendment Methods). |