db-jdo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From an...@apache.org
Subject svn commit: r581668 - in /db/jdo/site: docs/metadata.html xdocs/metadata.xml
Date Wed, 03 Oct 2007 17:38:53 GMT
Author: andyj
Date: Wed Oct  3 10:38:52 2007
New Revision: 581668

URL: http://svn.apache.org/viewvc?rev=581668&view=rev
Log:
JDO-537 Add JDO file locations text. Add JDO-ORM XML split 

Modified:
    db/jdo/site/docs/metadata.html
    db/jdo/site/xdocs/metadata.xml

Modified: db/jdo/site/docs/metadata.html
URL: http://svn.apache.org/viewvc/db/jdo/site/docs/metadata.html?rev=581668&r1=581667&r2=581668&view=diff
==============================================================================
--- db/jdo/site/docs/metadata.html (original)
+++ db/jdo/site/docs/metadata.html Wed Oct  3 10:38:52 2007
@@ -4,6 +4,40 @@
 			    @import url("./style/maven-theme.css");</style><link rel="stylesheet" href="./style/print.css"
type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html;
charset=ISO-8859-1"></meta></head><body class="composite"><div id="banner"><a
href="http://db.apache.org/jdo" id="projectLogo"><img alt="Java Data Objects (JDO)"
src="./images/JDOx120.gif"></img></a><div class="clear"><hr></hr></div></div><div
id="breadcrumbs"><div class="xright"></div><div class="clear"><hr></hr></div></div><div
id="leftColumn"><div id="navcolumn"><div id="menuGeneral"><h5>General</h5><ul><li
class="none"><a href="index.html">Home</a></li><li class="none"><a
href="why_jdo.html">Why JDO?</a></li><li class="none"><a href="jdo_v_jpa.html">JDO
v JPA</a></li><li class="none"><a href="jdo_v_jpa_orm.html">JDO v
JPA : ORM</a></li><li class="none"><a href="downloads.html">Downloads</a></li><li
class="none"><a href="http://www.apache.org/licenses/LICENSE-2.0" class="externalLink"
  title="External Link">License</a></li></ul></div><br></br><div
id="menuJDO_Implementation"><h5>JDO Implementation</h5><ul><li class="none"><a
href="specifications.html">Specifications</a></li><li class="none"><a
href="tck.html">TCK</a></li></ul></div><br></br><div
id="menuJDO_Usage"><h5>JDO Usage</h5><ul><li class="none"><a
href="impls.html">Implementations</a></li><li class="none"><a href="javadoc.html">API
Javadoc</a></li><li class="none"><a href="class_types.html">Types
of Classes</a></li><li class="none"><a href="extents.html">Extents</a></li><li
class="none"><a href="enhancement.html">Bytecode Enhancement</a></li><li
class="none"><a href="jdohelper.html">JDOHelper</a></li><li class="none"><a
href="exceptions.html">Exceptions</a></li><li class="expanded"><strong><a
href="metadata.html">MetaData</a></strong><ul><li class="none"><a
href="jdo_dtd.html">jdo DTD/XSD</a></li><li class="none"><a href="orm_dtd.html">orm
DTD/XSD</a></li><li class="none"><a href="jdoquery_dtd.htm
 l">jdoquery DTD/XSD</a></li></ul></li><li class="none"><a
href="state_transition.html">Object States</a></li><li class="collapsed"><a
href="guides.html">Guides</a></li><li class="none"><a href="references.html">References</a></li><li
class="none"><a href="glossary.html">Glossary</a></li></ul></div><br></br><div
id="menuCommunity"><h5>Community</h5><ul><li class="none"><a
href="get-involved.html">Get Involved</a></li><li class="none"><a
href="team-list.html">Project Team</a></li><li class="none"><a href="mail-lists.html">Mailing
Lists</a></li><li class="none"><a href="faq.html">FAQ</a></li><li
class="none"><a href="http://wiki.apache.org/jdo" class="externalLink" title="External
Link">Wiki</a></li></ul></div><br></br><div id="menuDevelopment"><h5>Development</h5><ul><li
class="none"><a href="roadmap.html">RoadMap / TODO</a></li><li class="none"><a
href="svn.html">Source Code</a></li><li class="none"><a href="http://cwiki.apache.org/GMOxDEV/coding-standards.html"
class="extern
 alLink" title="External Link">Coding Standards</a></li><li class="none"><a
href="issuetracking.html">Issue Tracking</a></li><li class="none"><a
href="dependencies.html">Dependencies</a></li></ul></div><br></br></div></div><div
id="bodyColumn"><div class="contentBox"><div class="section"><a name="Persistence_MetaData"></a><h2>Persistence
MetaData</h2><p>
                 JDO 1.0 and JDO 2.0 support specification of persistence using XML MetaData.
                 JDO 2.1 adds on the ability to specify persistence using Java5 annotations.
-            </p></div></div></div><div class="clear"><hr></hr></div><table
border="0" width="100%" cellpadding="0" cellspacing="0"><tr><td width="100%"><img
height="1" border="0" width="100%" src="./images/header_line.gif"></img></td></tr></table><div
id="footer"><div class="xleft">
+            </p><div class="subsection"><a name="XML_MetaData"></a><h3>XML
MetaData</h3><p>
+                    JDO (1.0.1, 2.0, 2.1) expects any XML MetaData to be specified in a file
or files 
+                    in particular positions in the file system. For example, if you have
a class 
+                    <i>com.mycompany.sample.MyExample</i>, JDO will look for
any of the following files 
+                    until it finds one (in the order stated) :-
+                </p>
+    <div class="source"><pre>
+META-INF/package.jdo
+WEB-INF/package.jdo
+package.jdo
+com/package.jdo
+com/mycompany/package.jdo
+com/mycompany/sample/package.jdo
+com/mycompany/sample/MyExample.jdo</pre></div>
+  <p>
+                    In addition to specifying XML MetaData in a <b>jdo</b> file,
if defining O/R mapping
+                    information you can also split this out into an ORM file. The locations
for ORM files
+                    are similar in nature to those for JDO files.
+                </p>
+    <div class="source"><pre>
+META-INF/package-{mapping}.orm
+WEB-INF/package-{mapping}.orm
+package-{mapping}.orm
+com/package-{mapping}.orm
+com/mycompany/package-{mapping}.orm
+com/mycompany/sample/package-{mapping}.orm
+com/mycompany/sample/MyExample-{mapping}.orm</pre></div>
+  <p>
+                    where <i>{mapping}</i> is a property specified by the user
and may be "mysql" for
+                    ORM information for MySQL datastores, and "oracle" for ORM information
for Oracle
+                    datastores, and so on.
+                </p><br></br></div><div class="subsection"><a
name="Annotations"></a><h3>Annotations</h3><p>
+                    JDO 2.1 provides support for annotations. Classes and fields/properties
can be annotated
+                    defining the persistence and, optionally, any ORM information.
+                </p></div></div></div></div><div class="clear"><hr></hr></div><table
border="0" width="100%" cellpadding="0" cellspacing="0"><tr><td width="100%"><img
height="1" border="0" width="100%" src="./images/header_line.gif"></img></td></tr></table><div
id="footer"><div class="xleft">
                 Documentation published: 03 October 2007<br></br>
                   © 2005-2007 <a href="http://www.apache.org/">Apache Software Foundation</a></div></div></body></html>

Modified: db/jdo/site/xdocs/metadata.xml
URL: http://svn.apache.org/viewvc/db/jdo/site/xdocs/metadata.xml?rev=581668&r1=581667&r2=581668&view=diff
==============================================================================
--- db/jdo/site/xdocs/metadata.xml (original)
+++ db/jdo/site/xdocs/metadata.xml Wed Oct  3 10:38:52 2007
@@ -9,6 +9,48 @@
                 JDO 1.0 and JDO 2.0 support specification of persistence using XML MetaData.
                 JDO 2.1 adds on the ability to specify persistence using Java5 annotations.
             </p>
+            <subsection name="XML MetaData">
+                <p>
+                    JDO (1.0.1, 2.0, 2.1) expects any XML MetaData to be specified in a file
or files 
+                    in particular positions in the file system. For example, if you have
a class 
+                    <i>com.mycompany.sample.MyExample</i>, JDO will look for
any of the following files 
+                    until it finds one (in the order stated) :-
+                </p>
+                <source>
+META-INF/package.jdo
+WEB-INF/package.jdo
+package.jdo
+com/package.jdo
+com/mycompany/package.jdo
+com/mycompany/sample/package.jdo
+com/mycompany/sample/MyExample.jdo</source>
+                <p>
+                    In addition to specifying XML MetaData in a <b>jdo</b> file,
if defining O/R mapping
+                    information you can also split this out into an ORM file. The locations
for ORM files
+                    are similar in nature to those for JDO files.
+                </p>
+                <source>
+META-INF/package-{mapping}.orm
+WEB-INF/package-{mapping}.orm
+package-{mapping}.orm
+com/package-{mapping}.orm
+com/mycompany/package-{mapping}.orm
+com/mycompany/sample/package-{mapping}.orm
+com/mycompany/sample/MyExample-{mapping}.orm</source>
+                <p>
+                    where <i>{mapping}</i> is a property specified by the user
and may be "mysql" for
+                    ORM information for MySQL datastores, and "oracle" for ORM information
for Oracle
+                    datastores, and so on.
+                </p>
+                <br/>
+            </subsection>
+
+            <subsection name="Annotations">
+                <p>
+                    JDO 2.1 provides support for annotations. Classes and fields/properties
can be annotated
+                    defining the persistence and, optionally, any ORM information.
+                </p>
+            </subsection>
         </section>
     </body>
 </document>



Mime
View raw message