Author: andyj
Date: Wed Oct 3 10:29:53 2007
New Revision: 581665
URL: http://svn.apache.org/viewvc?rev=581665&view=rev
Log:
JDO-537 Add subsections to better separate. Add javadoc icon
Added:
db/jdo/site/docs/images/javadoc.gif (with props)
Modified:
db/jdo/site/docs/jdohelper.html
db/jdo/site/xdocs/jdohelper.xml
Added: db/jdo/site/docs/images/javadoc.gif
URL: http://svn.apache.org/viewvc/db/jdo/site/docs/images/javadoc.gif?rev=581665&view=auto
==============================================================================
Binary file - no diff available.
Propchange: db/jdo/site/docs/images/javadoc.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: db/jdo/site/docs/jdohelper.html
URL: http://svn.apache.org/viewvc/db/jdo/site/docs/jdohelper.html?rev=581665&r1=581664&r2=581665&view=diff
==============================================================================
--- db/jdo/site/docs/jdohelper.html (original)
+++ db/jdo/site/docs/jdohelper.html Wed Oct 3 10:29:53 2007
@@ -1,65 +1,67 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Java
Data Objects (JDO) - JDO Helper</title><style type="text/css" media="all">
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Java
Data Objects (JDO) - JDOHelper</title><style type="text/css" media="all">
@import url("./style/maven-base.css");
- @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"><strong><a href="jdohelper.html">JDOHelper</a></strong></li><li
class="none"><a href="exceptions.html">Exceptions</a></li><li class="collapsed"><a
href="metadata.html">MetaData</a></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="refe
rences.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="externalLink" 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></d
iv><br></br></div></div><div id="bodyColumn"><div class="contentBox"><div
class="section"><a name="JDO_Helper"></a><h2>JDO Helper</h2><p>
+ @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"><strong><a href="jdohelper.html">JDOHelper</a></strong></li><li
class="none"><a href="exceptions.html">Exceptions</a></li><li class="collapsed"><a
href="metadata.html">MetaData</a></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="refe
rences.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="externalLink" 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></d
iv><br></br></div></div><div id="bodyColumn"><div class="contentBox"><div
class="section"><a name="JDOHelper"></a><h2>JDOHelper</h2><p>
JDO provides a standard utility that gives access to useful parts of the
JDO persistence process.
This is known as <b>JDOHelper</b> (javax.jdo.JDOHelper)
- <a href="http://db.apache.org/jdo/api20/apidocs/javax/jdo/JDOHelper.html"
class="newWindow" title="New Window" target="_blank"><IMG SRC="../images/javadoc.gif"></IMG></a>
- </p><p>
- The methods in JDOHelper can be split into categories. Here we start with
the methods for creating
- the starting point for persistence, the PersistenceManagerFactory (PMF)
- </p><ul>
- <li><b>getPersistenceManagerFactory(Map props)</b> -
- creates a PMF given a Map of the properties</li>
- <li><b>getPersistenceManagerFactory(Map props, ClassLoader cl)</b>
-
- creates a PMF given a Map of the properties, and a ClassLoader to use</li>
- <li><b>getPersistenceManagerFactory(String resource)</b>
-
- creates a PMF given a resource defining the properties.
- This can be used to create a named PMF in JDO2.1</li>
- <li><b>getPersistenceManagerFactory(String props, ClassLoader
cl)</b> -
- creates a PMF given a resource defining the properties, and a ClassLoader
to use</li>
- <li><b>getPersistenceManagerFactory(File props)</b> -
- creates a PMF given a file containing the properties</li>
- <li><b>getPersistenceManagerFactory(File props, ClassLoader cl)</b>
-
- creates a PMF given a file containing the properties and a ClassLoader
to use</li>
- <li><b>getPersistenceManagerFactory(String jndi, Context ctx)</b>
-
- creates a PMF given a JNDI resource</li>
- <li><b>getPersistenceManagerFactory(String jndi, Context ctx,
ClassLoader cl)</b> -
- creates a PMF given a JNDI resource and a ClassLoader to use</li>
- <li><b>getPersistenceManagerFactory(InputStream strm)</b>
-
- creates a PMF given an InputStream</li>
- <li><b>getPersistenceManagerFactory(InputStream strm, ClassLoader
cl)</b> -
- creates a PMF given an InputStream and a ClassLoader to use</li>
- </ul><p>
- Now we move onto the operations for persistence.
- </p><ul>
- <li><b>getPersistenceManager(Object pc)</b> -
- returns the PersistenceManager associated with the passed object (if
any)</li>
- <li><b>makeDirty(Object pc, String fieldName)</b> -
- marks the field of the passed object as dirty (meaning that it needs
updating in ther datastore)</li>
- <li><b>getObjectId(Object pc)</b> -
- returns the object identity for the passed object (if persistent)</li>
- <li><b>getObjectIds(Collection pc)</b> -
- returns the object identities for the passed objects (if persistent)</li>
- <li><b>getObjectIds(Object[] pc)</b> -
- returns the object identities for the passed objects (if persistent)</li>
- <li><b>getVersion(Object pc)</b> -
- returns the version for the passed object (if persistent)</li>
- </ul><p>
- Now we move onto lifecycle operations
- </p><ul>
- <li><b>isDirty(Object pc)</b> -
- returns whether the passed object is dirty</li>
- <li><b>isTransactional(Object pc)</b> -
- returns whether the passed object is transactional</li>
- <li><b>isPersistent(Object pc)</b> -
- returns whether the passed object is persistent</li>
- <li><b>isNew(Object pc)</b> -
- returns whether the passed object is new</li>
- <li><b>isDeleted(Object pc)</b> -
- returns whether the passed object is deleted</li>
- <li><b>isDetached(Object pc)</b> -
- returns whether the passed object is detached</li>
- </ul></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">
+ <a href="api20/apidocs/javax/jdo/JDOHelper.html" class="newWindow" title="New
Window" target="_blank"><IMG SRC="images/javadoc.gif"></IMG></a>
+ </p><div class="subsection"><a name="PersistenceManagerFactory_methods"></a><h3>PersistenceManagerFactory
methods</h3><p>
+ The methods in JDOHelper can be split into categories. Here we start
with the methods
+ for creating the starting point for persistence, the PersistenceManagerFactory (PMF)
+ </p><ul>
+ <li><b>getPersistenceManagerFactory(Map props)</b>
-
+ creates a PMF given a Map of the properties</li>
+ <li><b>getPersistenceManagerFactory(Map props, ClassLoader
cl)</b> -
+ creates a PMF given a Map of the properties, and a ClassLoader to
use</li>
+ <li><b>getPersistenceManagerFactory(String resource)</b>
-
+ creates a PMF given a resource defining the properties.
+ This can be used to create a named PMF in JDO2.1</li>
+ <li><b>getPersistenceManagerFactory(String props, ClassLoader
cl)</b> -
+ creates a PMF given a resource defining the properties, and a ClassLoader
to use</li>
+ <li><b>getPersistenceManagerFactory(File props)</b>
-
+ creates a PMF given a file containing the properties</li>
+ <li><b>getPersistenceManagerFactory(File props, ClassLoader
cl)</b> -
+ creates a PMF given a file containing the properties and a ClassLoader
to use</li>
+ <li><b>getPersistenceManagerFactory(String jndi, Context
ctx)</b> -
+ creates a PMF given a JNDI resource</li>
+ <li><b>getPersistenceManagerFactory(String jndi, Context
ctx, ClassLoader cl)</b> -
+ creates a PMF given a JNDI resource and a ClassLoader to use</li>
+ <li><b>getPersistenceManagerFactory(InputStream strm)</b>
-
+ creates a PMF given an InputStream</li>
+ <li><b>getPersistenceManagerFactory(InputStream strm, ClassLoader
cl)</b> -
+ creates a PMF given an InputStream and a ClassLoader to use</li>
+ </ul><br></br></div><div class="subsection"><a
name="Persistence_methods"></a><h3>Persistence methods</h3><p>
+ Now we move onto the operations for persistence.
+ </p><ul>
+ <li><b>getPersistenceManager(Object pc)</b> -
+ returns the PersistenceManager associated with the passed object
(if any)</li>
+ <li><b>makeDirty(Object pc, String fieldName)</b> -
+ marks the field of the passed object as dirty (meaning that it needs
updating in ther datastore)</li>
+ <li><b>getObjectId(Object pc)</b> -
+ returns the object identity for the passed object (if persistent)</li>
+ <li><b>getObjectIds(Collection pc)</b> -
+ returns the object identities for the passed objects (if persistent)</li>
+ <li><b>getObjectIds(Object[] pc)</b> -
+ returns the object identities for the passed objects (if persistent)</li>
+ <li><b>getVersion(Object pc)</b> -
+ returns the version for the passed object (if persistent)</li>
+ </ul><br></br></div><div class="subsection"><a
name="Lifecycle_methods"></a><h3>Lifecycle methods</h3><p>
+ Now we move onto lifecycle operations
+ </p><ul>
+ <li><b>getObjectState(Object pc)</b> -
+ returns the object state (JDO2.1 JDK1.5+ only)</li>
+ <li><b>isDirty(Object pc)</b> -
+ returns whether the passed object is dirty</li>
+ <li><b>isTransactional(Object pc)</b> -
+ returns whether the passed object is transactional</li>
+ <li><b>isPersistent(Object pc)</b> -
+ returns whether the passed object is persistent</li>
+ <li><b>isNew(Object pc)</b> -
+ returns whether the passed object is new</li>
+ <li><b>isDeleted(Object pc)</b> -
+ returns whether the passed object is deleted</li>
+ <li><b>isDetached(Object pc)</b> -
+ returns whether the passed object is detached</li>
+ </ul></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/jdohelper.xml
URL: http://svn.apache.org/viewvc/db/jdo/site/xdocs/jdohelper.xml?rev=581665&r1=581664&r2=581665&view=diff
==============================================================================
--- db/jdo/site/xdocs/jdohelper.xml (original)
+++ db/jdo/site/xdocs/jdohelper.xml Wed Oct 3 10:29:53 2007
@@ -1,77 +1,89 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<document>
<properties>
- <title>JDO Helper</title>
+ <title>JDOHelper</title>
</properties>
<body>
- <section name="JDO Helper">
+ <section name="JDOHelper">
<p>
JDO provides a standard utility that gives access to useful parts of the
JDO persistence process.
This is known as <b>JDOHelper</b> (javax.jdo.JDOHelper)
- <a href="http://db.apache.org/jdo/api20/apidocs/javax/jdo/JDOHelper.html"
target="_blank"><IMG SRC="../images/javadoc.gif"/></a>
+ <a href="api20/apidocs/javax/jdo/JDOHelper.html" target="_blank"><IMG
SRC="images/javadoc.gif"/></a>
</p>
- <p>
- The methods in JDOHelper can be split into categories. Here we start with
the methods for creating
- the starting point for persistence, the PersistenceManagerFactory (PMF)
- </p>
- <ul>
- <li><b>getPersistenceManagerFactory(Map props)</b> -
- creates a PMF given a Map of the properties</li>
- <li><b>getPersistenceManagerFactory(Map props, ClassLoader cl)</b>
-
- creates a PMF given a Map of the properties, and a ClassLoader to use</li>
- <li><b>getPersistenceManagerFactory(String resource)</b>
-
- creates a PMF given a resource defining the properties.
- This can be used to create a named PMF in JDO2.1</li>
- <li><b>getPersistenceManagerFactory(String props, ClassLoader
cl)</b> -
- creates a PMF given a resource defining the properties, and a ClassLoader
to use</li>
- <li><b>getPersistenceManagerFactory(File props)</b> -
- creates a PMF given a file containing the properties</li>
- <li><b>getPersistenceManagerFactory(File props, ClassLoader cl)</b>
-
- creates a PMF given a file containing the properties and a ClassLoader
to use</li>
- <li><b>getPersistenceManagerFactory(String jndi, Context ctx)</b>
-
- creates a PMF given a JNDI resource</li>
- <li><b>getPersistenceManagerFactory(String jndi, Context ctx,
ClassLoader cl)</b> -
- creates a PMF given a JNDI resource and a ClassLoader to use</li>
- <li><b>getPersistenceManagerFactory(InputStream strm)</b>
-
- creates a PMF given an InputStream</li>
- <li><b>getPersistenceManagerFactory(InputStream strm, ClassLoader
cl)</b> -
- creates a PMF given an InputStream and a ClassLoader to use</li>
- </ul>
- <p>
- Now we move onto the operations for persistence.
- </p>
- <ul>
- <li><b>getPersistenceManager(Object pc)</b> -
- returns the PersistenceManager associated with the passed object (if
any)</li>
- <li><b>makeDirty(Object pc, String fieldName)</b> -
- marks the field of the passed object as dirty (meaning that it needs
updating in ther datastore)</li>
- <li><b>getObjectId(Object pc)</b> -
- returns the object identity for the passed object (if persistent)</li>
- <li><b>getObjectIds(Collection pc)</b> -
- returns the object identities for the passed objects (if persistent)</li>
- <li><b>getObjectIds(Object[] pc)</b> -
- returns the object identities for the passed objects (if persistent)</li>
- <li><b>getVersion(Object pc)</b> -
- returns the version for the passed object (if persistent)</li>
- </ul>
- <p>
- Now we move onto lifecycle operations
- </p>
- <ul>
- <li><b>isDirty(Object pc)</b> -
- returns whether the passed object is dirty</li>
- <li><b>isTransactional(Object pc)</b> -
- returns whether the passed object is transactional</li>
- <li><b>isPersistent(Object pc)</b> -
- returns whether the passed object is persistent</li>
- <li><b>isNew(Object pc)</b> -
- returns whether the passed object is new</li>
- <li><b>isDeleted(Object pc)</b> -
- returns whether the passed object is deleted</li>
- <li><b>isDetached(Object pc)</b> -
- returns whether the passed object is detached</li>
- </ul>
+
+ <subsection name="PersistenceManagerFactory methods">
+ <p>
+ The methods in JDOHelper can be split into categories. Here we start
with the methods
+ for creating the starting point for persistence, the PersistenceManagerFactory (PMF)
+ </p>
+ <ul>
+ <li><b>getPersistenceManagerFactory(Map props)</b>
-
+ creates a PMF given a Map of the properties</li>
+ <li><b>getPersistenceManagerFactory(Map props, ClassLoader
cl)</b> -
+ creates a PMF given a Map of the properties, and a ClassLoader to
use</li>
+ <li><b>getPersistenceManagerFactory(String resource)</b>
-
+ creates a PMF given a resource defining the properties.
+ This can be used to create a named PMF in JDO2.1</li>
+ <li><b>getPersistenceManagerFactory(String props, ClassLoader
cl)</b> -
+ creates a PMF given a resource defining the properties, and a ClassLoader
to use</li>
+ <li><b>getPersistenceManagerFactory(File props)</b>
-
+ creates a PMF given a file containing the properties</li>
+ <li><b>getPersistenceManagerFactory(File props, ClassLoader
cl)</b> -
+ creates a PMF given a file containing the properties and a ClassLoader
to use</li>
+ <li><b>getPersistenceManagerFactory(String jndi, Context
ctx)</b> -
+ creates a PMF given a JNDI resource</li>
+ <li><b>getPersistenceManagerFactory(String jndi, Context
ctx, ClassLoader cl)</b> -
+ creates a PMF given a JNDI resource and a ClassLoader to use</li>
+ <li><b>getPersistenceManagerFactory(InputStream strm)</b>
-
+ creates a PMF given an InputStream</li>
+ <li><b>getPersistenceManagerFactory(InputStream strm, ClassLoader
cl)</b> -
+ creates a PMF given an InputStream and a ClassLoader to use</li>
+ </ul>
+ <br/>
+ </subsection>
+ <subsection name="Persistence methods">
+ <p>
+ Now we move onto the operations for persistence.
+ </p>
+ <ul>
+ <li><b>getPersistenceManager(Object pc)</b> -
+ returns the PersistenceManager associated with the passed object
(if any)</li>
+ <li><b>makeDirty(Object pc, String fieldName)</b> -
+ marks the field of the passed object as dirty (meaning that it needs
updating in ther datastore)</li>
+ <li><b>getObjectId(Object pc)</b> -
+ returns the object identity for the passed object (if persistent)</li>
+ <li><b>getObjectIds(Collection pc)</b> -
+ returns the object identities for the passed objects (if persistent)</li>
+ <li><b>getObjectIds(Object[] pc)</b> -
+ returns the object identities for the passed objects (if persistent)</li>
+ <li><b>getVersion(Object pc)</b> -
+ returns the version for the passed object (if persistent)</li>
+ </ul>
+ <br/>
+ </subsection>
+
+ <subsection name="Lifecycle methods">
+ <p>
+ Now we move onto lifecycle operations
+ </p>
+ <ul>
+ <li><b>getObjectState(Object pc)</b> -
+ returns the object state (JDO2.1 JDK1.5+ only)</li>
+ <li><b>isDirty(Object pc)</b> -
+ returns whether the passed object is dirty</li>
+ <li><b>isTransactional(Object pc)</b> -
+ returns whether the passed object is transactional</li>
+ <li><b>isPersistent(Object pc)</b> -
+ returns whether the passed object is persistent</li>
+ <li><b>isNew(Object pc)</b> -
+ returns whether the passed object is new</li>
+ <li><b>isDeleted(Object pc)</b> -
+ returns whether the passed object is deleted</li>
+ <li><b>isDetached(Object pc)</b> -
+ returns whether the passed object is detached</li>
+ </ul>
+ </subsection>
</section>
</body>
|