Apache > Lucene
Powered by Lucid Imagination

- Main
- Wiki
- Lucene 3.4 Documentation

# Apache Lucene - Lucene Contrib

- Lucene Contrib
  - analyzers
  - benchmark
  - demo
  - facet
  - grouping
  - highlighter
  - icu
  - instantiated
  - join
  - memory
  - misc
  - queryparser
  - queries
  - remote
  - spatial
  - spellchecker
  - xml-query-parser

## Lucene Contrib

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:

- Various third party contributions.
- Contributions with third party dependencies - the Lucene Java core distribution has no external runtime dependencies.
- New ideas that are intended for eventual inclusion into the Lucene Java core.

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 http://wiki.apache.org/lucene-java/BackwardsCompatibility) 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.

See Contrib CHANGES for changes included in the current release.

You can access the current trunk Contrib repository at http://svn.apache.org/repos/asf/lucene/dev/trunk/lucene/contrib/.

### analyzers

Contributed Analyzers, Tokenizers, and Filters for various uses and languages.

See analyzers javadoc

### benchmark

The benchmark contribution contains tools for benchmarking Lucene using standard, freely available corpora.

See benchmark javadoc

### demo

The demo contrib contains the Lucene demo: IndexFiles and SearchFiles, described under Getting Started.

See demo javadoc

### facet

Provides faceted indexing and search capabilities

See facet javadoc

### grouping

Groups search results according to a specified field

See grouping javadoc

### highlighter

A set of classes for highlighting matching terms in search results.

See highlighter javadoc

### icu

Provides integration with ICU (International Components for Unicode) for stronger Unicode and internationalization support.

See icu javadoc

### instantiated

RAM-based index that enables much faster searching than RAMDirectory in certain situations.

See instantiated javadoc

### join

Enables joining of parent and child documents when indexed as a doc block

See join javadoc

### memory

High-performance single-document main memory index.

See memory javadoc

### misc

A variety of miscellaneous files, including QueryParsers, and other alternate Lucene class implementations and tools.

See misc javadoc

### queryparser

A new Lucene query parser implementation, which matches the syntax of the core QueryParser but offers a more modular architecture to enable customization.

See queryparser javadoc

### queries

Additional queries for Lucene.

See queries javadoc

### remote

Classes to help use Lucene with RMI.

See remote javadoc

### spatial

Classes to help with efficient distance based sorting.

See spatial javadoc

### spellchecker

Provides tools for spellchecking and suggestions with Lucene.

See spellchecker javadoc

### xml-query-parser

A QueryParser that can read queries written in an XML format.

See xml-query-parser javadoc