Skip to main content
summaryrefslogblamecommitdiffstats
blob: 26dee755f1bd4804b76910ad5772da01eb1453a2 (plain) (tree)
1
2
3
4
5



                                                                   
                                        

























                                                                                               
                                                                                                                                                                                                                                                                                                                                       






















































                                                                                                                                                                                                                                                                                                             


                                                              



                              

                                                                                                             

                                                                    
                                                     

                              

                                                                                                                                                                       














                                                                                                         
                                                                                                                                                                                                             

                              


                                                                           

                              

                                                                                                                                                                     








                
                                                     

                              


                                                                                       

                              


                                                                                                                                                                          

                              

                                                                                                                                                 











                
                                                      








































                                                                                                                                                                                                
<!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>
<!-- Run date = May 15, 2007 9:04:24 -->
<meta name="OAC_IGNORE_SKIP_NAV" content="true" />
<title>Basic mapping</title>
<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" />
<meta name="generator" content="Oracle DARB XHTML Converter - Version 4.5.3 Build 02" />
<meta name="date" content="2005-07-10T12:57:20+08:00" />
<meta name="robots" content="all" scheme="http://www.robotstxt.org/" />
<meta name="doctitle" content="Basic mapping" />
<meta name="relnum" content="Release 1.0.0" />
<meta name="partnum" content="" />
<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" />
<link rel="start" href="../../index.htm" title="Home" type="text/html" />
<link rel="contents" href="toc.htm" title="Contents" type="text/html" />
</head>
<body>
<p><a id="BABBABCE" name="BABBABCE"></a></p>
<div class="sect2"><!-- infolevel="all" infotype="General" -->
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<tr valign="bottom">
<td align="left" width="86%">
<h1>Basic mapping</h1>
</td>
</tr>
</table>
<p><a id="sthref114" name="sthref114"></a><a id="sthref115" name="sthref115"></a><a id="sthref116" name="sthref116"></a><a id="sthref117" name="sthref117"></a>Use a <span class="bold">Basic Mapping</span> to map an attribute directly to a database column. Basic mappings may be used only with the following attribute types:</p>
<ul>
<li type="disc">
<p>Java primitive types and wrappers of the primitive types</p>
</li>
<li type="disc">
<p><code>java.lang.String, java.math.BigInteger</code></p>
</li>
<li type="disc">
<p><code>java.math.BigDecimal</code></p>
</li>
<li type="disc">
<p><code>java.util.Date</code></p>
</li>
<li type="disc">
<p><code>java.util.Calendar, java.sql.Date</code></p>
</li>
<li type="disc">
<p><code>java.sql.Time</code></p>
</li>
<li type="disc">
<p><code>java.sql.Timestamp</code></p>
</li>
<li type="disc">
<p><code>byte[]</code></p>
</li>
<li type="disc">
<p><code>Byte[]</code></p>
</li>
<li type="disc">
<p><code>char[]</code></p>
</li>
<li type="disc">
<p><code>Character[]</code></p>
</li>
<li type="disc">
<p>enums</p>
</li>
<li type="disc">
<p>any other type that implements <code>Serializable</code></p>
</li>
</ul>
<p>To create a basic mapping:</p>
<ol type="1" start="1">
<li>
<p>In the <a href="ref_persistence_outline.htm#BABEGGFE">JPA Structure view</a>, select the field to map. The <a href="ref_persistence_map_view.htm#BABIFBAF">JPA Details view (for attributes)</a> displays the properties for the selected field.</p>
</li>
<li>
<p>In the <span class="gui-object-title">Map As</span> field, select <span class="gui-object-action">Basic</span>.</p>
</li>
<li>
<p>Use this table to complete the remaining fields on the <span class="gui-object-title">JPA Details</span> view.</p>
<div class="inftblruleinformal">
<table class="RuleInformal" title="This table lists the fields in the Persistence Properties view for this mapping." summary="This table lists the fields in the Persistence Properties view for this mapping." dir="ltr" border="1" width="100%" frame="border" rules="all" cellpadding="3" cellspacing="0">
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t4">Property</th>
<th align="left" valign="bottom" id="r1c2-t4">Description</th>
<th align="left" valign="bottom" id="r1c3-t4">Default</th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t4" headers="r1c1-t4">Map As</td>
<td align="left" headers="r2c1-t4 r1c2-t4">Defines this mapping as a <span class="bold">Basic Mapping</span>.
<p>This field corresponds to the <code>@Basic</code> annotation.</p>
</td>
<td align="left" headers="r2c1-t4 r1c3-t4">Basic</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t4" headers="r1c1-t4">Column</td>
<td align="left" headers="r3c1-t4 r1c2-t4">The database column mapped to the entity attribute. See <a href="ref_mapping_general.htm#CACGCBHB">"Column"</a> for details.
<ul>
<li type="disc">
<p>Name &ndash; Name of the database column.</p>
</li>
<li type="disc">
<p>Table &ndash; Name of the database table.</p>
</li>
<li type="disc">
<p>Insertable &ndash; Specify if the column is always included in <code>SQL INSERT</code> statements.</p>
</li>
<li type="disc">
<p>Updatable &ndash; Specify if the column is always included in <code>SQL UPDATE</code> statements.</p>
</li>
</ul>
</td>
<td align="left" headers="r3c1-t4 r1c3-t4">By default, the Column is assumed to be named identically to the attribute and always included in the <code>INSERT</code> and <code>UPDATE</code> statements.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t4" headers="r1c1-t4">Table</td>
<td align="left" headers="r4c1-t4 r1c2-t4">Name of the database table.</td>
<td align="left" headers="r4c1-t4 r1c3-t4"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t4" headers="r1c1-t4">Fetch</td>
<td align="left" headers="r5c1-t4 r1c2-t4">Defines how data is loaded from the database. See <a href="ref_mapping_general.htm#CACGGGHB">"Fetch Type"</a> for details.
<ul>
<li type="disc">
<p>Eager</p>
</li>
<li type="disc">
<p>Lazy</p>
</li>
</ul>
</td>
<td align="left" headers="r5c1-t4 r1c3-t4">Eager</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t4" headers="r1c1-t4">Optional</td>
<td align="left" headers="r6c1-t4 r1c2-t4">Specifies if this field is can be null.</td>
<td align="left" headers="r6c1-t4 r1c3-t4">Yes</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r7c1-t4" headers="r1c1-t4">Lob</td>
<td align="left" headers="r7c1-t4 r1c2-t4">Specifies if this is a large objects (BLOB or CLOB). See <a href="ref_mapping_general.htm#CACBBIBI">"Lob"</a> for details.</td>
<td align="left" headers="r7c1-t4 r1c3-t4"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r8c1-t4" headers="r1c1-t4">Temporal</td>
<td align="left" headers="r8c1-t4 r1c2-t4">Specifies the type of data. See <a href="ref_mapping_general.htm#CACEAJGD">"Temporal"</a> for details.
<ul>
<li type="disc">
<p>Date</p>
</li>
<li type="disc">
<p>Time</p>
</li>
<li type="disc">
<p>Timestamp</p>
</li>
</ul>
</td>
<td align="left" headers="r8c1-t4 r1c3-t4"><br /></td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="inftblruleinformal" --></li>
</ol>
<p>Eclipse adds the following annotations to the field:</p>
<pre xml:space="preserve" class="oac_no_warn">
@Column(name="<span class="italic">&lt;COLUMN_NAME&gt;</span>", table="<span class="italic">&lt;COLUMN_TABLE&gt;</span>", 
    insertable=<span class="italic">&lt;INSERTABLE&gt;</span>, updatable=<span class="italic">&lt;UPDATABLE&gt;</span>)
@Basic(fetch=FetchType.<span class="italic">&lt;FETCH_TYPE&gt;</span>, optional = <span class="italic">&lt;OPTIONAL&gt;</span>)
@Temporal(TemporalType.<span class="italic">&lt;TEMPORAL&gt;</span>)


</pre>
<p>&nbsp;</p>
<img src="img/ngrelt.png" alt="Related task" title="Related task" /><br />
<br />
<a href="task_mapping.htm#BABDGBIJ">Mapping an entity</a>
<p>&nbsp;</p>
<img src="img/ngrelr.png" alt="Related reference" title="Related reference" /><br />
<br />
<a href="ref_persistence_outline.htm#BABEGGFE">JPA Structure view</a><br />
<a href="ref_persistence_map_view.htm#BABIFBAF">JPA Details view (for attributes)</a>
<p>&nbsp;</p>
<img src="img/ngrelc.png" alt="Related concept" title="Related concept" /><br />
<br />
<a href="concept_mapping.htm#BABBDJFI">Understanding OR mappings</a><br />
<a href="concepts001.htm#BABBGFJG">Understanding EJB 3.0 Java Persistence API</a></div>
<!-- class="sect2" -->
<!-- Start Footer -->
<div class="footer">
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td align="left" width="86%"><a href="dcommon/html/cpyr.htm"><span class="copyrightlogo">Copyright&nbsp;&copy;&nbsp;2006, 2007,&nbsp;Oracle.&nbsp;All&nbsp;rights&nbsp;reserved.</span></a></td>
</tr>
</table>
</div>
<!-- class="footer" -->
</body>
</html>

Back to the top