5:32 a.m.
Author: hardy.ferentschik
Date: 2008-10-21 06:32:12 -0400 (Tue, 21 Oct 2008)
New Revision: 15360
Modified:
search/trunk/doc/reference/en/modules/configuration.xml
search/trunk/doc/reference/en/modules/mapping.xml
search/trunk/lib/README.txt
Log:
HSEARCH-252 - reviewed and modified existing documentation. Also updated README.txt
Modified: search/trunk/doc/reference/en/modules/configuration.xml
===================================================================
--- search/trunk/doc/reference/en/modules/configuration.xml 2008-10-20 17:57:44 UTC (rev
15359)
+++ search/trunk/doc/reference/en/modules/configuration.xml 2008-10-21 10:32:12 UTC (rev
15360)
@@ -557,13 +557,13 @@
</listitem>
<listitem>
- <para><filename>lucene-core-*.jar</filename>: Lucene core
+ <para><filename>lucene-core.jar</filename>: Lucene core
engine</para>
</listitem>
<listitem>
- <para><filename>solr-*.jar</filename>: Additional analyzer
- infrastructure</para>
+ <para><filename>solr-core.jar</filename>, solr-common.jar:
+ Additional analyzer infrastructure</para>
</listitem>
</itemizedlist>
</section>
Modified: search/trunk/doc/reference/en/modules/mapping.xml
===================================================================
--- search/trunk/doc/reference/en/modules/mapping.xml 2008-10-20 17:57:44 UTC (rev 15359)
+++ search/trunk/doc/reference/en/modules/mapping.xml 2008-10-21 10:32:12 UTC (rev 15360)
@@ -261,7 +261,7 @@
</section>
<section id="search-mapping-associated">
- <title>Embedded and associated objects </title>
+ <title>Embedded and associated objects</title>
<para>Associated objects as well as embedded objects can be indexed as
part of the root entity index. It is necessary if you expect to search a
@@ -526,15 +526,14 @@
<section id="analyzer">
<title>Analyzer</title>
- <para>The default analyzer class used to index the elements is
+ <para>The default analyzer class used to index tokenized fields is
configurable through the <literal>hibernate.search.analyzer</literal>
- property. If none is defined,
-
<classname>org.apache.lucene.analysis.standard.StandardAnalyzer</classname>
- is used as the default.</para>
+ property. The default value for this property is
+
<classname>org.apache.lucene.analysis.standard.StandardAnalyzer</classname>.</para>
- <para>You can also define the analyzer class per entity, per property
- and even per @Field (useful when multiple fields are indexed from a
- single property).</para>
+ <para>You can also define the analyzer class per entity, property and
+ even per @Field (useful when multiple fields are indexed from a single
+ property).</para>
<programlisting>@Entity
@Indexed
@@ -558,8 +557,8 @@
...
}</programlisting>
- <para>In this example, <classname>EntityAnalyzer</classname> is
used
- index all tokenized properties (eg. <literal>name</literal>), except
for
+ <para>In this example, <classname>EntityAnalyzer</classname> is
used to
+ index all tokenized properties (eg. <literal>name</literal>), except
<literal>summary</literal> and <literal>body</literal>
which are indexed
with <classname>PropertyAnalyzer</classname> and
<classname>FieldAnalyzer</classname> respectively.</para>
@@ -569,17 +568,18 @@
time a bad practice. It makes query building more complex and results
less predictable (for the novice), especially if you are using a
QueryParser (which uses the same analyzer for the whole query). As a
- thumb rule, the same analyzer should be used for both the indexing and
- the query for a given field.</para>
+ rule of thumb, for any given field the same analyzer should be used
+ for indexing and querying.</para>
</caution>
<section>
<title>Analyzer definitions</title>
- <para>Analyzers can become quite complex to deal with. Hibernate
- Search introduces the notion of analyzer definition. An analyzer
- definition can be reused by many <classname>@Analyzer</classname>
- declarations. An analyzer definition is composed of:</para>
+ <para>Analyzers can become quite complex to deal with for which reason
+ Hibernate Search introduces the notion of analyzer definitions. An
+ analyzer definition can be reused by many
+ <classname>@Analyzer</classname> declarations. An analyzer
definition
+ is composed of:</para>
<itemizedlist>
<listitem>
@@ -588,25 +588,31 @@
</listitem>
<listitem>
- <para>a tokenizer: a piece of code used to chunk the sentence into
- individual words</para>
+ <para>a tokenizer: responsible for tokenizing the input stream
+ into individual words</para>
</listitem>
<listitem>
- <para>a list of filters: each filter is responsible to remove
- words, modify words and sometimes add words into the stream
- provided by the tokenizer</para>
+ <para>a list of filters: each filter is responsible to remove,
+ modify or sometimes even add words into the stream provided by the
+ tokenizer</para>
</listitem>
</itemizedlist>
- <para>This separation of tasks (tokenizer, list of filters) allows
- reuse of each individual component and let you build your ideal
- analyzer ns a very flexible way (just like a lego). This
- infrastructure is supported by the Solr analyzer framework. Make sure
- to add <filename>solr-*.jar</filename> to your classpath to use
- analyzer definitions: this jar is distributed with your distribution
- of Hibernate Search and is a striped down version of the Solr
- jar.</para>
+ <para>This separation of tasks - a tokenizer followed by a list of
+ filters - allows easy reuse of each individual component and let you
+ build your customized analyzer in a very flexible way (just like
+ lego). Generally speaking the <classname>Tokenizer</classname>
starts
+ the analysis process by turning the character input into tokens which
+ are then further processed by the
<classname>TokenFilter</classname>s.
+ Hibernate Search supports this infrastructure by utilizing the Solr
+ analyzer framework. Make sure to add<filename> solr-core.jar and
+ </filename><filename>solr-common.jar</filename> to your
classpath to
+ use analyzer definitions. In case you also want to utilizing a
+ snowball stemmer also include the
+ <filename>solr-lucene-snowball.jar.</filename> Your distribution of
+ Hibernate Search provides these dependecies in its
+ <filename>lib</filename> directory.</para>
<programlisting>@AnalyzerDef(name="customanalyzer",
tokenizer = @TokenizerDef(factory = StandardTokenizerFactory.class),
Modified: search/trunk/lib/README.txt
===================================================================
--- search/trunk/lib/README.txt 2008-10-20 17:57:44 UTC (rev 15359)
+++ search/trunk/lib/README.txt 2008-10-21 10:32:12 UTC (rev 15360)
@@ -4,16 +4,17 @@
Core
====
hibernate-commons-annotations.jar: required
-hibernate-core.jar: required
-hibernate core dependencies: required (see Hibernate Core for more information)
-lucene-core-*.jar: required (used version 2.3.2)
-jta.jar: required
-jms.jar: optional (needed for JMS based clustering strategy, usually available with your
application server)
-jsr-250-api.jar: optional (needed for JMS based clustering strategy, usually available
with your application server)
-apache-solr-analyzer.jar: optional (used version 1.2.0), needed if @AnalyzerDef is used
-slf4j-api: required (a slf4j-[impl].ar is required too - eg. slf4j-log4j12.jar)
+hibernate-core.jar: required + hibernate core dependencies - see Hibernate Core for more
information
+lucene-core.jar: required (used version 2.4.0)
+jta.jar: required
+slf4j-api: required together with a slf4j-[impl].jar eg slf4j-log4j12.jar
+jms.jar: optional, needed for JMS based clustering strategy, usually available with your
application server
+jsr-250-api.jar: optional, needed for JMS based clustering strategy, usually available
with your application server
+solr-core.jar, solr-common.jar: optional (used version 1.3.0), needed if @AnalyzerDef is
used
+solr-lucenen-snowball.jar: optional, needed if snowball stemmer is used
+
Test
====
hibernate-annotations.jar: required
-hibernate-entitymanager.jar: required
\ No newline at end of file
+hibernate-entitymanager.jar: required