Modified:
websites/staging/openjpa/trunk/content/begin-using-openjpa---the-basics.html
==============================================================================
---
websites/staging/openjpa/trunk/content/begin-using-openjpa---the-basics.html
(original)
+++
websites/staging/openjpa/trunk/content/begin-using-openjpa---the-basics.html
Wed Sep 30 17:03:02 2015
@@ -145,8 +145,19 @@ limitations under the License.
</td>
<td valign="top" width="100%"
style="overflow:hidden;">
<div class="wiki-content">
- <p><a
name="BeginusingOpenJPA-TheBasics-Introduction"></a></p>
-<h1 id="introduction">Introduction</h1>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a name="BeginusingOpenJPA-TheBasics-Introduction"></a></p>
+<h1 id="introduction">Introduction<a class="headerlink" href="#introduction"
title="Permanent link">¶</a></h1>
<p>OpenJPA is an open source implementation of the Java JPA (Java Persistence
API) specification from Apache. JPA provides an agnostic Java-based API for
storing and retrieving information to a backend database. It has a
@@ -167,7 +178,7 @@ To start, you must download the followin
your computer. For the purposes of this tutorial, we are using Eclipse as
the IDE and Microsoft Windows as the operating system of choice. </p>
<p><a name="BeginusingOpenJPA-TheBasics-Prerequisites"></a></p>
-<h2 id="prerequisites">Prerequisites</h2>
+<h2 id="prerequisites">Prerequisites<a class="headerlink"
href="#prerequisites" title="Permanent link">¶</a></h2>
<p><strong>Geronimo V2.2:</strong> You can get it <a
href="http://www.apache.org/dyn/closer.cgi/geronimo/2.2/geronimo-tomcat6-javaee5-2.2-bin.zip";>here</a>
. Download this file and unzip it to a permanent location. There is no
installer. The server will run from the command line.</p>
@@ -188,13 +199,13 @@ instabilities. No issues have been noted
are provided with this tutorial. You will add them to your Eclipse
project.</p>
<p><a name="BeginusingOpenJPA-TheBasics-SetupandRunningtheSample"></a></p>
-<h1 id="setup-and-running-the-sample">Setup and Running the Sample</h1>
+<h1 id="setup-and-running-the-sample">Setup and Running the Sample<a
class="headerlink" href="#setup-and-running-the-sample" title="Permanent
link">¶</a></h1>
<p>Now, that you have all the prerequisites for this tutorial downloaded and
installed, the following sections will walk you through the Eclipse project
setup and the OpenJPA configuration. Make sure you read through and follow
each part carefully. </p>
<p><a name="BeginusingOpenJPA-TheBasics-SettingupEclipse"></a></p>
-<h2 id="setting-up-eclipse">Setting up Eclipse</h2>
+<h2 id="setting-up-eclipse">Setting up Eclipse<a class="headerlink"
href="#setting-up-eclipse" title="Permanent link">¶</a></h2>
<p>After installing Eclipse, create a new project in a dedicated workspace for
the tutorial. Complete the following setup instructions: First, make sure
your Eclipse environment is updated and has the Geronimo plugin. If you do
@@ -297,21 +308,18 @@ Geronimo comes with OpenJPA v1.1 built i
</ul>
</li>
<li>
-<p>Now copy the index.jsp file from the tutorial into the Web Content
directory under the Project directory in Windows Explorer:<br />
-</p>
-<p><img src="images/image012.jpg"/><br />
-</p>
+<p>Now copy the index.jsp file from the tutorial into the Web Content
directory under the Project directory in Windows Explorer: </p>
+<p><img src="images/image012.jpg"/> </p>
<ul>
<li>
-<p>Got to the Project Explorer and refresh the project. You should see
this:<br />
-</p>
+<p>Got to the Project Explorer and refresh the project. You should see this:
</p>
<p><img src="images/image013.jpg"/></p>
</li>
</ul>
</li>
</ol>
<p><a
name="BeginusingOpenJPA-TheBasics-RunningandConfiguringGeronimoandDerby"></a></p>
-<h2 id="running-and-configuring-geronimo-and-derby">Running and Configuring
Geronimo and Derby</h2>
+<h2 id="running-and-configuring-geronimo-and-derby">Running and Configuring
Geronimo and Derby<a class="headerlink"
href="#running-and-configuring-geronimo-and-derby" title="Permanent
link">¶</a></h2>
<p>Geronimo has no installer and runs from the command line. Here are some
quick instructions to get you started.</p>
<ol>
@@ -329,8 +337,7 @@ directory.</li>
</li>
<li>
<p>Open a web browser and go to the address:</p>
-<p><a
href="http://localhost:8080/console";>http://localhost:8080/console</a><br />
-</p>
+<p><a href="http://localhost:8080/console";>http://localhost:8080/console</a>
</p>
<p><img src="images/image016.jpg"/></p>
<p>The default password is <em>manager</em>.</p>
</li>
@@ -338,8 +345,7 @@ directory.</li>
<p>You will come to the Welcome page. On the left menu, at the bottom, find
the section for the Embedded DB. This is the Derby database control
page.</p>
-<p><img src="images/image017.jpg"/><br />
-</p>
+<p><img src="images/image017.jpg"/> </p>
</li>
<li>
<p>Click on the link for the <strong>DB Manager</strong></p>
@@ -349,22 +355,20 @@ page.</p>
<p>In the Run SQL section, in the text field labeled Create DB, type in
<strong>StoreSystem</strong>. This is the name of the database that the
OpenJPA sample is
configured to transact.</p>
-<p><img src="images/image018.jpg"/><br />
-</p>
+<p><img src="images/image018.jpg"/> </p>
</li>
<li>
<p>Click on the <strong>Create</strong> button. You should now see the
<strong>StoreSystem</strong> database appear in
the <strong>DB Viewer</strong> section.</p>
-<p><img src="images/image019.jpg"/><br />
-</p>
+<p><img src="images/image019.jpg"/> </p>
</li>
<li>
<p>We are now ready to deploy and run the sample code.</p>
</li>
</ol>
<p><a
name="BeginusingOpenJPA-TheBasics-RunningandDeployingtheSampleCodeinGeronimo"></a></p>
-<h2 id="running-and-deploying-the-sample-code-in-geronimo">Running and
Deploying the Sample Code in Geronimo</h2>
+<h2 id="running-and-deploying-the-sample-code-in-geronimo">Running and
Deploying the Sample Code in Geronimo<a class="headerlink"
href="#running-and-deploying-the-sample-code-in-geronimo" title="Permanent
link">¶</a></h2>
<p>The sample code provided with this tutorial is working code. It is a simple
inventory database program that shows items and categories. But even this
simple example requires the ability to add, edit and delete entries. It
@@ -378,8 +382,7 @@ sample code follow these instructions:</
<li>
<p>In Eclipse, in the Project Explorer, right click on the OpenJPATutorial
project and select: <strong>Export->EAR file</strong>.</p>
-<p><img src="images/image020.jpg"/><br />
-</p>
+<p><img src="images/image020.jpg"/> </p>
</li>
<li>
<p>In the Ear Export dialog, find a convenient place to put the
@@ -387,8 +390,7 @@ exported EAR file.</p>
</li>
<li>
<p>Check the <strong>Overwrite existing file</strong> check box.</p>
-<p><img src="images/image021.jpg"/><br />
-</p>
+<p><img src="images/image021.jpg"/> </p>
</li>
<li>
<p>Click <strong>Finish</strong>.</p>
@@ -397,8 +399,7 @@ exported EAR file.</p>
<p>Go out to Windows Explorer and copy the file
<strong>TutorialDeploymentPlan.xml</strong>
to the location of the exported ear. This is the deployment plan that
Geronimo requires to deploy the application.</p>
-<p><img src="images/image022.jpg"/><br />
-</p>
+<p><img src="images/image022.jpg"/> </p>
</li>
<li>
<p>Open the Geronimo console in a web browser and log in.</p>
@@ -408,13 +409,11 @@ section, click on the <strong>Deploy New
<li>
<p>Browse to the location of the exported EAR file and the deployment plan
XML file.</p>
-<p><img src="images/image023.jpg"/><br />
-</p>
+<p><img src="images/image023.jpg"/> </p>
</li>
<li>
<p>Click on the <strong>Install</strong> button. You should see this.</p>
-<p><img src="images/image024.jpg"/><br />
-</p>
+<p><img src="images/image024.jpg"/> </p>
</li>
<li>
<p>In the Console Navigation menu on the left, under the
<strong>Applications</strong>
@@ -423,15 +422,13 @@ section, click on the <strong>Web App WA
<li>
<p>Notice that the OpenJPATutorial application is now listed and that there
is a clickable link under the URL heading:</p>
-<p><img src="images/image025.jpg"/><br />
-</p>
+<p><img src="images/image025.jpg"/> </p>
</li>
</ul>
</li>
<li>
<p>Click on the link <strong>OpenJPATutorial</strong> and now you should see
this:</p>
-<p><img src="images/image026.jpg"/><br />
-</p>
+<p><img src="images/image026.jpg"/> </p>
<p>Each of the buttons will execute OpenJPA code. The lists are filled by
running queries on the Derby database.</p>
<ul>
@@ -441,7 +438,7 @@ running queries on the Derby database.</
</li>
</ol>
<p><a name="BeginusingOpenJPA-TheBasics-ExaminingtheSampleCode"></a></p>
-<h1 id="examining-the-sample-code">Examining the Sample Code</h1>
+<h1 id="examining-the-sample-code">Examining the Sample Code<a
class="headerlink" href="#examining-the-sample-code" title="Permanent
link">¶</a></h1>
<p>Now that everything is set up and you have seen it work, let's look more
closely at the parts of the code that use OpenJPA. The JSP code is just a
prop to explore OpenJPA and we will not examine it.The sample application
@@ -472,32 +469,32 @@ for synchronization with the database. I
not exist, OpenJPA can use these annotations to create the tables' schema
dynamically based on the property type and length.</p>
<p><DIV style="border-style: solid;border-width: 0px;"><DIV
style="border-bottom-width: 1px;border-bottom-style:
solid;"><B>InventoryCategory.java</B></DIV></p>
-<div class="codehilite"><pre><span class="nb">package</span> <span
class="n">tutorial</span><span class="p">;</span>
-<span class="nb">import</span> <span class="n">java</span><span
class="o">.</span><span class="n">util</span><span class="o">.</span><span
class="n">List</span><span class="p">;</span>
+<div class="codehilite"><pre><span class="n">package</span> <span
class="n">tutorial</span><span class="p">;</span>
+<span class="n">import</span> <span class="n">java</span><span
class="p">.</span><span class="n">util</span><span class="p">.</span><span
class="n">List</span><span class="p">;</span>
-<span class="nb">import</span> <span class="n">javax</span><span
class="o">.</span><span class="n">persistence</span><span
class="o">.</span><span class="n">CascadeType</span><span class="p">;</span>
-<span class="nb">import</span> <span class="n">javax</span><span
class="o">.</span><span class="n">persistence</span><span
class="o">.</span><span class="n">Column</span><span class="p">;</span>
-<span class="nb">import</span> <span class="n">javax</span><span
class="o">.</span><span class="n">persistence</span><span
class="o">.</span><span class="n">Entity</span><span class="p">;</span>
-<span class="nb">import</span> <span class="n">javax</span><span
class="o">.</span><span class="n">persistence</span><span
class="o">.</span><span class="n">GeneratedValue</span><span class="p">;</span>
-<span class="nb">import</span> <span class="n">javax</span><span
class="o">.</span><span class="n">persistence</span><span
class="o">.</span><span class="n">GenerationType</span><span class="p">;</span>
-<span class="nb">import</span> <span class="n">javax</span><span
class="o">.</span><span class="n">persistence</span><span
class="o">.</span><span class="n">Id</span><span class="p">;</span>
-<span class="nb">import</span> <span class="n">javax</span><span
class="o">.</span><span class="n">persistence</span><span
class="o">.</span><span class="n">OneToMany</span><span class="p">;</span>
-<span class="nb">import</span> <span class="n">javax</span><span
class="o">.</span><span class="n">persistence</span><span
class="o">.</span><span class="n">Version</span><span class="p">;</span>
+<span class="n">import</span> <span class="n">javax</span><span
class="p">.</span><span class="n">persistence</span><span
class="p">.</span><span class="n">CascadeType</span><span class="p">;</span>
+<span class="n">import</span> <span class="n">javax</span><span
class="p">.</span><span class="n">persistence</span><span
class="p">.</span><span class="n">Column</span><span class="p">;</span>
+<span class="n">import</span> <span class="n">javax</span><span
class="p">.</span><span class="n">persistence</span><span
class="p">.</span><span class="n">Entity</span><span class="p">;</span>
+<span class="n">import</span> <span class="n">javax</span><span
class="p">.</span><span class="n">persistence</span><span
class="p">.</span><span class="n">GeneratedValue</span><span class="p">;</span>
+<span class="n">import</span> <span class="n">javax</span><span
class="p">.</span><span class="n">persistence</span><span
class="p">.</span><span class="n">GenerationType</span><span class="p">;</span>
+<span class="n">import</span> <span class="n">javax</span><span
class="p">.</span><span class="n">persistence</span><span
class="p">.</span><span class="n">Id</span><span class="p">;</span>
+<span class="n">import</span> <span class="n">javax</span><span
class="p">.</span><span class="n">persistence</span><span
class="p">.</span><span class="n">OneToMany</span><span class="p">;</span>
+<span class="n">import</span> <span class="n">javax</span><span
class="p">.</span><span class="n">persistence</span><span
class="p">.</span><span class="n">Version</span><span class="p">;</span>
-<span class="nv">@Entity</span>
+<span class="p">@</span><span class="n">Entity</span>
<span class="n">public</span> <span class="n">class</span> <span
class="n">InventoryCategory</span>
<span class="p">{</span>
- <span class="n">private</span> <span class="nb">int</span> <span
class="n">version</span><span class="p">;</span>
- <span class="n">private</span> <span class="nb">int</span> <span
class="n">id</span><span class="p">;</span>
+ <span class="n">private</span> <span class="n">int</span> <span
class="n">version</span><span class="p">;</span>
+ <span class="n">private</span> <span class="n">int</span> <span
class="n">id</span><span class="p">;</span>
<span class="n">private</span> <span class="n">String</span> <span
class="n">categoryName</span><span class="p">;</span>
<span class="n">private</span> <span class="n">String</span> <span
class="n">categoryDescription</span><span class="p">;</span>
- <span class="n">List</span><span class="sr"><InventoryItem></span>
<span class="n">items</span><span class="p">;</span>
+ <span class="n">List</span><span class="o"><</span><span
class="n">InventoryItem</span><span class="o">></span> <span
class="n">items</span><span class="p">;</span>
<span class="n">public</span> <span class="n">InventoryCategory</span><span
class="p">(){}</span>
- <span class="nv">@Column</span><span class="p">(</span><span
class="n">name</span> <span class="o">=</span> <span
class="s">"categoryName"</span><span class="p">)</span>
+ <span class="p">@</span><span class="n">Column</span><span
class="p">(</span><span class="n">name</span> <span class="p">=</span>
"<span class="n">categoryName</span>"<span class="p">)</span>
<span class="n">public</span> <span class="n">String</span> <span
class="n">getCategoryName</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="n">categoryName</span><span
class="p">;</span>
@@ -505,10 +502,10 @@ dynamically based on the property type a
<span class="n">public</span> <span class="n">void</span> <span
class="n">setCategoryName</span><span class="p">(</span><span
class="n">String</span> <span class="n">name</span><span class="p">)</span>
<span class="p">{</span>
- <span class="n">this</span><span class="o">.</span><span
class="n">categoryName</span> <span class="o">=</span> <span
class="n">name</span><span class="p">;</span>
+ <span class="n">this</span><span class="p">.</span><span
class="n">categoryName</span> <span class="p">=</span> <span
class="n">name</span><span class="p">;</span>
<span class="p">}</span>
- <span class="nv">@Column</span><span class="p">(</span><span
class="n">name</span> <span class="o">=</span> <span
class="s">"itemDescription"</span><span class="p">)</span>
+ <span class="p">@</span><span class="n">Column</span><span
class="p">(</span><span class="n">name</span> <span class="p">=</span>
"<span class="n">itemDescription</span>"<span class="p">)</span>
<span class="n">public</span> <span class="n">String</span> <span
class="n">getCategoryDescription</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span
class="n">categoryDescription</span><span class="p">;</span>
@@ -516,50 +513,50 @@ dynamically based on the property type a
<span class="n">public</span> <span class="n">void</span> <span
class="n">setCategoryDescription</span><span class="p">(</span><span
class="n">String</span> <span class="n">description</span><span
class="p">)</span>
<span class="p">{</span>
- <span class="n">this</span><span class="o">.</span><span
class="n">categoryDescription</span> <span class="o">=</span> <span
class="n">description</span><span class="p">;</span>
+ <span class="n">this</span><span class="p">.</span><span
class="n">categoryDescription</span> <span class="p">=</span> <span
class="n">description</span><span class="p">;</span>
<span class="p">}</span>
- <span class="nv">@Version</span>
- <span class="nv">@Column</span><span class="p">(</span><span
class="n">name</span> <span class="o">=</span> <span
class="s">"version_field"</span><span class="p">)</span>
- <span class="sr">//</span> <span class="ow">not</span> <span
class="n">required</span>
- <span class="n">public</span> <span class="nb">int</span> <span
class="n">getVersion</span><span class="p">()</span>
+ <span class="p">@</span><span class="n">Version</span>
+ <span class="p">@</span><span class="n">Column</span><span
class="p">(</span><span class="n">name</span> <span class="p">=</span>
"<span class="n">version_field</span>"<span class="p">)</span>
+ <span class="o">//</span> <span class="n">not</span> <span
class="n">required</span>
+ <span class="n">public</span> <span class="n">int</span> <span
class="n">getVersion</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="n">version</span><span
class="p">;</span>
<span class="p">}</span>
- <span class="n">public</span> <span class="n">void</span> <span
class="n">setVersion</span><span class="p">(</span><span class="nb">int</span>
<span class="n">version</span><span class="p">)</span>
+ <span class="n">public</span> <span class="n">void</span> <span
class="n">setVersion</span><span class="p">(</span><span class="n">int</span>
<span class="n">version</span><span class="p">)</span>
<span class="p">{</span>
- <span class="n">this</span><span class="o">.</span><span
class="n">version</span> <span class="o">=</span> <span
class="n">version</span><span class="p">;</span>
+ <span class="n">this</span><span class="p">.</span><span
class="n">version</span> <span class="p">=</span> <span
class="n">version</span><span class="p">;</span>
<span class="p">}</span>
- <span class="nv">@Id</span>
- <span class="nv">@GeneratedValue</span><span class="p">(</span><span
class="n">strategy</span> <span class="o">=</span> <span
class="n">GenerationType</span><span class="o">.</span><span
class="n">AUTO</span><span class="p">)</span>
- <span class="n">public</span> <span class="nb">int</span> <span
class="n">getId</span><span class="p">()</span>
+ <span class="p">@</span><span class="n">Id</span>
+ <span class="p">@</span><span class="n">GeneratedValue</span><span
class="p">(</span><span class="n">strategy</span> <span class="p">=</span>
<span class="n">GenerationType</span><span class="p">.</span><span
class="n">AUTO</span><span class="p">)</span>
+ <span class="n">public</span> <span class="n">int</span> <span
class="n">getId</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="n">id</span><span
class="p">;</span>
<span class="p">}</span>
- <span class="n">public</span> <span class="n">void</span> <span
class="n">setId</span><span class="p">(</span><span class="nb">int</span> <span
class="n">id</span><span class="p">)</span>
+ <span class="n">public</span> <span class="n">void</span> <span
class="n">setId</span><span class="p">(</span><span class="n">int</span> <span
class="n">id</span><span class="p">)</span>
<span class="p">{</span>
- <span class="n">this</span><span class="o">.</span><span
class="n">id</span> <span class="o">=</span> <span class="n">id</span><span
class="p">;</span>
+ <span class="n">this</span><span class="p">.</span><span
class="n">id</span> <span class="p">=</span> <span class="n">id</span><span
class="p">;</span>
<span class="p">}</span>
- <span class="nv">@OneToMany</span><span class="p">(</span><span
class="n">targetEntity</span><span class="o">=</span><span
class="n">tutorial</span><span class="o">.</span><span
class="n">InventoryItem</span><span class="o">.</span><span
class="n">class</span><span class="p">,</span>
- <span class="n">cascade</span><span class="o">=</span><span
class="n">CascadeType</span><span class="o">.</span><span
class="n">ALL</span><span class="p">,</span>
- <span class="n">mappedBy</span><span class="o">=</span><span
class="s">"category"</span><span class="p">)</span>
- <span class="n">public</span> <span class="n">List</span><span
class="sr"><InventoryItem></span> <span class="n">getItems</span><span
class="p">()</span>
+ <span class="p">@</span><span class="n">OneToMany</span><span
class="p">(</span><span class="n">targetEntity</span><span
class="p">=</span><span class="n">tutorial</span><span class="p">.</span><span
class="n">InventoryItem</span><span class="p">.</span><span
class="n">class</span><span class="p">,</span>
+ <span class="n">cascade</span><span class="p">=</span><span
class="n">CascadeType</span><span class="p">.</span><span
class="n">ALL</span><span class="p">,</span>
+ <span class="n">mappedBy</span><span class="p">=</span>"<span
class="n">category</span>"<span class="p">)</span>
+ <span class="n">public</span> <span class="n">List</span><span
class="o"><</span><span class="n">InventoryItem</span><span
class="o">></span> <span class="n">getItems</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="n">items</span><span
class="p">;</span>
<span class="p">}</span>
- <span class="n">public</span> <span class="n">void</span> <span
class="n">setItems</span><span class="p">(</span><span
class="n">List</span><span class="sr"><InventoryItem></span> <span
class="n">items</span><span class="p">)</span>
+ <span class="n">public</span> <span class="n">void</span> <span
class="n">setItems</span><span class="p">(</span><span
class="n">List</span><span class="o"><</span><span
class="n">InventoryItem</span><span class="o">></span> <span
class="n">items</span><span class="p">)</span>
<span class="p">{</span>
- <span class="n">this</span><span class="o">.</span><span
class="n">items</span> <span class="o">=</span> <span
class="n">items</span><span class="p">;</span>
+ <span class="n">this</span><span class="p">.</span><span
class="n">items</span> <span class="p">=</span> <span
class="n">items</span><span class="p">;</span>
<span class="p">}</span>
<span class="n">public</span> <span class="n">void</span> <span
class="n">addItem</span><span class="p">(</span><span
class="n">InventoryItem</span> <span class="n">item</span><span
class="p">)</span>
<span class="p">{</span>
- <span class="n">this</span><span class="o">.</span><span
class="n">items</span><span class="o">.</span><span class="n">add</span><span
class="p">(</span><span class="n">item</span><span class="p">);</span>
+ <span class="n">this</span><span class="p">.</span><span
class="n">items</span><span class="p">.</span><span class="n">add</span><span
class="p">(</span><span class="n">item</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -599,8 +596,7 @@ convention must be observed.
"persistence.xml" that describes how to access the data. The XML file must
be created in the META-INF directory. The META-INF directory containing the
persistence.xml must be located with the source files.</p>
-<p><img src="images/image027.jpg"/><br />
-</p>
+<p><img src="images/image027.jpg"/> </p>
<p>In the following example, the file only requires a few fields.</p>
<p><DIV style="border-style:solid;border-width: 0px;"><DIV
style="border-bottom-width: 1px;border-bottom-style:
solid;"><B>META-INF/persistence.xml</B></DIV></p>
<div class="codehilite"><pre><span class="nt"><persistence</span> <span
class="na">xmlns=</span><span
class="s">http://java.sun.com/xml/ns/persistence</span>
@@ -651,10 +647,10 @@ or access transactions or to send querie
<li>
<p>The following code must be added before using any of the persistence
APIs (If you are using the provided sample code, this is already included):</p>
-<div class="codehilite"><pre><span class="n">EntityManagerFactory</span> <span
class="n">factory</span> <span class="o">=</span> <span
class="n">Persistence</span><span class="o">.</span>
- <span class="n">createEntityManagerFactory</span><span
class="p">(</span><span class="s">"InventorySystem"</span><span
class="p">,</span> <span class="n">System</span><span class="o">.</span><span
class="n">getProperties</span><span class="p">());</span>
+<div class="codehilite"><pre><span class="n">EntityManagerFactory</span> <span
class="n">factory</span> <span class="p">=</span> <span
class="n">Persistence</span><span class="p">.</span>
+ <span class="n">createEntityManagerFactory</span><span
class="p">(</span>"<span class="n">InventorySystem</span>"<span
class="p">,</span> <span class="n">System</span><span class="p">.</span><span
class="n">getProperties</span><span class="p">());</span>
-<span class="n">EntityManager</span> <span class="n">em</span> <span
class="o">=</span> <span class="n">factory</span><span class="o">.</span><span
class="n">createEntityManager</span><span class="p">();</span>
+<span class="n">EntityManager</span> <span class="n">em</span> <span
class="p">=</span> <span class="n">factory</span><span class="p">.</span><span
class="n">createEntityManager</span><span class="p">();</span>
</pre></div>
@@ -668,10 +664,10 @@ be class properties.</li>
<li>
<p>Regardless of the scope, the EntityManager and the EntityManagerFactory
should be closed when they are no longer needed:</p>
-<div class="codehilite"><pre> <span class="o">...</span>
- <span class="n">em</span><span class="o">.</span><span
class="nb">close</span><span class="p">();</span>
- <span class="n">factory</span><span class="o">.</span><span
class="nb">close</span><span class="p">();</span>
- <span class="o">...</span>
+<div class="codehilite"><pre> <span class="p">...</span>
+ <span class="n">em</span><span class="p">.</span><span
class="n">close</span><span class="p">();</span>
+ <span class="n">factory</span><span class="p">.</span><span
class="n">close</span><span class="p">();</span>
+ <span class="p">...</span>
</pre></div>
@@ -693,23 +689,23 @@ but it is a good idea for keeping the fu
example, if you want to pull all of the records from the InventoryItem
table, the code would look like this:</p>
<p><DIV style="border-style:solid;border-width: 0px;"><DIV
style="border-bottom-width: 1px;border-bottom-style:
solid;"><B>InventoryEntityBroker.java</B></DIV></p>
-<div class="codehilite"><pre><span class="o">...</span>
-<span class="n">List</span><span class="sr"><Person></span> <span
class="n">getAllItems</span><span class="p">()</span>
+<div class="codehilite"><pre><span class="p">...</span>
+<span class="n">List</span><span class="o"><</span><span
class="n">Person</span><span class="o">></span> <span
class="n">getAllItems</span><span class="p">()</span>
<span class="p">{</span>
- <span class="n">Query</span> <span class="sx">q = </span><span
class="n">em</span><span class="o">.</span><span
class="n">createQuery</span><span class="p">(</span><span
class="s">"SELECT item FROM InventoryItem item"</span><span
class="p">);</span>
+ <span class="n">Query</span> <span class="n">q</span> <span
class="p">=</span> <span class="n">em</span><span class="p">.</span><span
class="n">createQuery</span><span class="p">(</span>"<span
class="n">SELECT</span> <span class="n">item</span> <span class="n">FROM</span>
<span class="n">InventoryItem</span> <span class="n">item</span>"<span
class="p">);</span>
- <span class="k">return</span> <span class="p">(</span><span
class="n">List</span><span class="sr"><InventoryItem></span><span
class="p">)</span><span class="sx">q.getResultList();</span>
-<span class="sx">}</span>
-<span class="sx">.</span><span class="o">..</span>
+ <span class="k">return</span> <span class="p">(</span><span
class="n">List</span><span class="o"><</span><span
class="n">InventoryItem</span><span class="o">></span><span
class="p">)</span><span class="n">q</span><span class="p">.</span><span
class="n">getResultList</span><span class="p">();</span>
+<span class="p">}</span>
+<span class="p">...</span>
</pre></div>
</div>
<p><DIV style="border-style:solid;border-width: 0px;"><DIV
style="border-bottom-width: 1px;border-bottom-style:
solid;"><B>index.jsp</B></DIV></p>
-<div class="codehilite"><pre><span class="o">...</span>
-<span class="n">List</span><span class="sr"><InventoryItem></span> <span
class="n">itemList</span> <span class="o">=</span> <span
class="n">getAllItems</span><span class="p">();</span>
-<span class="o">...</span>
+<div class="codehilite"><pre><span class="p">...</span>
+<span class="n">List</span><span class="o"><</span><span
class="n">InventoryItem</span><span class="o">></span> <span
class="n">itemList</span> <span class="p">=</span> <span
class="n">getAllItems</span><span class="p">();</span>
+<span class="p">...</span>
</pre></div>
@@ -743,17 +739,17 @@ time an <em>"add"</em> is attempted.</p>
<li>
<p>Consider the following code:</p>
<p><DIV style="border-style:solid;border-width: 0px;"><DIV
style="border-bottom-width: 1px;border-bottom-style:
solid;"><B>InventoryEntityBroker</B></DIV></p>
-<div class="codehilite"><pre><span class="o">...</span>
-<span class="n">void</span> <span class="n">addItem</span><span
class="p">(</span><span class="n">String</span> <span
class="n">name</span><span class="p">,</span> <span class="n">String</span>
<span class="n">description</span><span class="p">,</span> <span
class="n">float</span> <span class="n">price</span><span class="p">,</span>
<span class="nb">int</span> <span class="n">categoryID</span><span
class="p">)</span>
+<div class="codehilite"><pre><span class="p">...</span>
+<span class="n">void</span> <span class="n">addItem</span><span
class="p">(</span><span class="n">String</span> <span
class="n">name</span><span class="p">,</span> <span class="n">String</span>
<span class="n">description</span><span class="p">,</span> <span
class="n">float</span> <span class="n">price</span><span class="p">,</span>
<span class="n">int</span> <span class="n">categoryID</span><span
class="p">)</span>
<span class="p">{</span>
- <span class="n">InventoryItem</span> <span class="n">item</span> <span
class="o">=</span> <span class="k">new</span> <span
class="n">InventoryItem</span><span class="p">();</span>
- <span class="n">item</span><span class="o">.</span><span
class="n">setName</span><span class="p">(</span><span
class="n">name</span><span class="p">);</span>
- <span class="n">item</span><span class="o">.</span><span
class="n">setDescription</span><span class="p">(</span><span
class="n">description</span><span class="p">);</span>
- <span class="o">...</span>
+ <span class="n">InventoryItem</span> <span class="n">item</span> <span
class="p">=</span> <span class="n">new</span> <span
class="n">InventoryItem</span><span class="p">();</span>
+ <span class="n">item</span><span class="p">.</span><span
class="n">setName</span><span class="p">(</span><span
class="n">name</span><span class="p">);</span>
+ <span class="n">item</span><span class="p">.</span><span
class="n">setDescription</span><span class="p">(</span><span
class="n">description</span><span class="p">);</span>
+ <span class="p">...</span>
- <span class="n">em</span><span class="o">.</span><span
class="n">persist</span><span class="p">(</span><span
class="n">item</span><span class="p">);</span>
+ <span class="n">em</span><span class="p">.</span><span
class="n">persist</span><span class="p">(</span><span
class="n">item</span><span class="p">);</span>
<span class="p">}</span>
-<span class="o">...</span>
+<span class="p">...</span>
</pre></div>
@@ -764,13 +760,13 @@ EntityManager.persist() method will thro
not been started. The transaction must be committed by calling the
Transaction.commit() method after all updates have been applied or else the
changes will not be saved to the database:</p>
-<div class="codehilite"><pre><span class="o">...</span>
-<span class="n">em</span><span class="o">.</span><span
class="n">getTransaction</span><span class="p">()</span><span
class="o">.</span><span class="n">begin</span><span class="p">();</span>
+<div class="codehilite"><pre><span class="p">...</span>
+<span class="n">em</span><span class="p">.</span><span
class="n">getTransaction</span><span class="p">().</span><span
class="n">begin</span><span class="p">();</span>
-<span class="n">addItem</span><span class="p">(</span><span
class="o">...</span><span class="p">);</span>
+<span class="n">addItem</span><span class="p">(...);</span>
-<span class="n">em</span><span class="o">.</span><span
class="n">getTransaction</span><span class="p">()</span><span
class="o">.</span><span class="n">commit</span><span class="p">();</span>
-<span class="o">...</span>
+<span class="n">em</span><span class="p">.</span><span
class="n">getTransaction</span><span class="p">().</span><span
class="n">commit</span><span class="p">();</span>
+<span class="p">...</span>
</pre></div>
@@ -798,15 +794,15 @@ fields.
Open the source file, InventoryCategory.java in Eclipse and find the
following code:</p>
<p><DIV style="border-style:solid;border-width: 0px;"><DIV
style="border-bottom-width: 1px;border-bottom-style:
solid;"><B>InventoryCategory.java</B></DIV></p>
-<div class="codehilite"><pre> <span class="o">...</span>
- <span class="nv">@OneToMany</span><span class="p">(</span><span
class="n">targetEntity</span><span class="o">=</span><span
class="n">tutorial</span><span class="o">.</span><span
class="n">InventoryItem</span><span class="o">.</span><span
class="n">class</span><span class="p">,</span>
- <span class="n">cascade</span><span class="o">=</span><span
class="n">CascadeType</span><span class="o">.</span><span
class="n">ALL</span><span class="p">,</span>
- <span class="n">mappedBy</span><span class="o">=</span><span
class="s">"category"</span><span class="p">)</span>
- <span class="n">public</span> <span class="n">List</span><span
class="sr"><InventoryItem></span> <span class="n">getItems</span><span
class="p">()</span>
+<div class="codehilite"><pre> <span class="p">...</span>
+ <span class="p">@</span><span class="n">OneToMany</span><span
class="p">(</span><span class="n">targetEntity</span><span
class="p">=</span><span class="n">tutorial</span><span class="p">.</span><span
class="n">InventoryItem</span><span class="p">.</span><span
class="n">class</span><span class="p">,</span>
+ <span class="n">cascade</span><span class="p">=</span><span
class="n">CascadeType</span><span class="p">.</span><span
class="n">ALL</span><span class="p">,</span>
+ <span class="n">mappedBy</span><span class="p">=</span>"<span
class="n">category</span>"<span class="p">)</span>
+ <span class="n">public</span> <span class="n">List</span><span
class="o"><</span><span class="n">InventoryItem</span><span
class="o">></span> <span class="n">getItems</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="n">items</span><span
class="p">;</span>
<span class="p">}</span>
- <span class="o">...</span>
+ <span class="p">...</span>
</pre></div>
@@ -824,14 +820,14 @@ words, InventoryItem has a class propert
InventoryItem.java and find the following code:</li>
</ul>
<p><DIV style="border-style:solid;border-width: 0px;"><DIV
style="border-bottom-width: 1px;border-bottom-style:
solid;"><B>InventoryItem.java</B></DIV></p>
-<div class="codehilite"><pre><span class="o">...</span>
-<span class="nv">@ManyToOne</span>
-<span class="nv">@JoinColumn</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s">"CAT_ID"</span><span class="p">,</span> <span
class="n">nullable</span><span class="o">=</span><span
class="n">false</span><span class="p">)</span>
+<div class="codehilite"><pre><span class="p">...</span>
+<span class="p">@</span><span class="n">ManyToOne</span>
+<span class="p">@</span><span class="n">JoinColumn</span><span
class="p">(</span><span class="n">name</span><span
class="p">=</span>"<span class="n">CAT_ID</span>"<span
class="p">,</span> <span class="n">nullable</span><span class="p">=</span><span
class="n">false</span><span class="p">)</span>
<span class="n">public</span> <span class="n">InventoryCategory</span> <span
class="n">getCategory</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="n">category</span><span
class="p">;</span>
<span class="p">}</span>
-<span class="o">...</span>
+<span class="p">...</span>
</pre></div>
@@ -866,7 +862,7 @@ site. The <a href="http://openjpa.
</tr></table>
<p><a name="BeginusingOpenJPA-TheBasics-Summary"></a></p>
-<h1 id="summary">Summary</h1>
+<h1 id="summary">Summary<a class="headerlink" href="#summary" title="Permanent
link">¶</a></h1>
<p>This was a very basic example of how to use OpenJPA with Geronimo and
Derby. However, many applications that require database persistence do not
use much more than the basic functionality demonstrated in this tutorial.
@@ -887,7 +883,7 @@ create a many-to-many relationship using
<p>*To make these changes you may have to delete the existing database
tables so that they can recreated with the new relationship fields.</p>
<p><a name="BeginusingOpenJPA-TheBasics-References"></a></p>
-<h1 id="references">References</h1>
+<h1 id="references">References<a class="headerlink" href="#references"
title="Permanent link">¶</a></h1>
<ul>
<li><strong>Java J2SE 1.6</strong><ul>
<li><a
href="https://cds.sun.com/is-bin/INTERSHOP.enfinity/WFS/CDS-CDS_Developer-Site/en_US/-/USD/ViewProductDetail-Start?ProductRef=jdk-6u16-oth-JPR@CDS-CDS_Developer";>Download</a>
Modified:
websites/staging/openjpa/trunk/content/beginners-performance-guide.html
==============================================================================
--- websites/staging/openjpa/trunk/content/beginners-performance-guide.html
(original)
+++ websites/staging/openjpa/trunk/content/beginners-performance-guide.html Wed
Sep 30 17:03:02 2015
@@ -145,15 +145,26 @@ limitations under the License.
</td>
<td valign="top" width="100%"
style="overflow:hidden;">
<div class="wiki-content">
- <p><a
name="IntroToTuningOpenJPA"></a></p>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a name="IntroToTuningOpenJPA"></a></p>
<p><a
name="BeginnersPerformanceGuide-OpenJPABeginnersPerformanceGuide"></a></p>
-<h1 id="openjpa-beginners-performance-guide">OpenJPA Beginners Performance
Guide</h1>
+<h1 id="openjpa-beginners-performance-guide">OpenJPA Beginners Performance
Guide<a class="headerlink" href="#openjpa-beginners-performance-guide"
title="Permanent link">¶</a></h1>
<p>This guide is targeted at new users of OpenJPA that would like to know some
of the important performance tuning properties. Please do not mistake this
for an exhaustive tuning guide. This is just enough information to make a
developer dangerous, not lethal.</p>
<p><a name="BeginnersPerformanceGuide-Enhancement"></a></p>
-<h2 id="enhancement">Enhancement</h2>
+<h2 id="enhancement">Enhancement<a class="headerlink" href="#enhancement"
title="Permanent link">¶</a></h2>
<p>OpenJPA uses byte-code weaving technologies to enhance user created Entity
class objects at build time or dynamically at run time. This allows us to
efficiently handle these objects. </p>
@@ -175,14 +186,14 @@ instead.</p>
</blockquote>
<p>It is recommended to set the following property to ensure that you don't
use this enhancement approach.</p>
-<div class="codehilite"><pre><span class="sr"><properties></span>
- <span class="o"><</span><span class="n">property</span> <span
class="n">name</span><span class="o">=</span><span
class="s">"openjpa.RuntimeUnenhancedClasses"</span> <span
class="n">value</span><span class="o">=</span><span
class="s">"unsupported"</span><span class="o">/></span>
-<span class="sr"><properties></span>
+<div class="codehilite"><pre><span class="o"><</span><span
class="k">properties</span><span class="o">></span>
+ <span class="o"><</span><span class="n">property</span> <span
class="n">name</span><span class="p">=</span>"<span
class="n">openjpa</span><span class="p">.</span><span
class="n">RuntimeUnenhancedClasses</span>" <span
class="n">value</span><span class="p">=</span>"<span
class="n">unsupported</span>"<span class="o">/></span>
+<span class="o"><</span><span class="k">properties</span><span
class="o">></span>
</pre></div>
<p><a name="BeginnersPerformanceGuide-ConnectionPooling"></a></p>
-<h2 id="connection-pooling">Connection Pooling</h2>
+<h2 id="connection-pooling">Connection Pooling<a class="headerlink"
href="#connection-pooling" title="Permanent link">¶</a></h2>
<p>As of the 2.1.0 release OpenJPA bundles <a
href="http://commons.apache.org/dbcp/";>Apache Commons DBCP</a>
as part of the binary download. When running in JSE environments a default
connection pool will be plugged in with the provided database configuration
@@ -211,11 +222,11 @@ example to figure out how to configure p
<p><a name="BeginnersPerformanceGuide-Caching"></a></p>
-<h2 id="caching">Caching</h2>
-<div class="codehilite"><pre><span class="sr"><properties></span>
- <span class="o"><</span><span class="n">property</span> <span
class="n">name</span><span class="o">=</span><span
class="s">"openjpa.DataCache"</span> <span
class="n">value</span><span class="o">=</span><span
class="s">"true"</span><span class="o">/></span>
- <span class="o"><</span><span class="n">property</span> <span
class="n">name</span><span class="o">=</span><span
class="s">"openjpa.QueryCache"</span> <span
class="n">value</span><span class="o">=</span><span
class="s">"true"</span><span class="o">/></span>
-<span class="sr"><properties></span>
+<h2 id="caching">Caching<a class="headerlink" href="#caching" title="Permanent
link">¶</a></h2>
+<div class="codehilite"><pre><span class="o"><</span><span
class="k">properties</span><span class="o">></span>
+ <span class="o"><</span><span class="n">property</span> <span
class="n">name</span><span class="p">=</span>"<span
class="n">openjpa</span><span class="p">.</span><span
class="n">DataCache</span>" <span class="n">value</span><span
class="p">=</span>"<span class="n">true</span>"<span
class="o">/></span>
+ <span class="o"><</span><span class="n">property</span> <span
class="n">name</span><span class="p">=</span>"<span
class="n">openjpa</span><span class="p">.</span><span
class="n">QueryCache</span>" <span class="n">value</span><span
class="p">=</span>"<span class="n">true</span>"<span
class="o">/></span>
+<span class="o"><</span><span class="k">properties</span><span
class="o">></span>
</pre></div>
Modified: websites/staging/openjpa/trunk/content/best-practices.html
==============================================================================
--- websites/staging/openjpa/trunk/content/best-practices.html (original)
+++ websites/staging/openjpa/trunk/content/best-practices.html Wed Sep 30
17:03:02 2015
@@ -145,11 +145,21 @@ limitations under the License.
</td>
<td valign="top" width="100%"
style="overflow:hidden;">
<div class="wiki-content">
- <p><a
name="Best.Practics"></a></p>
-<h1 id="openjpa-best-practices">OpenJPA Best Practices</h1>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a name="Best.Practics"></a></p>
+<h1 id="openjpa-best-practices">OpenJPA Best Practices<a class="headerlink"
href="#openjpa-best-practices" title="Permanent link">¶</a></h1>
<ul>
-<li><a href="best-practices.html">TBD</a> — <SPAN
class="smalltext">TBD</SPAN> <br />
-</li>
+<li><a href="best-practices.html">TBD</a> — <SPAN
class="smalltext">TBD</SPAN> </li>
</ul>
</div>
</td>
Modified:
websites/staging/openjpa/trunk/content/build-and-runtime-dependencies.html
==============================================================================
--- websites/staging/openjpa/trunk/content/build-and-runtime-dependencies.html
(original)
+++ websites/staging/openjpa/trunk/content/build-and-runtime-dependencies.html
Wed Sep 30 17:03:02 2015
@@ -145,9 +145,20 @@ limitations under the License.
</td>
<td valign="top" width="100%"
style="overflow:hidden;">
<div class="wiki-content">
- <p><a
name="OpenJPABuildandRuntimeDependencies></a></p>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a name="OpenJPABuildandRuntimeDependencies></a></p>
<p><a name="BuildandRuntimeDependencies-Javaversions"></a></p>
-<h2 id="java-versions">Java versions</h2>
+<h2 id="java-versions">Java versions<a class="headerlink"
href="#java-versions" title="Permanent link">¶</a></h2>
<ul>
<li>OpenJPA trunk (i.e. OpenJPA 2.2.0 currently) and 2.1.x branch require JDK
1.6.</li>
<li>OpenJPA 2.0.x branch requires JDK 1.6 or 1.5. Note that some functionality
that requires JDK 1.6 will not be available if you choose to build with JDK
1.5.</li>
@@ -156,18 +167,18 @@ limitations under the License.
<li>OpenJPA 1.0.x branch requires JDK 1.5 or 1.4.</li>
</ul>
<p><a name="BuildandRuntimeDependencies-Mavenversions"></a></p>
-<h2 id="maven-versions">Maven versions</h2>
+<h2 id="maven-versions">Maven versions<a class="headerlink"
href="#maven-versions" title="Permanent link">¶</a></h2>
<ul>
<li>Trunk, 2.2.x, 2.2.1.x, 2.1.x and 2.0.x branches require Maven 2.2.1.</li>
<li>1.3.x, 1.2.x, 1.1.x and 1.0.x branches require Maven 2.0.9.</li>
</ul>
<p><a name="BuildandRuntimeDependencies-RuntimeDependencies"></a></p>
-<h2 id="runtime-dependencies">Runtime Dependencies</h2>
+<h2 id="runtime-dependencies">Runtime Dependencies<a class="headerlink"
href="#runtime-dependencies" title="Permanent link">¶</a></h2>
<p>The binary release download of OpenJPA
<em>apache-openjpa-<version>-binary.zip</em> includes all of the code
needed to
run in a stand-alone Java SE JVM or within a Java EE application server.</p>
<p><a name="BuildandRuntimeDependencies-OpenJPA1.0.x-1.2.xReleases"></a></p>
-<h3 id="openjpa-10x-12x-releases">OpenJPA 1.0.x - 1.2.x Releases</h3>
+<h3 id="openjpa-10x-12x-releases">OpenJPA 1.0.x - 1.2.x Releases<a
class="headerlink" href="#openjpa-10x-12x-releases" title="Permanent
link">¶</a></h3>
<p>The binary download includes the following required OpenJPA core
artifact:</p>
<ul>
<li>openjpa-<version>.jar</li>
@@ -193,7 +204,7 @@ JDBC driver artifacts required by your d
<li>derby-10.2.2.0.jar</li>
</ul>
<p><a name="BuildandRuntimeDependencies-OpenJPA1.3.0SNAPSHOTBranch"></a></p>
-<h3 id="openjpa-130-snapshot-branch">OpenJPA 1.3.0 SNAPSHOT Branch</h3>
+<h3 id="openjpa-130-snapshot-branch">OpenJPA 1.3.0 SNAPSHOT Branch<a
class="headerlink" href="#openjpa-130-snapshot-branch" title="Permanent
link">¶</a></h3>
<p>The binary download includes the following required OpenJPA core
artifact:</p>
<ul>
<li>openjpa-<version>.jar</li>
@@ -236,7 +247,7 @@ core code plus all of the runtime depend
<li>serp-1.13.1.jar</li>
</ul>
<p><a name="BuildandRuntimeDependencies-OpenJPA2.0.xReleases"></a></p>
-<h3 id="openjpa-20x-releases">OpenJPA 2.0.x Releases</h3>
+<h3 id="openjpa-20x-releases">OpenJPA 2.0.x Releases<a class="headerlink"
href="#openjpa-20x-releases" title="Permanent link">¶</a></h3>
<p>The binary download includes the following required OpenJPA core
artifact:</p>
<ul>
<li>openjpa-<version>.jar</li>
@@ -279,7 +290,7 @@ core code plus all of the runtime depend
<li>serp-1.13.1.jar</li>
</ul>
<p><a
name="BuildandRuntimeDependencies-OpenJPA2.1.xReleasesandOpenJPA2.2.0SNAPSHOTBranch"></a></p>
-<h3 id="openjpa-21x-releases-and-openjpa-220-snapshot-branch">OpenJPA 2.1.x
Releases and OpenJPA 2.2.0 SNAPSHOT Branch</h3>
+<h3 id="openjpa-21x-releases-and-openjpa-220-snapshot-branch">OpenJPA 2.1.x
Releases and OpenJPA 2.2.0 SNAPSHOT Branch<a class="headerlink"
href="#openjpa-21x-releases-and-openjpa-220-snapshot-branch" title="Permanent
link">¶</a></h3>
<p>The binary download includes the following required OpenJPA core
artifact:</p>
<ul>
<li>openjpa-<version>.jar</li>
Modified: websites/staging/openjpa/trunk/content/buildbot.tips.n.techniques.html
==============================================================================
--- websites/staging/openjpa/trunk/content/buildbot.tips.n.techniques.html
(original)
+++ websites/staging/openjpa/trunk/content/buildbot.tips.n.techniques.html Wed
Sep 30 17:03:02 2015
@@ -145,9 +145,20 @@ limitations under the License.
</td>
<td valign="top" width="100%"
style="overflow:hidden;">
<div class="wiki-content">
- <p><a
name="Buildbot.Tips.and.Techniques"></a></p>
-<h1 id="tips-on-using-apache-buildbot-for-openjpa-documentation-build">Tips on
Using Apache BuildBot for OpenJPA Documentation Build</h1>
-<h2 id="get-help-from-infrastructure-team">Get Help from Infrastructure
team</h2>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a name="Buildbot.Tips.and.Techniques"></a></p>
+<h1 id="tips-on-using-apache-buildbot-for-openjpa-documentation-build">Tips on
Using Apache BuildBot for OpenJPA Documentation Build<a class="headerlink"
href="#tips-on-using-apache-buildbot-for-openjpa-documentation-build"
title="Permanent link">¶</a></h1>
+<h2 id="get-help-from-infrastructure-team">Get Help from Infrastructure team<a
class="headerlink" href="#get-help-from-infrastructure-team" title="Permanent
link">¶</a></h2>
<ul>
<li>
<p>Open an <a href="https://issues.apache.org/jira/browse/INFRA";>INFRA JIRA
issue</a> to request:</p>
@@ -164,7 +175,7 @@ limitations under the License.
</ul>
</li>
</ul>
-<h2 id="use-irc-to-communicate-with-openjpa-bot-server">Use IRC to communicate
with openjpa-bot server</h2>
+<h2 id="use-irc-to-communicate-with-openjpa-bot-server">Use IRC to communicate
with openjpa-bot server<a class="headerlink"
href="#use-irc-to-communicate-with-openjpa-bot-server" title="Permanent
link">¶</a></h2>
<ul>
<li>
<p>From a browser or an IRC application, join the #asftest channel in server
<a href="irc://irc.freenode.net">irc://irc.freenode.net</a>.</p>
@@ -183,7 +194,7 @@ limitations under the License.
<p>On most irc clients this will open a direct dialog with the openjpa-bot
member and you can use the commands outlined below</p>
</li>
</ul>
-<h3 id="get-help">Get Help</h3>
+<h3 id="get-help">Get Help<a class="headerlink" href="#get-help"
title="Permanent link">¶</a></h3>
<div class="codehilite"><pre><span class="n">Enter</span><span
class="o">></span> <span class="n">openjpa</span><span
class="o">-</span><span class="n">bot</span><span class="p">:</span> <span
class="n">help</span>
<span class="n">openjpa</span><span class="o">-</span><span
class="n">bot</span> <span class="n">Get</span> <span class="n">help</span>
<span class="n">on</span> <span class="n">what</span>? <span
class="p">(</span><span class="k">try</span> <span class="s">'help
<foo>'</span><span class="p">,</span> <span class="n">or</span> <span
class="s">'commands'</span> <span class="k">for</span> <span
class="n">a</span> <span class="n">command</span> <span
class="n">list</span><span class="p">)</span>
@@ -197,7 +208,7 @@ limitations under the License.
</pre></div>
-<h3 id="get-buildbot-status">Get BuildBot status</h3>
+<h3 id="get-buildbot-status">Get BuildBot status<a class="headerlink"
href="#get-buildbot-status" title="Permanent link">¶</a></h3>
<div class="codehilite"><pre><span class="n">Enter</span><span
class="o">></span> <span class="n">openjpa</span><span
class="o">-</span><span class="n">bot</span><span class="p">:</span> <span
class="n">status</span>
<span class="n">openjpa</span><span class="o">-</span><span
class="n">bot</span> <span class="n">openjpa</span><span
class="o">-</span>1<span class="p">.</span>0<span class="p">.</span><span
class="n">x</span><span class="o">-</span><span class="n">docs</span><span
class="p">:</span> <span class="n">idle</span><span class="p">,</span> <span
class="n">last</span> <span class="n">build</span> 7<span
class="n">h21m20s</span> <span class="n">ago</span><span class="p">:</span>
<span class="n">failed</span>
<span class="n">openjpa</span><span class="o">-</span><span
class="n">bot</span> <span class="n">openjpa</span><span
class="o">-</span>1<span class="p">.</span>2<span class="p">.</span><span
class="n">x</span><span class="o">-</span><span class="n">docs</span><span
class="p">:</span> <span class="n">idle</span><span class="p">,</span> <span
class="n">last</span> <span class="n">build</span> 7<span
class="n">h23m18s</span> <span class="n">ago</span><span class="p">:</span>
<span class="n">build</span> <span class="n">successful</span>
@@ -210,7 +221,7 @@ limitations under the License.
</pre></div>
-<h3 id="submit-build">Submit build</h3>
+<h3 id="submit-build">Submit build<a class="headerlink" href="#submit-build"
title="Permanent link">¶</a></h3>
<div class="codehilite"><pre><span class="n">Enter</span><span
class="o">></span> <span class="n">openjpa</span><span
class="o">-</span><span class="n">bot</span><span class="p">:</span> <span
class="n">force</span> <span class="n">build</span> <span
class="n">openjpa</span><span class="o">-</span>1<span class="p">.</span>0<span
class="p">.</span><span class="n">x</span><span class="o">-</span><span
class="n">docs</span> "<span class="n">a</span> <span
class="n">description</span> <span class="n">here</span><span
class="p">.....</span>"
<span class="n">openjpa</span><span class="o">-</span><span
class="n">bot</span> <span class="n">build</span> #35 <span
class="n">forced</span>
<span class="n">openjpa</span><span class="o">-</span><span
class="n">bot</span> <span class="n">I</span><span class="o">'</span><span
class="n">ll</span> <span class="n">give</span> <span class="n">a</span> <span
class="n">shout</span> <span class="n">when</span> <span class="n">the</span>
<span class="n">build</span> <span class="n">finishes</span>
Modified:
websites/staging/openjpa/trunk/content/building-and-running-openbooks.html
==============================================================================
--- websites/staging/openjpa/trunk/content/building-and-running-openbooks.html
(original)
+++ websites/staging/openjpa/trunk/content/building-and-running-openbooks.html
Wed Sep 30 17:03:02 2015
@@ -145,8 +145,19 @@ limitations under the License.
</td>
<td valign="top" width="100%"
style="overflow:hidden;">
<div class="wiki-content">
- <p><a
name="BuildingandRunningOpenBooks-InstructionstodownloadandrunOpenBooksDemo"></a></p>
-<h2 id="instructions-to-download-and-run-openbooks-demo">Instructions to
download and run OpenBooks Demo</h2>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a
name="BuildingandRunningOpenBooks-InstructionstodownloadandrunOpenBooksDemo"></a></p>
+<h2 id="instructions-to-download-and-run-openbooks-demo">Instructions to
download and run OpenBooks Demo<a class="headerlink"
href="#instructions-to-download-and-run-openbooks-demo" title="Permanent
link">¶</a></h2>
<p>OpenBooks comes with</p>
<ul>
<li>complete source code</li>
@@ -155,7 +166,7 @@ limitations under the License.
</ul>
<p>Follow the simple instructions below to build and run OpenBooks:</p>
<p><a name="BuildingandRunningOpenBooks-DownloadInstructions"></a></p>
-<h2 id="download-instructions">Download Instructions</h2>
+<h2 id="download-instructions">Download Instructions<a class="headerlink"
href="#download-instructions" title="Permanent link">¶</a></h2>
<p>OpenBooks can be checked out from OpenJPA repository.</p>
<p><em>$ svn co</em> <a
href="https://svn.apache.org/repos/asf/openjpa/trunk/openjpa-examples/openbooks";>https://svn.apache.org/repos/asf/openjpa/trunk/openjpa-examples/openbooks</a>.</p>
<p>will check out the source code and build scripts of OpenBooks in current
@@ -168,7 +179,7 @@ directory.</p>
<li>Any JDBC complaint database supported by OpenJPA (embedded Derby is the
default).</li>
</ul>
<p><a
name="BuildingandRunningOpenBooks-Configurebuildandrunenvironment"></a></p>
-<h2 id="configure-build-and-run-environment">Configure build and run
environment</h2>
+<h2 id="configure-build-and-run-environment">Configure build and run
environment<a class="headerlink" href="#configure-build-and-run-environment"
title="Permanent link">¶</a></h2>
<p>OpenBooks builds with Ant. The Ant build script is somewhat involved
because OpenBooks can be built and packaged either as a JSE (Swing based)
application or a JEE Web Application. By default, OpenBooks is built as a
@@ -237,7 +248,7 @@ for application servers can be found in
<p>Both <em>build.properties</em> and <em>run.properties</em> files are
commented
in-place on what is to be edited.</p>
<p><a name="BuildingandRunningOpenBooks-BuildOpenBooksfromsource"></a></p>
-<h2 id="build-openbooks-from-source">Build OpenBooks from source</h2>
+<h2 id="build-openbooks-from-source">Build OpenBooks from source<a
class="headerlink" href="#build-openbooks-from-source" title="Permanent
link">¶</a></h2>
<p>Once you have configured the environment, simply issue (from the
<em>openjpa-examples/openbooks</em> directory):</p>
<p><em>$ ant</em></p>
@@ -252,7 +263,7 @@ in-place on what is to be edited.</p>
<li>copy the deployable artifacts to <em>target</em> and
<em>target/openbooks</em> directories relative to the current directory.</li>
</ul>
<p><a
name="BuildingandRunningOpenBooks-DeployOpenBooksinanApplicationServer"></a></p>
-<h2 id="deploy-openbooks-in-an-application-server">Deploy OpenBooks in an
Application Server</h2>
+<h2 id="deploy-openbooks-in-an-application-server">Deploy OpenBooks in an
Application Server<a class="headerlink"
href="#deploy-openbooks-in-an-application-server" title="Permanent
link">¶</a></h2>
<p>Deployment techniques and configuration vary across JEE compliant
application servers. Hence, OpenBooks does not provide an uber-deployment
script for all application server. Instead, application server specific
@@ -260,7 +271,7 @@ steps are encoded in separate build scri
Using generic build as described in the previous section, the
<em>target/openbooks.war</em> web archive needs to be deployed manually.</p>
<p><a name="BuildingandRunningOpenBooks-WebSphereApplicationServer"></a></p>
-<h3 id="websphere-application-server">WebSphere Application Server</h3>
+<h3 id="websphere-application-server">WebSphere Application Server<a
class="headerlink" href="#websphere-application-server" title="Permanent
link">¶</a></h3>
<p>For WebSphere Application Server, automated build scripts are available in
<em>build.jee.was.xml</em>. WebSphere deployment needs to be triggered by
<em>ws_ant</em> utility as follows</p>
@@ -277,17 +288,16 @@ deploying OpenBooks as a web application
server instance. If multiple profiles exist, the script will use the first
server profile.</p>
<p><a
name="BuildingandRunningOpenBooks-LibertyProfileinWebSphereApplicationServerv8.5"></a></p>
-<h3 id="liberty-profile-in-websphere-application-server-v85">Liberty Profile
in WebSphere Application Server v8.5</h3>
+<h3 id="liberty-profile-in-websphere-application-server-v85">Liberty Profile
in WebSphere Application Server v8.5<a class="headerlink"
href="#liberty-profile-in-websphere-application-server-v85" title="Permanent
link">¶</a></h3>
<p>For the Liberty Profile in WebSphere Application Server v8.5, automated
build scripts are available in <em>build.jee.liberty.xml</em>. Liberty Profile
deployment is very easy and needs to be triggered by <em>ant</em> as
follows</p>
<p><em>$ ant -Dbuild.mode=jee -Dappserver=liberty
-Dliberty.home=<WAS_HOME>/wlp -Dliberty.server=<server name></em></p>
-<p>where \<WAS_HOME> denotes the root directory where WAS v8.5 has been
+<p>where \<WAS_HOME\> denotes the root directory where WAS v8.5 has been
installed, and <server name> is the name of your Liberty Profile server.
Instead of specifying these two variables, <em>liberty.home</em> and
<em>liberty.server</em>, you could modify the build variables in the
-<em>build.jee.liberty.xml</em> file.<br />
-</p>
+<em>build.jee.liberty.xml</em> file. </p>
<p>By specifying <em>liberty.home</em> and <em>liberty.server</em>, the ant
script will
attempt to "deploy" the resulting openbooks.war application to the
designated Liberty server. Additional configuration of your Liberty server
@@ -299,7 +309,7 @@ can be found in the <em>openbooks/script
<p>Additional information on the Liberty Profile can be found <a
href="http://www.wasdev.net/";>here</a>
. General WebSphere information can be found <a
href="http://www-01.ibm.com/software/websphere/";>here</a>.</p>
<p><a name="BuildingandRunningOpenBooks-RunOpenBooks"></a></p>
-<h2 id="run-openbooks">Run OpenBooks</h2>
+<h2 id="run-openbooks">Run OpenBooks<a class="headerlink"
href="#run-openbooks" title="Permanent link">¶</a></h2>
<p>If you have built OpenBooks for JSE, then go to the
<em>openjpa-examples/openbooks/target/openbooks</em> directory.</p>
<p>Invoke the Ant script to run OpenBooks</p>
@@ -313,7 +323,7 @@ Server. Once deployed, you can point a b
<p><a
href="http://localhost:9080/openbooks/";>http://localhost:9080/openbooks/</a></p>
<p>to access OpenBooks as a web application.</p>
<p><a name="BuildingandRunningOpenBooks-PopulateOpenBooksDatabase"></a></p>
-<h2 id="populate-openbooks-database">Populate OpenBooks Database</h2>
+<h2 id="populate-openbooks-database">Populate OpenBooks Database<a
class="headerlink" href="#populate-openbooks-database" title="Permanent
link">¶</a></h2>
<p>OpenBooks checks for existing data at first connection to the database. If
the database is empty, the schema is defined and populated with initial
data. However, you can explicitly populate the database in JSE build.</p>
Modified: websites/staging/openjpa/trunk/content/building.html
==============================================================================
--- websites/staging/openjpa/trunk/content/building.html (original)
+++ websites/staging/openjpa/trunk/content/building.html Wed Sep 30 17:03:02
2015
@@ -145,9 +145,20 @@ limitations under the License.
</td>
<td valign="top" width="100%"
style="overflow:hidden;">
<div class="wiki-content">
- <p><a name="Building"></a></p>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><a name="Building"></a></p>
<p><a name="Building-Contents"></a></p>
-<h1 id="contents">Contents</h1>
+<h1 id="contents">Contents<a class="headerlink" href="#contents"
title="Permanent link">¶</a></h1>
<ul>
<li>
<p><a href="#Building-BuildingOpenJPA">Building OpenJPA</a></p>
@@ -186,13 +197,13 @@ limitations under the License.
</li>
</ul>
<p><a name="Building-BuildingOpenJPA"></a></p>
-<h1 id="building-openjpa">Building OpenJPA</h1>
+<h1 id="building-openjpa">Building OpenJPA<a class="headerlink"
href="#building-openjpa" title="Permanent link">¶</a></h1>
<p>See <a href="build-and-runtime-dependencies.html">Build and Runtime
Dependencies</a>
for details on the required Java levels.</p>
<p><a name="Building-Maven"></a></p>
-<h2 id="maven">Maven</h2>
+<h2 id="maven">Maven<a class="headerlink" href="#maven" title="Permanent
link">¶</a></h2>
<p><a name="Building-CommandLineBuilds"></a></p>
-<h3 id="command-line-builds">Command Line Builds</h3>
+<h3 id="command-line-builds">Command Line Builds<a class="headerlink"
href="#command-line-builds" title="Permanent link">¶</a></h3>
<p>These instructions describe how to check out the current OpenJPA source
code (from the Subversion source code management repository) and build it
(using the Apache Maven 2 build tool). They are written for use from the
@@ -222,14 +233,12 @@ checking out the OpenJPA sources can be
page.</li>
<li>Change to the openjpa-trunk directory, which has already been created in
the previous step.</li>
-<li>
-<p>Build OpenJPA by running: <code>mvn package</code> or better <code>mvn
install</code>. The
+<li>Build OpenJPA by running: <code>mvn package</code> or better <code>mvn
install</code>. The
first time you run the build, many dependencies are automatically resolved
and downloaded. <strong>It is common for dependency downloading to fail the
first
time, which will fail the build.</strong> If any of these dependency downloads
fail, just re-run the command. You may also add the following to your
-<code>~/.m2/setting.xml</code> file (see <a
href="http://maven.apache.org/guides/mini/guide-mirror-settings.html";>http://maven.apache.org/guides/mini/guide-mirror-settings.html</a>)</p>
-<div class="codehilite"><pre><span class="nt"><settings></span>
+<code>~/.m2/setting.xml</code> file (see <a
href="http://maven.apache.org/guides/mini/guide-mirror-settings.html";>http://maven.apache.org/guides/mini/guide-mirror-settings.html</a>)<div
class="codehilite"><pre><span class="nt"><settings></span>
<span class="nt"><mirrors></span>
<span class="nt"><mirror></span>
<span class="nt"><id></span>repo.mergere.com<span
class="nt"></id></span>
@@ -386,27 +395,27 @@ $ <span class="n">ls</span> <span class=
<p><a name="Building-ExecutingvariousMavenbuildtasks"></a></p>
-<h3 id="executing-various-maven-build-tasks">Executing various Maven build
tasks</h3>
+<h3 id="executing-various-maven-build-tasks">Executing various Maven build
tasks<a class="headerlink" href="#executing-various-maven-build-tasks"
title="Permanent link">¶</a></h3>
<p><a name="Building-RunningjusttheTestPersistencetestcase"></a></p>
-<h5 id="running-just-the-testpersistence-test-case">Running just the
"TestPersistence" test case</h5>
+<h5 id="running-just-the-testpersistence-test-case">Running just the
"TestPersistence" test case<a class="headerlink"
href="#running-just-the-testpersistence-test-case" title="Permanent
link">¶</a></h5>
<div class="codehilite"><pre><span class="n">mvn</span> <span
class="n">test</span> <span class="o">-</span><span class="n">Dtest</span><span
class="p">=</span><span class="n">TestPersistence</span>
</pre></div>
<p><a name="Building-RunningtestswithJava2securityenabled"></a></p>
-<h5 id="running-tests-with-java-2-security-enabled">Running tests with Java 2
security enabled</h5>
+<h5 id="running-tests-with-java-2-security-enabled">Running tests with Java 2
security enabled<a class="headerlink"
href="#running-tests-with-java-2-security-enabled" title="Permanent
link">¶</a></h5>
<div class="codehilite"><pre><span class="n">mvn</span> <span
class="n">test</span> <span class="o">-</span><span
class="n">Penable</span><span class="o">-</span><span class="n">security</span>
</pre></div>
<p><a
name="Building-Buildingandrunningonlytheexamplesincludedinthedistribution"></a></p>
-<h5
id="building-and-running-only-the-examples-included-in-the-distribution">Building
and running only the examples included in the distribution</h5>
+<h5
id="building-and-running-only-the-examples-included-in-the-distribution">Building
and running only the examples included in the distribution<a
class="headerlink"
href="#building-and-running-only-the-examples-included-in-the-distribution"
title="Permanent link">¶</a></h5>
<div class="codehilite"><pre><span class="n">mvn</span> <span
class="o">-</span><span class="n">DskipTests</span> <span
class="o">-</span><span class="n">Pexamples</span><span class="o">-</span><span
class="n">profile</span> <span class="n">integration</span><span
class="o">-</span><span class="n">test</span>
</pre></div>
<p><a name="Building-Buildingjustthejavadoc"></a></p>
-<h5 id="building-just-the-javadoc">Building just the javadoc</h5>
+<h5 id="building-just-the-javadoc">Building just the javadoc<a
class="headerlink" href="#building-just-the-javadoc" title="Permanent
link">¶</a></h5>
<p>First install the jars:</p>
<div class="codehilite"><pre><span class="n">mvn</span> <span
class="n">install</span> <span class="o">-</span><span
class="n">DskipTests</span>
</pre></div>
@@ -419,7 +428,7 @@ $ <span class="n">ls</span> <span class=
<p>The javadoc will be output to <em>target/site/apidocs/index.html</em>.</p>
<p><a name="Building-Buildingjustthedocbookdocumentation"></a></p>
-<h5 id="building-just-the-docbook-documentation">Building just the docbook
documentation</h5>
+<h5 id="building-just-the-docbook-documentation">Building just the docbook
documentation<a class="headerlink"
href="#building-just-the-docbook-documentation" title="Permanent
link">¶</a></h5>
<div class="codehilite"><pre><span class="n">set</span> <span
class="n">MAVEN_OPTS</span><span class="p">=</span><span
class="o">-</span><span class="n">Xmx512m</span>
<span class="n">mvn</span> <span class="o">-</span><span class="n">f</span>
<span class="n">openjpa</span><span class="o">-</span><span
class="n">project</span><span class="o">/</span><span class="n">pom</span><span
class="p">.</span><span class="n">xml</span> <span
class="n">process</span><span class="o">-</span><span
class="n">resources</span> <span class="o">-</span><span
class="n">Pdocbook</span><span class="o">-</span><span class="n">profile</span>
</pre></div>
@@ -427,7 +436,7 @@ $ <span class="n">ls</span> <span class=
<p>The manual HTML will be output to
<code>openjpa-project/target/manual/manual.html</code>.</p>
<p><a
name="Building-BuildingwithJDK1.4moduleverification(onlyforversionsofOpenJPApriortosvnrevision640685)"></a></p>
-<h5
id="building-with-jdk-14-module-verification-only-for-versions-of-openjpa-prior-to-svn-revision-640685">Building
with JDK 1.4 module verification (only for versions of OpenJPA prior to svn
revision 640685)</h5>
+<h5
id="building-with-jdk-14-module-verification-only-for-versions-of-openjpa-prior-to-svn-revision-640685">Building
with JDK 1.4 module verification (only for versions of OpenJPA prior to svn
revision 640685)<a class="headerlink"
href="#building-with-jdk-14-module-verification-only-for-versions-of-openjpa-prior-to-svn-revision-640685"
title="Permanent link">¶</a></h5>
<div class="codehilite"><pre><span class="n">mvn</span> <span
class="n">compile</span> <span class="o">-</span><span
class="n">Djava14</span><span class="p">.</span><span class="n">jar</span><span
class="p">=</span><span class="n">C</span><span class="p">:</span><span
class="o">\</span><span class="n">Program</span> <span
class="n">Files</span><span class="o">\</span><span class="n">Java</span><span
class="o">\</span><span class="n">j2re1</span><span class="p">.</span>4<span
class="p">.</span>2<span class="n">_07</span><span class="o">\</span><span
class="n">lib</span><span class="o">\</span><span class="n">rt</span><span
class="p">.</span><span class="n">jar</span> <span class="n">compile</span>
</pre></div>
@@ -440,7 +449,7 @@ the module. Since the runtime jar locati
installation dependent, the exact location of the runtime jar will vary,
which is why it needs to be manually specified.</p>
<p><a name="Building-EclipsewithCommand-lineMavenutilities"></a></p>
-<h2 id="eclipse-with-command-line-maven-utilities">Eclipse with Command-line
Maven utilities</h2>
+<h2 id="eclipse-with-command-line-maven-utilities">Eclipse with Command-line
Maven utilities<a class="headerlink"
href="#eclipse-with-command-line-maven-utilities" title="Permanent
link">¶</a></h2>
<ol>
<li>Checkout the source as described above</li>
<li>Build the source using Maven as described above</li>
@@ -451,9 +460,7 @@ which is why it needs to be manually spe
<ol>
-<li>
-<p>If this is the first project in your workspace to use maven artifacts you
need to create a classpath variable named M2_REPO which contains the full path
to your local repository. The eclipse plugin can do this for you with the
following command</p>
-<div class="codehilite"><pre>mvn eclipse:configure-workspace
-Declipse.workspace=<span class="cp">${</span><span class="n">path</span> <span
class="n">to</span> <span class="n">your</span> <span
class="n">workspace</span><span class="cp">}</span>
+<li>If this is the first project in your workspace to use maven artifacts you
need to create a classpath variable named M2_REPO which contains the full path
to your local repository. The eclipse plugin can do this for you with the
following command<div class="codehilite"><pre>mvn eclipse:configure-workspace
-Declipse.workspace=<span class="cp">${</span><span class="n">path</span> <span
class="n">to</span> <span class="n">your</span> <span
class="n">workspace</span><span class="cp">}</span>
</pre></div>
@@ -528,10 +535,8 @@ for the source:</p>
<ol>
<li>Open the Properties for openjpa-persistence</li>
<li>Select Java Build Path --> Source</li>
-<li>
-<p>Edit the openjpa-persistence/src/main/java --> Excluded setting to
-include the following:</p>
-<div class="codehilite"><pre><span class="n">org</span><span
class="o">/</span><span class="n">apache</span><span class="o">/</span><span
class="n">openjpa</span><span class="o">/</span><span
class="n">persistence</span><span class="o">/</span><span
class="n">meta</span><span class="o">/</span><span
class="n">AnnotationProcessor6</span><span class="p">.</span><span
class="n">java</span>
+<li>Edit the openjpa-persistence/src/main/java --> Excluded setting to
+include the following:<div class="codehilite"><pre><span
class="n">org</span><span class="o">/</span><span class="n">apache</span><span
class="o">/</span><span class="n">openjpa</span><span class="o">/</span><span
class="n">persistence</span><span class="o">/</span><span
class="n">meta</span><span class="o">/</span><span
class="n">AnnotationProcessor6</span><span class="p">.</span><span
class="n">java</span>
<span class="n">org</span><span class="o">/</span><span
class="n">apache</span><span class="o">/</span><span
class="n">openjpa</span><span class="o">/</span><span
class="n">persistence</span><span class="o">/</span><span
class="n">meta</span><span class="o">/</span><span
class="n">CompileTimeLogger</span><span class="p">.</span><span
class="n">java</span>
<span class="n">org</span><span class="o">/</span><span
class="n">apache</span><span class="o">/</span><span
class="n">openjpa</span><span class="o">/</span><span
class="n">persistence</span><span class="o">/</span><span
class="n">meta</span><span class="o">/</span><span
class="n">SourceAnnotationHandler</span><span class="p">.</span><span
class="n">java</span>
</pre></div>
@@ -540,7 +545,7 @@ include the following:</p>
</li>
</ol>
<p><a name="Building-EclipsewithM2Eclipseplugin"></a></p>
-<h2 id="eclipse-with-m2eclipse-plugin">Eclipse with M2Eclipse plugin</h2>
+<h2 id="eclipse-with-m2eclipse-plugin">Eclipse with M2Eclipse plugin<a
class="headerlink" href="#eclipse-with-m2eclipse-plugin" title="Permanent
link">¶</a></h2>
<ol>
<li>Checkout the source as described above</li>
<li>Build the source using Maven as described above</li>
@@ -610,10 +615,8 @@ for the source:</p>
<li>Open the Properties for BR20-openjpa-persistence (or whatever your naming
convention is)</li>
<li>Select Java Build Path --> Source</li>
-<li>
-<p>Edit the openjpa-persistence/src/main/java --> Excluded setting to
-include the following:</p>
-<div class="codehilite"><pre><span class="n">org</span><span
class="o">/</span><span class="n">apache</span><span class="o">/</span><span
class="n">openjpa</span><span class="o">/</span><span
class="n">persistence</span><span class="o">/</span><span
class="n">meta</span><span class="o">/</span><span
class="n">AnnotationProcessor6</span><span class="p">.</span><span
class="n">java</span>
+<li>Edit the openjpa-persistence/src/main/java --> Excluded setting to
+include the following:<div class="codehilite"><pre><span
class="n">org</span><span class="o">/</span><span class="n">apache</span><span
class="o">/</span><span class="n">openjpa</span><span class="o">/</span><span
class="n">persistence</span><span class="o">/</span><span
class="n">meta</span><span class="o">/</span><span
class="n">AnnotationProcessor6</span><span class="p">.</span><span
class="n">java</span>
<span class="n">org</span><span class="o">/</span><span
class="n">apache</span><span class="o">/</span><span
class="n">openjpa</span><span class="o">/</span><span
class="n">persistence</span><span class="o">/</span><span
class="n">meta</span><span class="o">/</span><span
class="n">CompileTimeLogger</span><span class="p">.</span><span
class="n">java</span>
<span class="n">org</span><span class="o">/</span><span
class="n">apache</span><span class="o">/</span><span
class="n">openjpa</span><span class="o">/</span><span
class="n">persistence</span><span class="o">/</span><span
class="n">meta</span><span class="o">/</span><span
class="n">SourceAnnotationHandler</span><span class="p">.</span><span
class="n">java</span>
</pre></div>
@@ -622,9 +625,9 @@ include the following:</p>
</li>
</ol>
<p><a name="Building-Common2.xBuildProblems"></a></p>
-<h2 id="common-2x-build-problems">Common 2.x Build Problems</h2>
+<h2 id="common-2x-build-problems">Common 2.x Build Problems<a
class="headerlink" href="#common-2x-build-problems" title="Permanent
link">¶</a></h2>
<p><a name="Building-CheckstyleFailure"></a></p>
-<h3 id="checkstyle-failure-due-to-systemoutprint-or-systemerrprint">Checkstyle
failure due to System.out.print or System.err.print</h3>
+<h3 id="checkstyle-failure-due-to-systemoutprint-or-systemerrprint">Checkstyle
failure due to System.out.print or System.err.print<a class="headerlink"
href="#checkstyle-failure-due-to-systemoutprint-or-systemerrprint"
title="Permanent link">¶</a></h3>
<p>Changes were added to build so that the build will fail if there are any
calls to System.out/err.print(ln).
This was done to force people to use the proper logging facilities. If there
is an honest reason that
you need to have System.out/err.print in your code, you can use the following
comments to turn the
@@ -636,7 +639,7 @@ checkstyle scanner off, then back on aga
<p><a name="Building-WrongMavenLevel"></a></p>
-<h3 id="wrong-maven-level">Wrong Maven Level</h3>
+<h3 id="wrong-maven-level">Wrong Maven Level<a class="headerlink"
href="#wrong-maven-level" title="Permanent link">¶</a></h3>
<p>Example Maven output -</p>
<div class="codehilite"><pre><span class="k">[INFO] [enforcer:enforce
{execution: default}]</span>
<span class="err">[WARNING]</span> <span class="err">Rule</span> <span
class="err">0:</span> <span
class="err">org.apache.maven.plugins.enforcer.RequireMavenVersion</span> <span
class="err">failed</span> <span class="err">with</span> <span
class="err">message:</span>
@@ -650,7 +653,7 @@ checkstyle scanner off, then back on aga
<p>Solution - Upgrade to Maven 2.2.1 or later</p>
<p><a name="Building-WrongJavaLevel"></a></p>
-<h3 id="wrong-java-level">Wrong Java Level</h3>
+<h3 id="wrong-java-level">Wrong Java Level<a class="headerlink"
href="#wrong-java-level" title="Permanent link">¶</a></h3>
<p>Example Maven output -</p>
<div class="codehilite"><pre><span class="k">[INFO] [enforcer:enforce
{execution: default}]</span>
<span class="err">[WARNING]</span> <span class="err">Rule</span> <span
class="err">1:</span> <span
class="err">org.apache.maven.plugins.enforcer.RequireJavaVersion</span> <span
class="err">failed</span> <span class="err">with</span> <span
class="err">message:</span>
@@ -665,7 +668,7 @@ checkstyle scanner off, then back on aga
<p>Solution - Upgrade to latest Sun JDK 1.6.0 or IBM 6 SDK</p>
<p>Note - OpenJDK and Java SE 7 are not supported at this time.</p>
<p><a name="Building-MissingLicenseHeaders"></a></p>
-<h3 id="missing-license-headers">Missing License Headers</h3>
+<h3 id="missing-license-headers">Missing License Headers<a class="headerlink"
href="#missing-license-headers" title="Permanent link">¶</a></h3>
<p>Example Maven output -</p>
<div class="codehilite"><pre><span class="p">.</span> <span class="p">.</span>
<span class="p">.</span>
<span class="p">[</span><span class="n">INFO</span><span class="p">]</span>
<span
class="o">------------------------------------------------------------------------</span>
