Skip to main content
summaryrefslogtreecommitdiffstats
blob: 87d3ba0a96fe97e73af4714ebf15a10c19b66e7a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
<!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-01-03T9:24:55Z" />
<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 class="betadraftsubtitle">Beta Draft: 2013-01-03</p>
<p><a id="CACJGDAJ" name="CACJGDAJ"></a></p>
<div class="sect3"><!-- infolevel="all" infotype="General" -->
<h1>Converters</h1>
<p><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><a id="sthref522" name="sthref522"></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&nbsp;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 &ndash; converts a fixed number of database data value(s) to Java object value(s)</p>
</li>
<li>
<p>Type &ndash; modifies data values</p>
</li>
<li>
<p>Struct &ndash; 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="sthref523" name="sthref523"></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>

Back to the top