Author: mikedd
Date: Thu Oct 1 16:12:41 2009
New Revision: 820700
URL: http://svn.apache.org/viewvc?rev=820700&view=rev
Log:
alphabetizing datacachemode documentation and fixing default value
Modified:
openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_conf.xml
Modified: openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_conf.xml
URL:
http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_conf.xml?rev=820700&r1=820699&r2=820700&view=diff
==============================================================================
--- openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_conf.xml (original)
+++ openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_conf.xml Thu Oct 1
16:12:41 2009
@@ -1617,16 +1617,16 @@
on data caching.
</para>
</section>
- <section id="openjpa.DataCacheTimeout">
+ <section id="openjpa.DataCacheMode">
<title>
- openjpa.DataCacheTimeout
+ openjpa.DataCacheMode
</title>
- <indexterm zone="openjpa.DataCacheTimeout">
+ <indexterm zone="openjpa.DataCacheMode">
<primary>
- DataCacheTimeout
+ DataCacheMode
</primary>
</indexterm>
- <indexterm zone="openjpa.DataCacheTimeout">
+ <indexterm zone="openjpa.DataCacheMode">
<primary>
caching
</primary>
@@ -1636,39 +1636,36 @@
</indexterm>
<para>
<emphasis role="bold">Property name: </emphasis><literal>
-openjpa.DataCacheTimeout</literal>
+openjpa.DataCacheMode</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
-<ulink
url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCacheTimeout()">
-<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getDataCacheTimeout
+<ulink
url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCacheMode()">
+<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getDataCacheMode
</methodname></ulink>
</para>
<para>
<emphasis role="bold">Resource adaptor config-property: </emphasis><literal>
-DataCacheTimeout</literal>
+DataCacheMode</literal>
</para>
<para>
-<emphasis role="bold">Default: </emphasis><literal>-1</literal>
+<emphasis role="bold">Default: </emphasis><literal>DataCacheMode.UNSPECIFIED
(see javadoc for details)</literal>
</para>
<para>
-<emphasis role="bold">Description:</emphasis> The number of milliseconds that
-data in the data cache is valid. Set this to -1 to indicate that data should
not
-expire from the cache. This property can also be specified for individual
-classes. See <xref linkend="ref_guide_cache_conf"/> for details.
+<emphasis role="bold">Description:</emphasis>Determines which entities will be
included in the DataCache. May be any of the values defined in <ulink
url="../javadoc/org/apache/openjpa/datacache/DataCacheMode.html"/>.
</para>
</section>
- <section id="openjpa.DataCacheMode">
+ <section id="openjpa.DataCacheTimeout">
<title>
- openjpa.DataCacheMode
+ openjpa.DataCacheTimeout
</title>
- <indexterm zone="openjpa.DataCacheMode">
+ <indexterm zone="openjpa.DataCacheTimeout">
<primary>
- DataCacheMode
+ DataCacheTimeout
</primary>
</indexterm>
- <indexterm zone="openjpa.DataCacheMode">
+ <indexterm zone="openjpa.DataCacheTimeout">
<primary>
caching
</primary>
@@ -1678,23 +1675,26 @@
</indexterm>
<para>
<emphasis role="bold">Property name: </emphasis><literal>
-openjpa.DataCacheMode</literal>
+openjpa.DataCacheTimeout</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
-<ulink
url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCacheMode()">
-<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getDataCacheMode
+<ulink
url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCacheTimeout()">
+<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getDataCacheTimeout
</methodname></ulink>
</para>
<para>
<emphasis role="bold">Resource adaptor config-property: </emphasis><literal>
-DataCacheMode</literal>
+DataCacheTimeout</literal>
</para>
<para>
<emphasis role="bold">Default: </emphasis><literal>-1</literal>
</para>
<para>
-<emphasis role="bold">Description:</emphasis>Determines which entities will be
included in the DataCache. May be any of the values defined in <ulink
url="../javadoc/org/apache/openjpa/datacache/DataCacheMode.html"/>.
+<emphasis role="bold">Description:</emphasis> The number of milliseconds that
+data in the data cache is valid. Set this to -1 to indicate that data should
not
+expire from the cache. This property can also be specified for individual
+classes. See <xref linkend="ref_guide_cache_conf"/> for details.
</para>
</section>
