| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" /> |
| <meta http-equiv="Content-Style-Type" content="text/css" /> |
| <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
| <title>Converters</title> |
| <meta name="copyright" content="Copyright (c) 2000, 2009 oracle . All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html. Contributors: Oracle - initial API and implementation" /> |
| <meta name="generator" content="Oracle DARB XHTML Converter (Mode = ohj/ohw) - Version 1.0.11" /> |
| <meta name="date" content="2013-04-05T12:21:40Z" /> |
| <meta name="robots" content="noarchive" /> |
| <meta name="doctitle" content="Converters" /> |
| <meta name="relnum" content="Release 3.3" /> |
| <meta name="partnum" content="Release 3.3" /> |
| <link rel="copyright" href="dcommon/html/cpyr.htm" title="Copyright" type="text/html" /> |
| <link rel="stylesheet" href="dcommon/css/blafdoc.css" title="Oracle BLAFDoc" type="text/css" /> |
| </head> |
| <body> |
| <p><a id="CACJGDAJ" name="CACJGDAJ"></a></p> |
| <div class="sect3"><!-- infolevel="all" infotype="General" --> |
| <h1>Converters</h1> |
| <p><a id="sthref515" name="sthref515"></a><a id="sthref516" name="sthref516"></a><a id="sthref517" name="sthref517"></a><a id="sthref518" name="sthref518"></a><a id="sthref519" name="sthref519"></a><a id="sthref520" name="sthref520"></a><a id="sthref521" name="sthref521"></a>Use the Converter area in the <span class="gui-object-title">JPA Details</span> view to specify a way to modify data value(s) during the reading and writing of a mapped attribute.</p> |
| <div class="inftblhruleinformalwide"> |
| <table class="HRuleInformalWide" title="JPA Details view, Advanced page" summary="JPA Details view, Advanced page" dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0"> |
| <col width="16%" /> |
| <col width="*" /> |
| <col width="17%" /> |
| <col width="25%" /> |
| <thead> |
| <tr align="left" valign="top"> |
| <th align="left" valign="bottom" id="r1c1-t32">Property</th> |
| <th align="left" valign="bottom" id="r1c2-t32">Description</th> |
| <th align="left" valign="bottom" id="r1c3-t32">Default</th> |
| <th align="left" valign="bottom" id="r1c4-t32">Available for Entity Type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr align="left" valign="top"> |
| <td align="left" id="r2c1-t32" headers="r1c1-t32"> |
| <p>Converters</p> |
| </td> |
| <td align="left" headers="r2c1-t32 r1c2-t32"> |
| <p>Click Add and use the <a href="ref_add_converter.htm#CIAGCGIJ">Add Converter dialog</a> to create a new converter.</p> |
| <ul> |
| <li> |
| <p>Object Type – converts a fixed number of database data value(s) to Java object value(s)</p> |
| </li> |
| <li> |
| <p>Type – modifies data values</p> |
| </li> |
| <li> |
| <p>Struct – Enable custom processing of <code>java.sql.Struct</code> types</p> |
| </li> |
| <li> |
| <p>Custom</p> |
| </li> |
| </ul> |
| </td> |
| <td align="left" headers="r2c1-t32 r1c3-t32"><br /></td> |
| <td align="left" headers="r2c1-t32 r1c4-t32"> |
| <p><a href="tasks004.htm#BABGBIEE">Entity</a>, <a href="tasks005.htm#BABFEICE">Embeddable</a>, and <a href="tasks006.htm#BABDAGCI">Mapped superclass</a></p> |
| </td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r3c1-t32" headers="r1c1-t32"> |
| <p>Name</p> |
| </td> |
| <td align="left" headers="r3c1-t32 r1c2-t32"> |
| <p>The <code>String</code> name for your converter, must be unique across the persistence unit</p> |
| </td> |
| <td align="left" headers="r3c1-t32 r1c3-t32"><br /></td> |
| <td align="left" headers="r3c1-t32 r1c4-t32"> |
| <p><a href="tasks004.htm#BABGBIEE">Entity</a>, <a href="tasks005.htm#BABFEICE">Embeddable</a>, and <a href="tasks006.htm#BABDAGCI">Mapped superclass</a></p> |
| </td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r4c1-t32" headers="r1c1-t32"> |
| <p>Class</p> |
| </td> |
| <td align="left" headers="r4c1-t32 r1c2-t32"> |
| <p>The class of your converter. This class must implement the <code>org.eclipse.persistence.mappings.converters.Converter</code> interface.</p> |
| <p>Appears for <span class="bold">Custom</span> and <span class="bold">Struct</span> converters only.</p> |
| </td> |
| <td align="left" headers="r4c1-t32 r1c3-t32"><br /></td> |
| <td align="left" headers="r4c1-t32 r1c4-t32"> |
| <p><a href="tasks004.htm#BABGBIEE">Entity</a>, <a href="tasks005.htm#BABFEICE">Embeddable</a>, and <a href="tasks006.htm#BABDAGCI">Mapped superclass</a></p> |
| </td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r5c1-t32" headers="r1c1-t32"> |
| <p>Data type</p> |
| </td> |
| <td align="left" headers="r5c1-t32 r1c2-t32"> |
| <p>The type stored in the database.</p> |
| <p>Appears for <span class="bold">Object Type</span> and <span class="bold">Type</span> converters only.</p> |
| </td> |
| <td align="left" headers="r5c1-t32 r1c3-t32"><br /></td> |
| <td align="left" headers="r5c1-t32 r1c4-t32"> |
| <p><a href="tasks004.htm#BABGBIEE">Entity</a>, <a href="tasks005.htm#BABFEICE">Embeddable</a>, and <a href="tasks006.htm#BABDAGCI">Mapped superclass</a></p> |
| </td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r6c1-t32" headers="r1c1-t32"> |
| <p>Object type</p> |
| </td> |
| <td align="left" headers="r6c1-t32 r1c2-t32"> |
| <p>The type stored on the entity.</p> |
| <p>Appears for <span class="bold">Object Type</span> and <span class="bold">Type</span> converters only.</p> |
| </td> |
| <td align="left" headers="r6c1-t32 r1c3-t32"><br /></td> |
| <td align="left" headers="r6c1-t32 r1c4-t32"> |
| <p><a href="tasks004.htm#BABGBIEE">Entity</a>, <a href="tasks005.htm#BABFEICE">Embeddable</a>, and <a href="tasks006.htm#BABDAGCI">Mapped superclass</a></p> |
| </td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r7c1-t32" headers="r1c1-t32"> |
| <p>Conversion values</p> |
| </td> |
| <td align="left" headers="r7c1-t32 r1c2-t32"> |
| <p>The array of conversion values (instances of <code>ConversionValue</code>: <code>String</code> <code>objectValue</code> and <code>String</code> <code>dataValue</code>).</p> |
| <p>Appears for <span class="bold">Object Type</span> converters only.</p> |
| </td> |
| <td align="left" headers="r7c1-t32 r1c3-t32"><br /></td> |
| <td align="left" headers="r7c1-t32 r1c4-t32"> |
| <p><a href="tasks004.htm#BABGBIEE">Entity</a>, <a href="tasks005.htm#BABFEICE">Embeddable</a>, and <a href="tasks006.htm#BABDAGCI">Mapped superclass</a></p> |
| </td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r8c1-t32" headers="r1c1-t32"> |
| <p>Default object value</p> |
| </td> |
| <td align="left" headers="r8c1-t32 r1c2-t32"> |
| <p>Set the value of this attribute to the default object value. Note that this argument is for dealing with legacy data if the data value is missing.</p> |
| <p>Appears for <span class="bold">Object Type</span> converters only.</p> |
| </td> |
| <td align="left" headers="r8c1-t32 r1c3-t32"><br /></td> |
| <td align="left" headers="r8c1-t32 r1c4-t32"> |
| <p><a href="tasks004.htm#BABGBIEE">Entity</a>, <a href="tasks005.htm#BABFEICE">Embeddable</a>, and <a href="tasks006.htm#BABDAGCI">Mapped superclass</a></p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <br /></div> |
| <!-- class="inftblhruleinformalwide" --> |
| <a id="sthref522" name="sthref522"></a> |
| <p class="subhead2">Related reference</p> |
| <ul> |
| <li> |
| <p>"Converter" in <span class="italic">Java Persistence API (JPA) Extensions Reference for EclipseLink</span><br /> |
| <code><a href="http://eclipse.org/eclipselink/documentation/2.4/jpa/extensions/a_converter.htm">http://eclipse.org/eclipselink/documentation/2.4/jpa/extensions/a_converter.htm</a></code></p> |
| </li> |
| </ul> |
| </div> |
| <!-- class="sect3" --> |
| <!-- Start Footer --> |
| <div class="footer"> |
| <table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%"> |
| <col width="86%" /> |
| <col width="*" /> |
| <tr> |
| <td align="left"><span class="copyrightlogo">Copyright © 2011, 2013, Oracle and/or its affiliates. All rights reserved.</span><br /> |
| <a href="dcommon/html/cpyr.htm"><span class="copyrightlogo">Legal Notices</span></a></td> |
| </tr> |
| </table> |
| </div> |
| <!-- class="footer" --> |
| </body> |
| </html> |
