OPENJPA-250: Update user manual.

git-svn-id: https://svn.apache.org/repos/asf/openjpa/trunk@821144 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Richard G. Curtis 2009-10-02 19:51:55 +00:00
parent 680320a733
commit 58539dd833
2 changed files with 75 additions and 0 deletions

View File

@ -2467,6 +2467,53 @@ retrieve metadata for your persistent classes. See
<xref linkend="ref_guide_meta_factory"/> for details.
</para>
</section>
<!-- start -->
<section id="openjpa.MetaDataRepository">
<title>
openjpa.MetaDataRepository
</title>
<indexterm zone="openjpa.MetaDataRepository">
<primary>
MetaDataRepository
</primary>
</indexterm>
<indexterm zone="openjpa.MetaDataRepository">
<primary>
metadata
</primary>
<secondary>
MetaDataRepository
</secondary>
</indexterm>
<para>
<emphasis role="bold">Property name: </emphasis><literal>openjpa.MetaDataRepository
</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMetaDataRepository()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getMetaDataRepository
</methodname></ulink>
</para>
<para>
<emphasis role="bold">Resource adaptor config-property: </emphasis><literal>
MetaDataRepository</literal>
</para>
<para>
<emphasis role="bold">Default:</emphasis>none<literal></literal>
</para>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/meta/MetaDataRepository.html">
<classname>openjpa.meta.MetaDataRepository</classname></ulink> to use to store and
retrieve metadata for your persistent classes. See
<xref linkend="ref_guide_meta_repository"/> for details.
</para>
</section>
<!-- end -->
<section id="openjpa.Multithreaded">
<title>
openjpa.Multithreaded

View File

@ -119,6 +119,34 @@ scanned for annotated JPA entities.
</programlisting>
</example>
</section>
<!-- start added -->
<section id="ref_guide_meta_repository">
<para>The openjpa.MetaDataRepository configuration property controls the configuration of
the MetaDataRepository. The following are valid properties:</para>
<itemizedlist>
<listitem><para>
<literal>Preload</literal>: A boolean property. If true, OpenJPA will eagerly load the repository on
EntityManagerFactory creation. As a result, all Entity classes will be eagerly loaded by the JVM. If
false, the repository will be lazily loaded as Entity classes are loaded by the JVM. The default value
is false.
</para>
</listitem>
<listitem><para>
<literal>NoLock</literal>: If true, the repository will be treated as a read only data structure and
minimal locking will be imposed on users. Preload must be set to true for OpenJPA to honor setting
NoLock to true. The default value is false.
</para>
</listitem>
</itemizedlist>
<title>Metadata Repository</title>
<example id="ref_guide_meta_repo">
<programlisting>
&lt;property name="openjpa.MetaDataRepository" value="Preload=true,NoLock=true"/&gt;
</programlisting>
</example>
</section>
<!-- end added -->
<section id="ref_guide_meta_jpa">
<title>
Additional JPA Metadata