[exo-jcr-commits] exo-jcr SVN: r5361 - jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr.

[do-not-reply at jboss.org]

Author: tolusha
Date: 2011-12-27 02:31:38 -0500 (Tue, 27 Dec 2011)
New Revision: 5361

Modified:
   jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/api-extensions.xml
Log:
EXOJCR-1686: updated documentation about Lazy child nodes iteration

Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/api-extensions.xml
===================================================================
--- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/api-extensions.xml	2011-12-27 07:28:24 UTC (rev 5360)
+++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/api-extensions.xml	2011-12-27 07:31:38 UTC (rev 5361)
@@ -63,12 +63,16 @@
     <section>
       <title>Configuration</title>
 
-      <para>"Lazy" iterator makes ahead reading into memory, though reading
-      the "page". "Page" is a set of nodes read at once. Size of the page by
-      default is 100 nodes and can be configured though workspace container
-      configuration using "lazy-node-iterator-page-size" parameter.
-      I.e.:</para>
+      <para>In order to enable add the
+      "-Dorg.exoplatform.jcr.forceUserGetNodesLazily=true" to the java system
+      properties.</para>
 
+      <para>The "lazy" iterator reads the child nodes "page" after "page" into
+      the memory. In this context, a "page" is a set of nodes that is read at
+      once. The size of the page is by default 100 nodes and can be configured
+      though workspace container configuration using
+      "lazy-node-iterator-page-size" parameter. For example:</para>
+
       <programlisting language="xml">&lt;container class="org.exoplatform.services.jcr.impl.storage.jdbc.optimisation.CQJDBCWorkspaceDataContainer"&gt;
    &lt;properties&gt;
       &lt;property name="source-name" value="jdbcjcr" /&gt;
@@ -79,7 +83,8 @@
       ...
    &lt;/properties&gt;</programlisting>
 
-      <para>But it's not recommended to set huge page size</para>
+      <para>It's not recommended to configure a large number for the page
+      size.</para>
     </section>
 
     <section>