You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cayenne.apache.org by aa...@apache.org on 2011/08/29 23:23:44 UTC
svn commit: r1163012 - in
/cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx: appendix-a.xml
customizing-cayenne-runtime.xml including-cayenne-in-project.xml setup.xml
Author: aadamchik
Date: Mon Aug 29 21:23:44 2011
New Revision: 1163012
URL: http://svn.apache.org/viewvc?rev=1163012&view=rev
Log:
docbook
in progress
Modified:
cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/appendix-a.xml
cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/customizing-cayenne-runtime.xml
cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/including-cayenne-in-project.xml
cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/setup.xml
Modified: cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/appendix-a.xml
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/appendix-a.xml?rev=1163012&r1=1163011&r2=1163012&view=diff
==============================================================================
--- cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/appendix-a.xml (original)
+++ cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/appendix-a.xml Mon Aug 29 21:23:44 2011
@@ -3,12 +3,11 @@
version="5.0" xml:id="server-configuration-properties">
<title>Server Configuration Properties</title>
<para>
- <table frame="void" width="737">
+ <table frame="void" width="739">
<caption>Configuration Properties Recognized by ServerRuntime</caption>
- <col width="51%"/>
- <col width="7%"/>
- <col width="8%"/>
- <col width="38%"/>
+ <col width="77%"/>
+ <col width="10%"/>
+ <col width="13%"/>
<thead>
<tr>
<th>Property</th>
@@ -18,26 +17,28 @@
</thead>
<tbody>
<tr>
- <td><code>org.apache.cayenne.sync_contexts</code> - defines whether peer ObjectContexts should
- receive snapshot events after commits from other contexts. If true
- (default), the contexts would automatically synchronize their state with
- peers.</td>
+ <td><code>org.apache.cayenne.sync_contexts</code> - defines whether peer
+ ObjectContexts should receive snapshot events after commits from other
+ contexts. If true (default), the contexts would automatically synchronize
+ their state with peers.</td>
<td>true, false</td>
<td>true</td>
</tr>
<tr>
- <td><code>org.apache.cayenne.context_object_retain_strategy</code> - defines fetched objects
- retain strategy for ObjectContexts. When weak or soft strategy is used,
- objects retained by ObjectContext that have no local changes can potetially
- get garbage collected when JVM feels like doing it.</td>
+ <td><code>org.apache.cayenne.context_object_retain_strategy</code> - defines
+ fetched objects retain strategy for ObjectContexts. When weak or soft
+ strategy is used, objects retained by ObjectContext that have no local
+ changes can potetially get garbage collected when JVM feels like doing
+ it.</td>
<td>weak, soft, hard</td>
<td>weak</td>
</tr>
<tr>
- <td><code>cayenne.jdbc.driver[.domain_name.node_name]</code> - defines the JDBC driver to use
- when creating a DataSource. If domain name and optionally - node name are
- specified, the setting overrides DataSource info just for this domain/node.
- Otherwise the override is applied to all domains/nodes in the system.</td>
+ <td><code>cayenne.jdbc.driver[.domain_name.node_name]</code> - defines the JDBC
+ driver to use when creating a DataSource. If domain name and optionally -
+ node name are specified, the setting overrides DataSource info just for this
+ domain/node. Otherwise the override is applied to all domains/nodes in the
+ system.</td>
<td/>
<td>none, project DataNode configuration is used</td>
</tr>
@@ -99,7 +100,7 @@
<td><code>cayenne.MapQueryCacheFactory.cacheSize</code> - defines the max size
of the LRU query cache map. Ignored if the default MapQueryCacheFactory is
overridden and a different cache provider is used.</td>
- <td>an int defininging max number of entries in the cache</td>
+ <td>an int defining max number of entries in the cache</td>
<td>2000</td>
</tr>
</tbody>
Modified: cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/customizing-cayenne-runtime.xml
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/customizing-cayenne-runtime.xml?rev=1163012&r1=1163011&r2=1163012&view=diff
==============================================================================
--- cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/customizing-cayenne-runtime.xml (original)
+++ cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/customizing-cayenne-runtime.xml Mon Aug 29 21:23:44 2011
@@ -146,7 +146,6 @@ binder.bind(Key.get(Service2.class, "i2"
<code>org.apache.cayenne.di.spi.DefaultScope</code> with startup and shutdown
managed by the application (e.g. singleton scope is a DefaultScope managed by the
Injector) . </para>
- <para> </para>
</section>
<section xml:id="overriding-services">
<title>Overriding Services</title>
@@ -240,11 +239,15 @@ binder.bindList(DefaultDbAdapterFactory.
</section>
<section xml:id="noteworthy-runtime-components">
<title>Noteworthy Built-in Services</title>
- <section>
- <title>RuntimeProperties</title>
- </section>
<section xml:id="jdbceventlogger">
<title>JdbcEventLogger</title>
+ <para><code>org.apache.cayenne.log.JdbcEventLogger</code> is the service that defines
+ logging API for Cayenne internals. It provides facilities for logging queries,
+ commits, transactions, etc. The default implementation is
+ <code>org.apache.cayenne.log.CommonsJdbcEventLogger</code> that performs logging
+ via commons-logging library. Cayenne library includes another potentially useful
+ logger - <code>org.apache.cayenne.log.FormattedCommonsJdbcEventLogger</code> that
+ produces formatted multiline SQL output that can be easier to read.</para>
</section>
<section xml:id="datasourcefactory">
<title>DataSourceFactory</title>
Modified: cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/including-cayenne-in-project.xml
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/including-cayenne-in-project.xml?rev=1163012&r1=1163011&r2=1163012&view=diff
==============================================================================
--- cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/including-cayenne-in-project.xml (original)
+++ cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/including-cayenne-in-project.xml Mon Aug 29 21:23:44 2011
@@ -4,9 +4,53 @@
<title>Including Cayenne in a Project</title>
<section xml:id="jar-files-and-depdendencies">
<title>Jar Files and Dependencies</title>
+ <para>Cayenne distribution contains the following core runtime jars in the distribution
+ <code>lib</code> directory: <itemizedlist>
+ <listitem>
+ <para><emphasis role="italic">cayenne-server-x.x.jar</emphasis> - contains full
+ Cayenne runtime (DI, adapters, DB access classes, etc.). Most applications
+ will use only this file.</para>
+ </listitem>
+ <listitem>
+ <para>cayenne-client-x.x.jar - a subset of cayenne-server.jar trimmed for use on
+ the client in an ROP application.</para>
+ </listitem>
+ <listitem>
+ <para>Other cayenne-* jars - various Cayenne extensions.</para>
+ </listitem>
+ </itemizedlist></para>
+ <para>When using <code>cayenne-server-x.x.jar</code> you'll need a few third party jars (all
+ included in <code>lib/third-party</code> directory of the distribution): <itemizedlist>
+ <listitem>
+ <para><link xlink:href="http://jakarta.apache.org/velocity/">Apache Velocity
+ Template Engine</link>, version 1.6.x (and all its dependencies bundled
+ with velocity-dep)</para>
+ </listitem>
+ <listitem>
+ <para><link xlink:href="http://jakarta.apache.org/commons/collections">Apache
+ Commons Collections</link>, version 3.1</para>
+ </listitem>
+ <listitem>
+ <para><link xlink:href="http://jakarta.apache.org/commons/logging/">Apache
+ Commons Logging</link>, version 1.1</para>
+ </listitem>
+ </itemizedlist></para>
+ <para>Cayenne integrates with various caching, clustering and other frameworks. These
+ optional integrations will require other third-party jars that the users will need to
+ obtain on their own.</para>
</section>
<section xml:id="maven-projects">
<title>Maven Projects</title>
+ <para>If you are using Maven, you won't have to deal with figuring out the dependencies. You
+ can simply include cayenne-server artifact in your
+ POM:<programlisting><dependency>
+ <groupId>org.apache.cayenne</groupId>
+ <artifactId>cayenne-server</artifactId>
+ <version>X.Y.Z</version>
+</dependency></programlisting></para>
+ <para>Additionally Cayenne provides a set of plugins to perform various project tasks, such
+ as synching generated Java classes with the mapping, etc, described in the following
+ subsection.</para>
<section xml:id="mvn-cgen">
<title>cgen</title>
</section>
Modified: cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/setup.xml
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/setup.xml?rev=1163012&r1=1163011&r2=1163012&view=diff
==============================================================================
--- cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/setup.xml (original)
+++ cayenne/main/trunk/docs/docbook/cayenne-guide/src/docbkx/setup.xml Mon Aug 29 21:23:44 2011
@@ -4,8 +4,65 @@
<title>Setup</title>
<section xml:id="system-requirements">
<title>System Requirements</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="italic">Java</emphasis>: Cayenne runtime framework and
+ CayenneModeler GUI tool are written in 100% Java, and run on any
+ Java-compatible platform. Required JDK version is 1.5 or higher. The last
+ version of Cayenne compatible with JDK 1.4 is 1.2.x/2.0.x; JDK 1.3 -
+ 1.1.x)</para>
+ </listitem>
+ </itemizedlist>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="italic">JDBC Driver:</emphasis> An appropriate DB-specific
+ JDBC driver is needed to access the database. It can be included in the
+ application or used in web container DataSource configuration.</para>
+ </listitem>
+ </itemizedlist>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="italic">Third-party Libraries:</emphasis> Cayenne runtime
+ framework has a minimal set of required and a fe more optional dependencies
+ on third-party open source packages. See "Including Cayenne in a Project"
+ chapter for details.</para>
+ </listitem>
+ </itemizedlist>
+ </para>
</section>
<section xml:id="running-cayennemodeler">
<title>Running CayenneModeler</title>
+ <para>CayenneModeler GUI tool is intended to work with object relational mapping projects. While
+ you can edit your XML by hand, it is rarely needed, as the Modeler is a pretty advanced
+ tool included in Cayenne distribution. To obtain CayenneModeler, download Cayenne
+ distribution archive from <link xlink:href="http://cayenne.apache.org/download.html"
+ >http://cayenne.apache.org/download.html</link> matching the OS you are using. Of
+ course Java needs to be installed on the machine where you are going to run the
+ Modeler.</para>
+ <para>OS X distribution contains CayenneModeler.app at the root of the distribution disk
+ image.</para>
+ <para>Windows distribution contains CayenneModeler.exe file in the <code>bin</code>
+ directory.</para>
+ <para>Cross-platform distribution (targeting Linux, but as the name implies, compatible with any
+ OS) contains a runnable CayenneModeler.jar in the <code>bin</code> directory. It can be
+ executed either by double-clicking, or if the environment is not configured to execute
+ jars, by running from command-line:</para>
+ <programlisting>java -jar CayenneModeler.jar</programlisting>
+ <para>The Modeler can alo be started from Maven. While it may look like an exotic way to start a
+ GUI application, it has its benefits - no need to download Cayenne distribution, the
+ version of the Modeler always matches the version of the framework, the plugin can find
+ mapping files in the project automatically. So is an attractive option to some
+ developers. Maven option requires a declaration in the
+ POM:<programlisting><build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.cayenne.plugins</groupId>
+ <artifactId>maven-cayenne-modeler-plugin</artifactId>
+ <version>X.Y.Z</version>
+ </plugin>
+ </plugins>
+</build></programlisting></para>
+ <para>And then can be run as <programlisting>mvn cayenne-modeler:run</programlisting></para>
</section>
</chapter>