[hibernate-commits] Hibernate SVN: r14341 - search/trunk/doc/reference/en/modules.

[hibernate-commits at lists.jboss.org]

Author: epbernard
Date: 2008-02-19 17:46:59 -0500 (Tue, 19 Feb 2008)
New Revision: 14341

Modified:
   search/trunk/doc/reference/en/modules/configuration.xml
Log:
more doc

Modified: search/trunk/doc/reference/en/modules/configuration.xml
===================================================================
--- search/trunk/doc/reference/en/modules/configuration.xml	2008-02-19 19:16:06 UTC (rev 14340)
+++ search/trunk/doc/reference/en/modules/configuration.xml	2008-02-19 22:46:59 UTC (rev 14341)
@@ -503,6 +503,35 @@
           engine</para>
         </listitem>
       </itemizedlist>
+
+      <section>
+        <title>Hibernate Core 3.2.6 and beyond</title>
+
+        <para>If you use Hibernate Core 3.2.6 and beyond, make sure to add
+        three additional event listeners that cope with collection
+        events</para>
+
+        <programlisting>&lt;hibernate-configuration&gt;
+     &lt;session-factory&gt;
+        ...
+        &lt;event type="post-collection-recreate"/&gt;
+            &lt;listener class="org.hibernate.search.event.FullTextIndexCollectionEventListener"/&gt;
+        &lt;/event&gt;
+        &lt;event type="post-collection-remove"/&gt;
+            &lt;listener class="org.hibernate.search.event.FullTextIndexCollectionEventListener"/&gt;
+        &lt;/event&gt;
+        &lt;event type="post-collection-update"/&gt;
+            &lt;listener class="org.hibernate.search.event.FullTextIndexCollectionEventListener"/&gt;
+        &lt;/event&gt;
+    &lt;/session-factory&gt;
+&lt;/hibernate-configuration&gt;</programlisting>
+
+        <para>Those additional event listeners have been introduced in
+        Hibernate 3.2.6. note the
+        <classname>FullTextIndexCollectionEventListener</classname> usage. You
+        need to explicitly reference those event listeners unless you use
+        Hibernate Annotations 3.3.1 and above.</para>
+      </section>
     </section>
 
     <section>
@@ -542,30 +571,30 @@
     settings depending on the use case. During indexing operations triggered
     by database modifications, the following ones are used: <itemizedlist>
         <listitem>
-          <literal>hibernate.search.[default|&lt;indexname&gt;].transaction.merge_factor</literal>
+          <para><literal>hibernate.search.[default|&lt;indexname&gt;].transaction.merge_factor</literal></para>
         </listitem>
 
         <listitem>
-          <literal>hibernate.search.[default|&lt;indexname&gt;].transaction.max_merge_docs</literal>
+          <para><literal>hibernate.search.[default|&lt;indexname&gt;].transaction.max_merge_docs</literal></para>
         </listitem>
 
         <listitem>
-          <literal>hibernate.search.[default|&lt;indexname&gt;].transaction.max_buffered_docs</literal>
+          <para><literal>hibernate.search.[default|&lt;indexname&gt;].transaction.max_buffered_docs</literal></para>
         </listitem>
       </itemizedlist>When indexing occurs via
     <literal>FullTextSession.index()</literal> (see <xref
     linkend="search-batchindex" />), the following properties are used:
     <itemizedlist>
         <listitem>
-          <literal>hibernate.search.[default|&lt;indexname&gt;].batch.merge_factor</literal>
+          <para><literal>hibernate.search.[default|&lt;indexname&gt;].batch.merge_factor</literal></para>
         </listitem>
 
         <listitem>
-          <literal>hibernate.search.[default|&lt;indexname&gt;].batch.max_merge_docs</literal>
+          <para><literal>hibernate.search.[default|&lt;indexname&gt;].batch.max_merge_docs</literal></para>
         </listitem>
 
         <listitem>
-          <literal>hibernate.search.[default|&lt;indexname&gt;].batch.max_buffered_docs</literal>
+          <para><literal>hibernate.search.[default|&lt;indexname&gt;].batch.max_buffered_docs</literal></para>
         </listitem>
       </itemizedlist></para>