Difference between revisions of "EclipseLink/UserGuide/JPA/Basic JPA Development/Mapping/Basic Mappings/Default Conversions and Converters/Convert"

From Eclipsepedia

Jump to: navigation, search
m
m
Line 17: Line 17:
 
* <tt>none</tt> – does not place a converter on the associated mapping.
 
* <tt>none</tt> – does not place a converter on the associated mapping.
  
This table lists attributes of the <tt>@Convert</tt> annotation.
+
{{EclipseLink_AttributesTable
 
+
|caption=Attributes of the <tt>@Convert</tt> annotation
<span id="Table 19-11"></span>
+
|content=<tr>
''''' Attributes of the @Convert Annotation'''''
+
<td>'''<tt>value</tt>'''</td>
 
+
<td>The <tt>String</tt> name for your converter.</td>
{| class="RuleFormalWideMax" dir="ltr" title="Attributes of the @Convert Annotation" summary="This table lists the attributes of EclipseLink JPA @Convert annotation" width="100%" border="1" frame="border" rules="all" cellpadding="3" frame="border" rules="all"
+
<td><tt>"none" String</tt></td>
|- align="left" valign="top"
+
<td>No</td>
! id="r1c1-t17" align="left" valign="bottom" | '''Attribute'''
+
</tr>
! id="r1c2-t17" align="left" valign="bottom" | '''Description'''
+
}}
! id="r1c3-t17" align="left" valign="bottom" | '''Default'''
+
! id="r1c4-t17" align="left" valign="bottom" | '''Required or Optional'''
+
|- align="left" valign="top"
+
| id="r2c1-t17" headers="r1c1-t17" align="left" |
+
<tt>value</tt>
+
| headers="r2c1-t17 r1c2-t17" align="left" |
+
Set this attribute to the <tt>String</tt> name for your converter.
+
| headers="r2c1-t17 r1c3-t17" align="left" |
+
<tt>"none" String</tt>
+
| headers="r2c1-t17 r1c4-t17" align="left" |
+
optional
+
|}
+
  
  

Revision as of 13:52, 18 June 2010



@Convert Annotation and <convert> XML

The @Convert annotation specifies that a named converter should be used with the corresponding mapped attribute.

 @Target({METHOD, FIELD})
 @Retention(RUNTIME)
 public @interface Convert {
    String value() default "none";
 }

The @Convert has the following reserved names:

  • serialized – places the org.eclipse.persistence.mappings.converters.SerializedObjectConverter on the associated mapping.
  • none – does not place a converter on the associated mapping.

Template:EclipseLink AttributesTable


This example shows how to use the @Convert annotation to define the Employee field gender.

Usage of the @Convert Annotation

 @Entity
 @Table(name="EMPLOYEE")
 @Converter(
     name="genderConverter",
         converterClass=org.myorg.converters.GenderConverter.class
 )
 public class Employee implements Serializable{
     ...
     @Basic
     @Convert("genderConverter")
     public String getGender() {
         return gender;
     }
     ...
 }



Eclipselink-logo.gif
Version: 2.1.0
Other versions...