6:44 a.m.
Author: hardy.ferentschik
Date: 2009-03-25 07:44:54 -0400 (Wed, 25 Mar 2009)
New Revision: 16213
Removed:
search/trunk/doc/reference/
Modified:
search/trunk/src/main/docbook/en-US/modules/architecture.xml
search/trunk/src/main/docbook/en-US/modules/configuration.xml
search/trunk/src/main/docbook/en-US/modules/query.xml
Log:
HSEARCH-82 deleted obsolete docbook support
Modified: search/trunk/src/main/docbook/en-US/modules/architecture.xml
===================================================================
--- search/trunk/src/main/docbook/en-US/modules/architecture.xml 2009-03-25 10:53:03 UTC
(rev 16212)
+++ search/trunk/src/main/docbook/en-US/modules/architecture.xml 2009-03-25 11:44:54 UTC
(rev 16213)
@@ -119,14 +119,13 @@
<mediaobject>
<imageobject role="html">
- <imagedata align="center"
- fileref="lucene-backend.png"
+ <imagedata align="center"
fileref="lucene-backend.png"
format="PNG" />
</imageobject>
<imageobject role="fo">
- <imagedata align="center"
fileref="lucene-backend.png"
- format="PNG" />
+ <imagedata align="center" depth=""
fileref="lucene-backend.png"
+ format="PNG" scalefit="1"
width="12cm" />
</imageobject>
<caption>
@@ -156,13 +155,12 @@
<mediaobject>
<imageobject role="html">
- <imagedata align="center"
- fileref="jms-backend.png" format="PNG" />
+ <imagedata align="center" fileref="jms-backend.png"
format="PNG" />
</imageobject>
<imageobject role="fo">
- <imagedata align="center" fileref="jms-backend.png"
- format="PNG" />
+ <imagedata align="center" depth=""
fileref="jms-backend.png"
+ format="PNG" scalefit="1"
width="12cm" />
</imageobject>
<caption>
Modified: search/trunk/src/main/docbook/en-US/modules/configuration.xml
===================================================================
--- search/trunk/src/main/docbook/en-US/modules/configuration.xml 2009-03-25 10:53:03 UTC
(rev 16212)
+++ search/trunk/src/main/docbook/en-US/modules/configuration.xml 2009-03-25 11:44:54 UTC
(rev 16213)
@@ -58,7 +58,7 @@
</thead>
<tbody>
- <row>
+ <row>
<entry>org.hibernate.search.store.RAMDirectoryProvider</entry>
<entry>Memory based directory, the directory will be uniquely
@@ -67,7 +67,7 @@
<entry>none</entry>
</row>
-
+
<row>
<entry>org.hibernate.search.store.FSDirectoryProvider</entry>
@@ -77,7 +77,8 @@
<entry><para><literal>indexBase</literal> : Base
directory</para><para><literal>indexName</literal>:
override
@Indexed.index (useful for sharded
indexes)</para><para><literal>
- locking_strategy</literal> : optional, see <xref
linkend="search-configuration-directory-lockfactories" />
+ locking_strategy</literal> : optional, see <xref
+ linkend="search-configuration-directory-lockfactories" />
</para></entry>
</row>
@@ -109,8 +110,9 @@
(the copy will take place every refresh seconds).</para><para>
<literal>buffer_size_on_copy</literal>: The amount of MegaBytes
to
move in a single low level copy instruction; defaults to
- 16MB.</para><para><literal>
- locking_strategy</literal> : optional, see <xref
linkend="search-configuration-directory-lockfactories" />
+ 16MB.</para><para><literal>
locking_strategy</literal> : optional,
+ see <xref
+ linkend="search-configuration-directory-lockfactories" />
</para></entry>
</row>
@@ -142,11 +144,11 @@
(the copy will take place every refresh seconds).</para><para>
<literal>buffer_size_on_copy</literal>: The amount of MegaBytes
to
move in a single low level copy instruction; defaults to
- 16MB.</para><para><literal>
- locking_strategy</literal> : optional, see <xref
linkend="search-configuration-directory-lockfactories" />
+ 16MB.</para><para><literal>
locking_strategy</literal> : optional,
+ see <xref
+ linkend="search-configuration-directory-lockfactories" />
</para></entry>
</row>
-
</tbody>
</tgroup>
</table>
@@ -353,8 +355,6 @@
<title>worker configuration</title>
<tgroup cols="2">
- <colspec align="center" />
-
<tbody>
<row>
<entry>Property</entry>
@@ -429,20 +429,18 @@
<para>This section describes in greater detail how to configure the Master
/ Slaves Hibernate Search architecture.</para>
- <para><mediaobject>
- <imageobject role="html">
- <imagedata align="center" fileref="jms-backend.png"
- format="PNG" />
- </imageobject>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata align="center" fileref="jms-backend.png"
format="PNG" />
+ </imageobject>
- <imageobject role="fo">
- <imagedata align="center" fileref="jms-backend.png"
- format="PNG" />
- </imageobject>
+ <imageobject role="fo">
+ <imagedata align="center" depth=""
fileref="jms-backend.png"
+ format="PNG" scalefit="1" width="12cm"
/>
+ </imageobject>
- <caption><para>JMS Master/Slave architecture
- overview.</para></caption>
- </mediaobject></para>
+ <caption><para>JMS back end
configuration.</para></caption>
+ </mediaobject>
<section>
<title>Slave nodes</title>
@@ -850,79 +848,121 @@
</tgroup>
</table>
</section>
-
+
<section id="search-configuration-directory-lockfactories"
revision="1">
- <title>LockFactory configuration</title>
- <para>Lucene Directories have default locking strategies which work well for most
cases,
- but it's possible to specify for each index managed by Hibernate Search which
LockingFactory
- you want to use.</para><para>Some of these locking strategies require a
filesystem level lock and may be used
- even on RAM based indexes, but this is not recommended and of no practical
use.</para>
- <para>To select a locking factory, set the
<literal>hibernate.search.<index>.locking_strategy</literal>
option to
- one of <literal>simple</literal>, <literal>native</literal>,
<literal>single</literal>
- or <literal>none</literal>, or set it to the fully qualified name of an
implementation of
- <literal>org.hibernate.search.store.LockFactoryFactory</literal>;
Implementing this interface you can provide
- a custom <literal>org.apache.lucene.store.LockFactory</literal>.
-
- <table id="search-configuration-directory-lockfactories-table">
- <title>List of available LockFactory implementations</title>
+
- <tgroup cols="3">
- <thead>
- <row>
- <entry align="center">name</entry>
- <entry align="center">Class</entry>
- <entry align="center">Description</entry>
- </row>
- </thead>
+ <title>LockFactory configuration</title>
- <tbody>
- <row>
- <entry>simple</entry>
- <entry>org.apache.lucene.store.SimpleFSLockFactory</entry>
- <entry>
- <para>Safe implementation based on Java's File API, it marks the
usage of the index by creating a marker file.</para>
- <para>If for some reason you had to kill your application, you will
need to remove this file before restarting it.</para>
- <para>This is the default implementation for
<literal>FSDirectoryProvider</literal>,<literal>FSMasterDirectoryProvider</literal>
and
- <literal>FSSlaveDirectoryProvider</literal>.</para>
- </entry>
+
+
+ <para>Lucene Directories have default locking strategies which work well
+ for most cases, but it's possible to specify for each index managed by
+ Hibernate Search which LockingFactory you want to use.</para>
+
+ <para>Some of these locking strategies require a filesystem level lock and
+ may be used even on RAM based indexes, but this is not recommended and of
+ no practical use.</para>
+
+
+
+ <para>To select a locking factory, set the
+
<literal>hibernate.search.<index>.locking_strategy</literal>
option
+ to one of <literal>simple</literal>,
<literal>native</literal>,
+ <literal>single</literal> or <literal>none</literal>, or set
it to the
+ fully qualified name of an implementation of
+ <literal>org.hibernate.search.store.LockFactoryFactory</literal>;
+ Implementing this interface you can provide a custom
+ <literal>org.apache.lucene.store.LockFactory</literal>. <table
+ id="search-configuration-directory-lockfactories-table">
+ <title>List of available LockFactory implementations</title>
+
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry align="center">name</entry>
+
+ <entry align="center">Class</entry>
+
+ <entry align="center">Description</entry>
</row>
+ </thead>
+
+ <tbody>
<row>
- <entry>native</entry>
- <entry>org.apache.lucene.store.NativeFSLockFactory</entry>
- <entry>
- <para>As does <literal>simple</literal> this also marks
the usage of the index by creating a marker file, but this one
- is using native OS file locks so that even if your application crashes the
locks will be cleaned up.</para>
- <para>This implementation has known problems on NFS.</para>
- </entry>
+ <entry>simple</entry>
+
+ <entry>org.apache.lucene.store.SimpleFSLockFactory</entry>
+
+ <entry>
+ <para>Safe implementation based on Java's File API, it marks
+ the usage of the index by creating a marker file.</para>
+
+ <para>If for some reason you had to kill your application, you
+ will need to remove this file before restarting it.</para>
+
+ <para>This is the default implementation for
+
<literal>FSDirectoryProvider</literal>,<literal>FSMasterDirectoryProvider</literal>
+ and
<literal>FSSlaveDirectoryProvider</literal>.</para>
+ </entry>
</row>
+
<row>
- <entry>single</entry>
- <entry>org.apache.lucene.store.SingleInstanceLockFactory</entry>
- <entry>
- <para>This LockFactory doesn't use a file marker but is a Java
object lock held in memory; therefore
- it's possible to use it only when you are sure the index is not going to
be shared by any other process.</para>
- <para>This is the default implementation for
<literal>RAMDirectoryProvider</literal>.</para>
- </entry>
+ <entry>native</entry>
+
+ <entry>org.apache.lucene.store.NativeFSLockFactory</entry>
+
+ <entry>
+ <para>As does <literal>simple</literal> this also marks
the
+ usage of the index by creating a marker file, but this one is
+ using native OS file locks so that even if your application
+ crashes the locks will be cleaned up.</para>
+
+ <para>This implementation has known problems on NFS.</para>
+ </entry>
</row>
+
<row>
- <entry>none</entry>
- <entry>org.apache.lucene.store.NoLockFactory</entry>
- <entry>
- <para>All changes to this index are not coordinated by any lock; test
your application carefully
- and make sure you know what it means.</para>
- </entry>
+ <entry>single</entry>
+
+
<entry>org.apache.lucene.store.SingleInstanceLockFactory</entry>
+
+ <entry>
+ <para>This LockFactory doesn't use a file marker but is a Java
+ object lock held in memory; therefore it's possible to use it
+ only when you are sure the index is not going to be shared by
+ any other process.</para>
+
+ <para>This is the default implementation for
+ <literal>RAMDirectoryProvider</literal>.</para>
+ </entry>
</row>
- </tbody>
- </tgroup>
- </table>
-
- </para>Configuration example:
- <programlisting>hibernate.search.default.locking_strategy simple
+
+ <row>
+ <entry>none</entry>
+
+ <entry>org.apache.lucene.store.NoLockFactory</entry>
+
+ <entry>
+ <para>All changes to this index are not coordinated by any
+ lock; test your application carefully and make sure you know
+ what it means.</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table></para>
+
+ Configuration example:
+
+ <programlisting>hibernate.search.default.locking_strategy simple
hibernate.search.Animals.locking_strategy native
hibernate.search.Books.locking_strategy
org.custom.components.MyLockingFactory</programlisting>
- <para>
- </para>
-
+
+
+
+ <para />
+
+
</section>
-
</chapter>
Modified: search/trunk/src/main/docbook/en-US/modules/query.xml
===================================================================
--- search/trunk/src/main/docbook/en-US/modules/query.xml 2009-03-25 10:53:03 UTC (rev
16212)
+++ search/trunk/src/main/docbook/en-US/modules/query.xml 2009-03-25 11:44:54 UTC (rev
16213)
@@ -125,7 +125,7 @@
gives you total freedom on the type of Lucene query you want to execute.
However, once built, Hibernate Search wraps further query processing using
<classname>org.hibernate.Query</classname> as your primary query
- manipulation API. </para>
+ manipulation API.</para>
<section>
<title>Building a Lucene query</title>
@@ -173,7 +173,7 @@
<classname>Customer</classname> of the baseclass
<classname>Person</classname>, it is possible to just specify
<classname>Person.class</classname> in order to filter on result
- types. </para>
+ types.</para>
</section>
<section>
@@ -778,8 +778,6 @@
<para><informaltable align="left" width="">
<tgroup cols="2">
- <colspec align="center" />
-
<thead>
<row>
<entry align="center">Value</entry>