blob: 1a42ec03b5cb8c380636dd78f897f6845f622e3a [file] [log] [blame]
<!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 2.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-2.0/. 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:41Z" />
<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="CACJCHJB" name="CACJCHJB"></a></p>
<div class="sect3"><!-- infolevel="all" infotype="General" -->
<h1><a id="sthref579" name="sthref579"></a><a id="sthref580" name="sthref580"></a>Converters</h1>
<p>Use this area to specify a custom converter for modification of the 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-t43">Property</th>
<th align="left" valign="bottom" id="r1c2-t43">Description</th>
<th align="left" valign="bottom" id="r1c3-t43">Default</th>
<th align="left" valign="bottom" id="r1c4-t43">Available for Entity&nbsp;Type</th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t43" headers="r1c1-t43">
<p>Converters</p>
</td>
<td align="left" headers="r2c1-t43 r1c2-t43">
<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</p>
</li>
<li>
<p>Type</p>
</li>
<li>
<p>Struct</p>
</li>
<li>
<p>Custom</p>
</li>
</ul>
</td>
<td align="left" headers="r2c1-t43 r1c3-t43"><br /></td>
<td align="left" headers="r2c1-t43 r1c4-t43">
<p><a href="tasks011.htm#BABBABCE">Basic mapping</a>, <a href="tasks012.htm#CIHHJEBJ">Element collection mapping</a>, <a href="tasks015.htm#BABGCBHG">ID mapping</a>, <a href="tasks016.htm#BABEIEGD">Many-to-many mapping</a>, <a href="tasks018.htm#BABHGEBD">One-to-many mapping</a>, and <a href="tasks021.htm#BABHIBII">Version mapping</a></p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t43" headers="r1c1-t43">
<p>Name</p>
</td>
<td align="left" headers="r3c1-t43 r1c2-t43">
<p>Name of the converter.</p>
</td>
<td align="left" headers="r3c1-t43 r1c3-t43"><br /></td>
<td align="left" headers="r3c1-t43 r1c4-t43"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t43" headers="r1c1-t43">
<p>Class</p>
</td>
<td align="left" headers="r4c1-t43 r1c2-t43">
<p>Appears for <span class="bold">Custom</span> and <span class="bold">Struct</span> converters only.</p>
</td>
<td align="left" headers="r4c1-t43 r1c3-t43"><br /></td>
<td align="left" headers="r4c1-t43 r1c4-t43"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t43" headers="r1c1-t43">
<p>Data type</p>
</td>
<td align="left" headers="r5c1-t43 r1c2-t43">
<p>Appears for <span class="bold">Object Type</span> and <span class="bold">Type</span> converters only.</p>
</td>
<td align="left" headers="r5c1-t43 r1c3-t43"><br /></td>
<td align="left" headers="r5c1-t43 r1c4-t43"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t43" headers="r1c1-t43">
<p>Object type</p>
</td>
<td align="left" headers="r6c1-t43 r1c2-t43">
<p>Appears for <span class="bold">Object Type</span> and <span class="bold">Type</span> converters only.</p>
</td>
<td align="left" headers="r6c1-t43 r1c3-t43"><br /></td>
<td align="left" headers="r6c1-t43 r1c4-t43"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r7c1-t43" headers="r1c1-t43">
<p>Conversion values</p>
</td>
<td align="left" headers="r7c1-t43 r1c2-t43">
<p>Appears for <span class="bold">Object Type</span> converters only.</p>
</td>
<td align="left" headers="r7c1-t43 r1c3-t43"><br /></td>
<td align="left" headers="r7c1-t43 r1c4-t43"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r8c1-t43" headers="r1c1-t43">
<p>Default object value</p>
</td>
<td align="left" headers="r8c1-t43 r1c2-t43">
<p>Appears for <span class="bold">Object Type</span> converters only.</p>
</td>
<td align="left" headers="r8c1-t43 r1c3-t43"><br /></td>
<td align="left" headers="r8c1-t43 r1c4-t43"><br /></td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="inftblhruleinformalwide" -->
<a id="sthref581" name="sthref581"></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&nbsp;&copy;&nbsp;2011, 2013,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span><br />
<a href="dcommon/html/cpyr.htm"><span class="copyrightlogo">Legal Notices</span></a></td>
</tr>
</table>
</div>
<!-- class="footer" -->
</body>
</html>