Apache
/
openjpa
mirror of https://github.com/apache/openjpa.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update instructions to build 

git-svn-id: https://svn.apache.org/repos/asf/openjpa/trunk@945900 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Pinaki Poddar 2010-05-18 21:34:31 +00:00
parent 8af9ff0aaf
commit fc3f2dc536
1 changed files with 58 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

85
openjpa-examples/openbooks/index.html
View File

@ -19,19 +19,49 @@ under the License.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html> <html>
<head>
<meta name="keywords" content="JPA, OpenJPA, OpenBooks, Sample, Criteria, MetaModel">
<style type="text/css">
body {
background-color:#FFFFFF;
}
h1 {
color:black;
text-align:center;
}
h2 {
color:blue;
text-align:left;
}
p{
font-family:"Times New Roman";
font-size:20px;
}
</style>
</head>
<body> <body>
<h1>OpenBooks: A sample JPA 2.0 Application</h1> <h1>OpenBooks: A sample JPA 2.0 Application</h1>
<hr> <hr>
OpenBooks is a sample (and perhaps simple) application to demonstrate some of the new features of OpenBooks is a sample (and perhaps simple) application to demonstrate some of the new features of
version 2.0 of <A HREF="http://jcp.org/en/jsr/detail?id=317">Java Persistence API</A> (JPA) specification. version 2.0 of <A HREF="http://jcp.org/en/jsr/detail?id=317">Java Persistence API</A> (JPA) specification, such as
<br> <br>
<LI>Creating dynamic Criteria Query from an input form
<LI>Using compound, derived identity and orphan delete for modeling composite relationship
<LI>Browsing Persistent Domain Model via MetaModel API
<br>
OpenBooks runs with <A HREF="http://openjpa.apache.org">OpenJPA</A> as its JPA provider. OpenBooks runs with <A HREF="http://openjpa.apache.org">OpenJPA</A> as its JPA provider.
<hr> <hr>
<h1>Instructions to run OpenBooks Demo</h1> <h2>Instructions to download and run OpenBooks Demo</h2>
OpenBooks comes with complete source code, build scripts to demonstrate how to build a typical OpenJPA application
and scripts to run OpenBooks in on your local database installation. Follow the simple instructions below:
<OL> <OL>
<LI><A href="#Download">Download OpenBooks distribution</A>. <LI><A href="#Download">Download OpenBooks distribution</A>.
<LI><A href="#Install">Install OpenBooks distribution</A> <LI><A href="#Build">Build OpenBooks from source</A>
<LI><A href="#Configure">Edit for your local environment</A> <LI><A href="#Configure">Edit for your local environment to run</A>
<LI><A href="#Load">Populate a Database</A> <LI><A href="#Load">Populate a Database</A>
<LI><A href="#Run">Run OpenBooks</A> <LI><A href="#Run">Run OpenBooks</A>
</OL> </OL>
@ -39,8 +69,12 @@ under the License.
<h2 A name="Download">Download Instructions</A></h2> <h2 A name="Download">Download Instructions</A></h2>
OpenBooks is distributed under <A HREF="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</A> OpenBooks is distributed under <A HREF="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</A>
<br> <br>
OpenBooks can be downloaded from <A HREF="openbooks.zip">here</A>. OpenBooks can be checked out from OpenJPA repository.
<br>
<code>$ svn co https://svn.apache.org/repos/asf/openjpa/trunk/openjpa-examples/openbooks</code>.
<p> <p>
will check out the source code and build scripts of OpenBooks in current directory.
OpenBooks require following software environment to run: OpenBooks require following software environment to run:
<OL> <OL>
<LI> Java Runtime version 6.0 or higher <LI> Java Runtime version 6.0 or higher
@ -49,30 +83,26 @@ under the License.
<LI> Any JDBC complaint database supported by OpenJPA. <LI> Any JDBC complaint database supported by OpenJPA.
See <A href="http://openjpa.apache.org/builds/latest/docs/manual/manual.html#ref_guide_dbsetup_dbsupport">OpenJPA documentation</A> for a list of supported databases. See <A href="http://openjpa.apache.org/builds/latest/docs/manual/manual.html#ref_guide_dbsetup_dbsupport">OpenJPA documentation</A> for a list of supported databases.
</OL> </OL>
<h2><A name="Install">Install OpenBooks distribution</A></h2>
Unzip <code>openbooks.zip</code> to a directory. Following instructions assume this directory as
your current directory.<br>
The files included in this distribution are:
<LI>index.html : the file you are reading
<LI>openbooks.jar : OpenBooks class library
<LI>run.xml : Ant script to run OpenBooks
<LI>run.properties : The configuration for your execution environment used by Ant script
<LI>load.properties : The configuration for loading initial data into OpenBooks.
<LI>demo.properties: Properties to configure the demonstation GUI.
<LI>META-INF/persistence.xml: The configuration for OpenJPA runtime
<LI>slides/: Directory containing the default presentation accompanying this demonstration.
<LI>source/: Directory containing the source code for OpenBooks
<LI>LICENSE.txt: Apache License
<LI>NOTICE.txt: Copyright Notice
<br>
<p>
<hr> <hr>
<h2><A name="Configure">Configure OpenBooks for your local environment</A></h2>
<h2><A name="Build">Build OpenBooks from source</h2>
OpenBooks builds with Ant. Before you run a build, configure the build environment by editing
<A HREF="build.properties"><code>build.properties</code></A>. Essentially you need to point to OpenJPA class library.
The file is commented on what is to be edited. Once you have edited <code>build.properties</code>, simply issue
<br>
<code>$ ant package deploy</code>
<br>
This will compile the source code, generate metamodel classes, enhance the persistence domain model, package
the application and copy it to a <code>target/openbooks</code> directory.
<hr>
<h2><A name="Configure">Edit for your local environment to run</A></h2>
Now go to the <em>deploy</em> directory i.e. <code>target/openbooks</code> directory
<OL> <OL>
<LI>Edit <code>run.properties</code> to specify location of OpenJPA class libraries and JDBC Driver <LI>Edit <A HREF="run.properties"><code>run.properties</code></A> to specify location of OpenJPA class libraries and JDBC Driver
<LI>Edit <code>META-INF/persistence.xml</code> to specify database properties <LI>Edit <A HREF="META-INF/persistence.xml"><code>META-INF/persistence.xml</code></A> to specify database properties
<LI>Edit <code>load.properties</code> to specify load parameters such as number of Books etc. <LI>Edit <A HREF="load.properties"><code>load.properties</code></A> to specify load parameters such as number of Books etc.
This example file has some typical values. If you are satisfied with it, you can leave them as it is. This example file has some typical values. If you are satisfied with it, you can leave them as it is.
</OL> </OL>
<hr> <hr>
@ -80,6 +110,7 @@ under the License.
Invoke the Ant script to populate the database.<br> Invoke the Ant script to populate the database.<br>
<code>$ ant -f run.xml load</code> <code>$ ant -f run.xml load</code>
<hr> <hr>
<h2><A name="Run">Run OpenBooks</A></h2> <h2><A name="Run">Run OpenBooks</A></h2>
Invoke the Ant script to run OpenBooks<br> Invoke the Ant script to run OpenBooks<br>
<code>$ ant -f run.xml run</code> <code>$ ant -f run.xml run</code>