2:05 p.m.
Author: hardy.ferentschik
Date: 2008-11-12 08:05:39 -0500 (Wed, 12 Nov 2008)
New Revision: 15552
Modified:
search/trunk/doc/reference/en/master.xml
search/trunk/doc/reference/en/modules/getting-started.xml
search/trunk/doc/reference/en/modules/mapping.xml
search/trunk/ivy.xml
Log:
some doc updates regarding Solr analyzers, moved the solr analyzer dependencies into the
test scope of ivy.xml
Modified: search/trunk/doc/reference/en/master.xml
===================================================================
--- search/trunk/doc/reference/en/master.xml 2008-11-12 12:28:54 UTC (rev 15551)
+++ search/trunk/doc/reference/en/master.xml 2008-11-12 13:05:39 UTC (rev 15552)
@@ -24,7 +24,7 @@
~ Boston, MA 02110-1301 USA
-->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
- <!ENTITY versionNumber "3.1.0.Beta2">
+ <!ENTITY versionNumber "3.1.0.CR1">
<!ENTITY copyrightYear "2004">
<!ENTITY copyrightHolder "Red Hat Middleware, LLC.">
]>
@@ -77,4 +77,4 @@
<xi:include href="modules/optimize.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="modules/lucene-native.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
-</book>
\ No newline at end of file
+</book>
Modified: search/trunk/doc/reference/en/modules/getting-started.xml
===================================================================
--- search/trunk/doc/reference/en/modules/getting-started.xml 2008-11-12 12:28:54 UTC (rev
15551)
+++ search/trunk/doc/reference/en/modules/getting-started.xml 2008-11-12 13:05:39 UTC (rev
15552)
@@ -481,11 +481,16 @@
either specify the fully qualified classname of the analyzer to use or one
can refer to an analyzer definition defined by the
<literal>@AnalyzerDef</literal> annotation. In the latter case the Solr
- analyzer framework with its factories approach can be used. To find out
+ analyzer framework with its factories approach is utilized. To find out
more about the factory classes available you can either browse the Solr
JavaDoc or read the corresponding section on the <ulink
url="http://wiki.apache.org/solr/AnalyzersTokenizersTokenFilters&quo...
- Wiki.</ulink> In the example a
+ Wiki.</ulink> Note that depending on the chosen factory class additional
+ libraries on top of the Solr dependencies might be required. For example,
+ the <classname>PhoneticFilterFactory</classname> depends on <ulink
+ url="http://commons.apache.org/codec">commons-codec</ulin...;.
</para>
+
+ <para>In the example below a
<classname>StandardTokenizerFactory</classname> is used followed by two
filter factories, <classname>LowerCaseFilterFactory</classname> and
<classname>SnowballPorterFilterFactory</classname>. The standard
tokenizer
Modified: search/trunk/doc/reference/en/modules/mapping.xml
===================================================================
--- search/trunk/doc/reference/en/modules/mapping.xml 2008-11-12 12:28:54 UTC (rev 15551)
+++ search/trunk/doc/reference/en/modules/mapping.xml 2008-11-12 13:05:39 UTC (rev 15552)
@@ -623,8 +623,11 @@
</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>lucene-snowball.jar.</filename> Your distribution of
- Hibernate Search provides these dependecies in its
+ <filename>lucene-snowball.jar.</filename> Other Solr analyzers might
+ depend on more libraries. For example, the
+ <classname>PhoneticFilterFactory</classname> depends on <ulink
+ url="http://commons.apache.org/codec">commons-codec</ulin...;.
Your
+ distribution of Hibernate Search provides these dependecies in its
<filename>lib</filename> directory.</para>
<programlisting>@AnalyzerDef(name="customanalyzer",
@@ -993,9 +996,10 @@
bridge. To do so you need to implements the
<literal>org.hibernate.search.bridge.StringBridge</literal>
interface.</para>
- <para>All implementations have to be thread-safe as they
- are used concurrently.</para>
+ <para>All implementations have to be thread-safe as they are used
+ concurrently.</para>
+
<programlisting>/**
* Padding Integer bridge.
* All numbers will be padded with 0 to match 5 digits
@@ -1065,9 +1069,10 @@
<classname>TwoWayStringBridge</classname> ,
<classname>FieldBridge</classname> implementations (see
bellow).</para>
+
<para>All implementations have to be thread-safe, but the parameters
- are set during initialization and no special care is required at
- this stage.</para>
+ are set during initialization and no special care is required at this
+ stage.</para>
<para>If you expect to use your bridge implementation on for an id
property (ie annotated with <literal>@DocumentId</literal> ), you
need
Modified: search/trunk/ivy.xml
===================================================================
--- search/trunk/ivy.xml 2008-11-12 12:28:54 UTC (rev 15551)
+++ search/trunk/ivy.xml 2008-11-12 13:05:39 UTC (rev 15552)
@@ -20,9 +20,6 @@
<dependency org="org.hibernate" name="hibernate-core"
rev="3.3.1.GA" conf="default->default"/>
<dependency org="javax.transaction" name="jta"
rev="1.1" conf="default->default"/>
<dependency org="org.apache.lucene" name="lucene-core"
rev="2.4.0" conf="default->default"/>
- <dependency org="org.apache.lucene" name="lucene-snowball"
rev="2.4.0" conf="default->default"/>
- <dependency org="org.apache.lucene"
name="lucene-analyzers" rev="2.4.0"
conf="default->default"/> <!-- optional -->
- <dependency org="org.apache.commons" name="commons-codec"
rev="1.3" conf="default->default"/> <!-- optional -->
<dependency org="javax.jms" name="jms" rev="1.1"
conf="default->default"/> <!-- optional -->
<dependency org="javax.annotation" name="jsr250-api"
rev="1.0" conf="default->default"/> <!-- optional -->
<dependency org="org.apache.solr" name="solr-core"
rev="1.3.0" conf="default->default"/> <!-- optional -->
@@ -36,6 +33,9 @@
<!-- test deps -->
<dependency name="annotations" rev="3.4.0.GA"
conf="test->default"/>
<dependency name="entitymanager" rev="3.4.0.GA"
conf="test->default"/>
+ <dependency org="org.apache.lucene" name="lucene-snowball"
rev="2.4.0" conf="test->default"/>
+ <dependency org="org.apache.lucene"
name="lucene-analyzers" rev="2.4.0"
conf="test->default"/>
+ <dependency org="org.apache.commons" name="commons-codec"
rev="1.3" conf="test->default"/>
<dependency org="cglib" name="cglib" rev="2.1_3"
conf="test->default"/>
<dependency org="asm" name="asm" rev="1.5.3"
conf="test->default"/>
<dependency org="asm" name="asm-attrs"
rev="1.5.3" conf="test->default"/>