| <?xml version="1.0"?> |
| <document> |
| <header> |
| <title> |
| Apache Lucene - Lucene Contrib |
| </title> |
| </header> |
| <body> |
| |
| <section id="Contrib"><title>Lucene Contrib</title> |
| <p> |
| The Lucene Java project also contains a workspace, Lucene Contrib |
| (formerly known as the Lucene Sandbox), that is open both to all Lucene |
| Java core committers and to developers whose commit rights are |
| restricted to the Contrib workspace; these developers are referred to |
| as "Contrib committers". The Lucene Contrib workspace hosts the |
| following types of packages: |
| </p> |
| <ul> |
| <li>Various third party contributions.</li> |
| <li> |
| Contributions with third party dependencies - the Lucene Java core |
| distribution has no external runtime dependencies. |
| </li> |
| <li> |
| New ideas that are intended for eventual inclusion into the Lucene |
| Java core. |
| </li> |
| </ul> |
| <p> |
| Users are free to experiment with the components developed in the |
| Contrib workspace, but Contrib packages will not necessarily be |
| maintained, particularly in their current state. The Lucene Java core |
| backwards compatibility commitments (see |
| <a href="http://wiki.apache.org/lucene-java/BackwardsCompatibility" |
| >http://wiki.apache.org/lucene-java/BackwardsCompatibility</a>) |
| do not necessarily extend to the packages in the Contrib workspace. |
| See the README.txt file for each Contrib package for details. If the |
| README.txt file does not address its backwards compatibility |
| commitments, users should assume it does not make any compatibility |
| commitments. |
| </p> |
| <p> |
| See <a href="../changes/Contrib-Changes.html">Contrib CHANGES</a> for changes included in the current release. |
| </p> |
| |
| |
| <p> |
| You can access the current trunk Contrib repository at |
| <a href="http://svn.apache.org/repos/asf/lucene/dev/trunk/lucene/contrib/">http://svn.apache.org/repos/asf/lucene/dev/trunk/lucene/contrib/</a>. |
| </p> |
| |
| <section id="analyzers"><title>analyzers</title> |
| <p>Contributed Analyzers, Tokenizers, and Filters for various uses and languages.</p> |
| <p>See <a href="../api/contrib-analyzers/index.html">analyzers javadoc</a></p> |
| </section> |
| |
| <section id="benchmark"><title>benchmark</title> |
| <p>The benchmark contribution contains tools for benchmarking Lucene using standard, freely available corpora.</p> |
| <p>See <a href="../api/contrib-benchmark/index.html">benchmark javadoc</a></p> |
| </section> |
| |
| <section id="demo"><title>demo</title> |
| <p>The demo contrib contains the Lucene demo: IndexFiles and SearchFiles, described under |
| <a href="../gettingstarted.html">Getting Started</a>.</p> |
| <p>See <a href="../api/contrib-demo/index.html">demo javadoc</a></p> |
| </section> |
| |
| <section id="facet"><title>facet</title> |
| <p>Provides faceted indexing and search capabilities</p> |
| <p>See <a href="../api/contrib-facet/index.html">grouping javadoc</a></p> |
| </section> |
| |
| <section id="grouping"><title>grouping</title> |
| <p>Groups search results according to a specified field</p> |
| <p>See <a href="../api/contrib-grouping/index.html">grouping javadoc</a></p> |
| </section> |
| |
| <section id="highlighter"><title>highlighter</title> |
| <p>A set of classes for highlighting matching terms in search results.</p> |
| <p>See <a href="../api/contrib-highlighter/index.html">highlighter javadoc</a></p> |
| </section> |
| |
| <section id="icu"><title>icu</title> |
| <p>Provides integration with ICU (International Components for Unicode) for |
| stronger Unicode and internationalization support. </p> |
| <p>See <a href="../api/contrib-icu/index.html">icu javadoc</a></p> |
| </section> |
| |
| <section id="instantiated"><title>instantiated</title> |
| <p>RAM-based index that enables much faster searching than RAMDirectory in certain situations.</p> |
| <p>See <a href="../api/contrib-instantiated/index.html">instantiated javadoc</a></p> |
| </section> |
| |
| <section id="join"><title>join</title> |
| <p>Enables joining of parent and child documents when indexed as a doc block</p> |
| <p>See <a href="../api/contrib-join/index.html">join javadoc</a></p> |
| </section> |
| |
| <section id="memory"><title>memory</title> |
| <p>High-performance single-document main memory index.</p> |
| <p>See <a href="../api/contrib-memory/index.html">memory javadoc</a></p> |
| </section> |
| |
| <section id="misc"><title>misc</title> |
| <p>A variety of miscellaneous files, including QueryParsers, and other alternate Lucene class implementations and tools.</p> |
| <p>See <a href="../api/contrib-misc/index.html">misc javadoc</a></p> |
| </section> |
| |
| <section id="queryparser"><title>queryparser</title> |
| <p>A new Lucene query parser implementation, which matches the syntax of the core QueryParser but offers a more modular architecture to enable customization.</p> |
| <p>See <a href="../api/contrib-queryparser/index.html">queryparser javadoc</a></p> |
| </section> |
| |
| <section id="queries"><title>queries</title> |
| <p>Additional queries for Lucene.</p> |
| <p>See <a href="../api/contrib-queries/index.html">queries javadoc</a></p> |
| </section> |
| |
| <section id="remote"><title>remote</title> |
| <p>Classes to help use Lucene with RMI.</p> |
| <p>See <a href="../api/contrib-remote/index.html">remote javadoc</a></p> |
| </section> |
| |
| <section id="spatial"><title>spatial</title> |
| <p>Classes to help with efficient distance based sorting.</p> |
| <p>See <a href="../api/contrib-spatial/index.html">spatial javadoc</a></p> |
| </section> |
| |
| <section id="spellchecker"><title>spellchecker</title> |
| <p>Provides tools for spellchecking and suggestions with Lucene.</p> |
| <p>See <a href="../api/contrib-spellchecker/index.html">spellchecker javadoc</a></p> |
| </section> |
| |
| <section id="xml-query-parser"><title>xml-query-parser</title> |
| <p>A QueryParser that can read queries written in an XML format.</p> |
| <p>See <a href="../api/contrib-xml-query-parser/index.html">xml-query-parser javadoc</a></p> |
| </section> |
| |
| </section> |
| </body> |
| </document> |
