View source for Configuring a Relational Direct Map Mapping (ELUG)

<div style="margin:5px;float:right;border:1px solid #000000;padding:5px">__TOC__
[[Special:Whatlinkshere/Configuring a Relational Direct Map Mapping (ELUG)|Related Topics]]</div>

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

This table lists the configurable options for a relational direct map mapping.


<span id="Table 43-1"></span>
{| class="RuleFormalMax" dir="ltr" title="Configurable Options for Relational Direct Map Mapping" summary="This table lists the configurable options for relational direct map 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"
! id="r1c1-t2" align="left" valign="bottom" | '''Option'''
! id="r1c2-t2" align="left" valign="bottom" | '''Workbench'''
! id="r1c3-t2" align="left" valign="bottom" | '''Java'''
|- align="left" valign="top"
| id="r2c1-t2" headers="r1c1-t2" align="left" |
[[Configuring%20a%20Relational%20Direct%20Collection%20Mapping (ELUG)#Configuring Target Table|Configuring Target Table]]
| headers="r2c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r2c1-t2 r1c3-t2" align="left" |
[[Image:support.gif|Supported]]
|- align="left" valign="top"
| id="r3c1-t2" headers="r1c1-t2" align="left" |
[[#Configuring Direct Value Field|Direct value field ]]
| headers="r3c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r3c1-t2 r1c3-t2" align="left" |
[[Image:support.gif|Supported]]
|- align="left" valign="top"
| id="r4c1-t2" headers="r1c1-t2" align="left" |
[[#Configuring Direct Key Field|Direct key field ]]
| headers="r4c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r4c1-t2 r1c3-t2" align="left" |
[[Image:support.gif|Supported]]
|- align="left" valign="top"
| id="r5c1-t2" headers="r1c1-t2" align="left" |
[[Configuring%20a%20Mapping%20(ELUG)#Configuring a Type Conversion Converter|Method or direct field access ]]
| headers="r5c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r5c1-t2 r1c3-t2" align="left" |
[[Image:support.gif|Supported]]
|- align="left" valign="top"
| id="r6c1-t2" headers="r1c1-t2" align="left" |
[[Configuring%20a%20Mapping%20(ELUG)#Configuring Read-Only Mappings|Read-only mapping ]]
| headers="r6c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r6c1-t2 r1c3-t2" align="left" |
[[Image:support.gif|Supported]]
|- align="left" valign="top"
| id="r7c1-t2" headers="r1c1-t2" align="left" |
[[Configuring%20a%20Relational%20Mapping%20(ELUG)#Configuring Batch Reading|Batch reading ]]
| headers="r7c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r7c1-t2 r1c3-t2" align="left" |
[[Image:support.gif|Supported]]
|- align="left" valign="top"
| id="r8c1-t2" headers="r1c1-t2" align="left" |
[[Configuring%20a%20Mapping%20(ELUG)|Indirection (lazy loading)]]
| headers="r8c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r8c1-t2 r1c3-t2" align="left" |
[[Image:support.gif|Supported]]
|- align="left" valign="top"
| id="r9c1-t2" headers="r1c1-t2" align="left" |
[[Configuring%20a%20Mapping%20(ELUG)#Configuring Container Policy|Container policy ]]
| headers="r9c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r9c1-t2 r1c3-t2" align="left" |
[[Image:support.gif|Supported]]
|- align="left" valign="top"
| id="r10c1-t2" headers="r1c1-t2" align="left" |
[[Configuring%20a%20Mapping%20(ELUG)#Configuring Mapping Comments|Mapping comments]]
| headers="r10c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r10c1-t2 r1c3-t2" align="left" |
[[Image:unsupport.gif|Supported]]
|- align="left" valign="top"
| id="r11c1-t2" headers="r1c1-t2" align="left" |
[[#Configuring Key Converters|Key converters ]]
| headers="r11c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r11c1-t2 r1c3-t2" align="left" |
[[Image:support.gif|Supported]]
|- align="left" valign="top"
| id="r12c1-t2" headers="r1c1-t2" align="left" |
[[#Configuring Value Converters|Value converters ]]
| headers="r12c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r12c1-t2 r1c3-t2" align="left" |
[[Image:support.gif|Supported]]
|- align="left" valign="top"
| id="r13c1-t2" headers="r1c1-t2" align="left" |
[[Configuring%20a%20Relational%20Mapping%20(ELUG)#Configuring Joining at the Mapping Level|Table and field references ]]
| headers="r13c1-t2 r1c2-t2" align="left" |
[[Image:support.gif|Supported]]
| headers="r13c1-t2 r1c3-t2" align="left" |
[[Image:support.gif|Supported]]
|}


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

<span id="Example 36-1"></span>
''''' Direct Map Mapping'''''
 public void customize(ClassDescriptor descriptor) { 
    DirectMapMapping mapping = new DirectMapMapping();  
 
    // configure mapping
    ... 
 
    // add mapping to descriptor
    descriptor.addMapping(mapping);
 }

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

For information on using JPA to configure direct map mappings, see [[Using%20EclipseLink%20JPA%20Extensions%20(ELUG)#How to Use the @BasicMap Annotation|How to Use the @BasicMap Annotation]].



==Configuring Direct Value Field==

The direct value field in the reference table stores the primitive data value of the map value. If the value's object value and database value are different types, use a converter (see [[#Configuring Value Converters|Configuring Value Converters]]).


===How to Configure Direct Value Fields Using Workbench===

# Select the mapped attribute in the '''Navigator'''. Its properties appear in the Editor.
# Click the '''General''' tab. The General tab appears.<br>''''' General Tab, Direct Value Field'''''<br>[[Image:dmdirval.gif|General Tab, Direct Value Field]]
#Use the '''Direct Value Field''' list to select the field from the '''Target Table''' table that contains the object of the direct map mapping.


===How to Configure Direct Value Fields Using Java===

Use the <tt>DirectMapMapping</tt> method <tt>setDirectFieldName</tt> to set the direct fields for your mapping.

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



==Configuring Direct Key Field==

The direct key field in the reference table stores the primitive data value of the map key. If the key's object value and database value are different types, use a converter (see [[#Configuring Key Converters|Configuring Key Converters]]).


===How to Configure Direct Key Field Using Workbench===

To specify the direct key field in the reference table, use this procedure.
# Select the mapped attribute in the '''Navigator'''. Its properties appear in the Editor.
# Click the '''General''' tab. The General tab appears.<br>''''' General Tab, Direct Key Field'''''<br>[[Image:dmdirkey.gif|General Tab, Direct Key Field]]
#Use the '''Direct Key Field''' list to select the key from the '''Target Table''' table that contains the object of the direct map mapping.


===How to Configure Direct Key Field Using Java===

Use the <tt>DirectMapMapping</tt> method <tt>setDirectKeyFieldName</tt> to set the direct key field for your mapping.

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



==Configuring Key Converters==

If the key's object value and database value are different types, use a converter. EclipseLink supports the following key converters:
* [[Introduction%20to%20Mappings%20(ELUG)#Serialized Object Converter|Serialized Object Converter]]
* [[Introduction%20to%20Mappings%20(ELUG)#Type Conversion Converter|Type Conversion Converter]]
* [[Introduction%20to%20Mappings%20(ELUG)#Object Type Converter|Object Type Converter]]


===How to Configure Key Converters Using Workbench===

Use this procedure to specify the converter for a direct map mapping key:
# Select the mapped attribute in the '''Navigator'''. Its properties appear in the Editor.
# Click the '''Converter''' tab. The Converter tab appears.
# Click the '''Key Converter''' tab. The Key Converter tab appears.<br>'''''Converter Tab, Key Converter Subtab'''''<br>[[Image:keyconv.gif|Converter Tab, Key Converter Subtab]]
# Select the appropriate Key Converter.

{| class="HRuleInformal" dir="ltr" title="This table identifies the available converters." summary="This table identifies the available converters." width="100%" border="1" frame="hsides" rules="rows" cellpadding="3" frame="hsides" rules="rows"
|- align="left" valign="top"
! id="r1c1-t3" align="left" valign="bottom" | '''Converter'''
! id="r1c2-t3" align="left" valign="bottom" | '''Description'''
|- align="left" valign="top"
| id="r2c1-t3" headers="r1c1-t3" align="left" | '''No Converter'''
| headers="r2c1-t3 r1c2-t3" align="left" | Do not use a Key Converter for this mapping.
|- align="left" valign="top"
| id="r3c1-t3" headers="r1c1-t3" align="left" | '''Serialized Object''' '''Converter'''
| headers="r3c1-t3 r1c2-t3" align="left" |
See [[Configuring%20a%20Mapping%20(ELUG)#Configuring a Serialized Object Converter|Configuring a Serialized Object Converter]].
|- align="left" valign="top"
| id="r4c1-t3" headers="r1c1-t3" align="left" | '''Type Conversion Converter'''
| headers="r4c1-t3 r1c2-t3" align="left" |
See [[Configuring%20a%20Mapping%20(ELUG)#Configuring a Type Conversion Converter|Configuring a Type Conversion Converter]].
|- align="left" valign="top"
| id="r5c1-t3" headers="r1c1-t3" align="left" | '''Object Type''' '''Converter'''
| headers="r5c1-t3 r1c2-t3" align="left" |
See [[Configuring%20a%20Mapping%20(ELUG)#Configuring an Object Type Converter|Configuring an Object Type Converter]].
|}


===How to Configure Key Converters Using Java===

You can configure whether or not to allow null values using the <tt>DirectMapMapping</tt> method <tt>setKeyConverter</tt>.

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



==Configuring Value Converters==

If the value's object value and database value are different types, use a converter. EclipseLink supports the following value converters:
* [[Introduction%20to%20Mappings%20(ELUG)#Serialized Object Converter|Serialized Object Converter]]
* [[Introduction%20to%20Mappings%20(ELUG)#Type Conversion Converter|Type Conversion Converter]]
* [[Introduction%20to%20Mappings%20(ELUG)#Object Type Converter|Object Type Converter]]


===How to Configure Value Converters Using Workbench===

# Select the mapped attribute in the '''Navigator'''. Its properties appear in the Editor.
# Click the '''Converter''' tab. The Converter tab appears.
# Click the '''Value Converter''' tab. The Value Converter tab appears.<br>'''''Converter Tab, Value Converter Subtab'''''<br>[[Image:valconv.gif|Converter Tab, Value Converter Subtab]]
# Select the appropriate Value Converter.

{| class="HRuleInformal" dir="ltr" title="This table identifies the available converters." summary="This table identifies the available converters." width="100%" border="1" frame="hsides" rules="rows" cellpadding="3" frame="hsides" rules="rows"
|- align="left" valign="top"
! id="r1c1-t4" align="left" valign="bottom" | '''Converter'''
! id="r1c2-t4" align="left" valign="bottom" | '''Description'''
|- align="left" valign="top"
| id="r2c1-t4" headers="r1c1-t4" align="left" | '''No Converter'''
| headers="r2c1-t4 r1c2-t4" align="left" | Do not use a Value Converter for this mapping.
|- align="left" valign="top"
| id="r3c1-t4" headers="r1c1-t4" align="left" | '''Serialized Object''' '''Converter'''
| headers="r3c1-t4 r1c2-t4" align="left" |
See [[Configuring%20a%20Mapping%20(ELUG)#Configuring a Serialized Object Converter|Configuring a Serialized Object Converter]]
|- align="left" valign="top"
| id="r4c1-t4" headers="r1c1-t4" align="left" | '''Type Conversion Converter'''
| headers="r4c1-t4 r1c2-t4" align="left" |
See [[Configuring%20a%20Mapping%20(ELUG)#Configuring a Type Conversion Converter|Configuring a Type Conversion Converter]]
|- align="left" valign="top"
| id="r5c1-t4" headers="r1c1-t4" align="left" | '''Object Type Converter'''
| headers="r5c1-t4 r1c2-t4" align="left" |
See [[Configuring%20a%20Mapping%20(ELUG)#Configuring an Object Type Converter|Configuring an Object Type Converter]]
|}



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


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