Apache Lucene

An Analyzer builds TokenStreams, which analyze text.

BitVector

Optimized implementation of a vector of bits.

BooleanClause

A clause in a BooleanQuery.

BooleanClause.Occur

Specifies how terms may occur in matching documents.

BooleanQuery

A Query that matches documents matching boolean combinations of other queries, e.g.

BufferedIndexInput

Base implementation class for buffered IndexInput .

BufferedIndexOutput

Base implementation class for buffered IndexOutput .

CachingWrapperFilter

Wraps another filter's result and caches it.

CharTokenizer

An abstract base class for simple, character-oriented tokenizers.

Constants

Some useful constants.

ConstantScoreQuery

ConstantScoreQuery.ConstantScorer

A query that wraps a filter and simply returns a constant score equal to the query boost for every document in the filter.

ConstantScoreQuery.ConstantWeight

No description provided.

No description provided.

ConstantScoreRangeQuery

A range query that returns a constant score equal to its boost for all documents in the range.

DateField

Provides support for converting dates to strings and vice-versa.

DateTools

Provides support for converting dates to strings and vice-versa.

DateTools.Resolution

Specifies the time granularity.

DefaultSimilarity

Expert: Default scoring implementation.

Directory

A Directory is a flat list of files.

DisjunctionMaxQuery

A query that generates the union of the documents produced by its subqueries, and that scores each document as the maximum score for that document produced by any subquery plus a tie breaking increment for any additional matching subqueries.

Document

Documents are the unit of indexing and search.

Explanation

Expert: Describes the score computation for document and query.

FastCharStream

An efficient implementation of JavaCC's CharStream interface.

FastCharStream

An efficient implementation of JavaCC's CharStream interface.

Field

A field is a section of a Document.

Field.Index

Specifies whether and how a field should be indexed.

Field.Store

Specifies whether and how a field should be stored.

Field.TermVector

Specifies whether and how a field should have term vectors.

FieldCache.StringIndex

Expert: Stores term text values and document ordering data.

FieldDoc

Expert: A ScoreDoc which also contains information about how to sort the referenced document.

FieldSortedHitQueue

Expert: A hit queue for sorting by hits by terms in more than one field.

Filter

Abstract base class providing a mechanism to restrict searches to a subset of an index.

FilteredQuery

A query that applies a filter to the results of another query.

FilteredTermEnum

Abstract class for enumerating a subset of all terms.

FilterIndexReader

FilterIndexReader.FilterTermDocs

A FilterIndexReader contains another IndexReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.

FilterIndexReader.FilterTermEnum

Base class for filtering TermDocs implementations.

FilterIndexReader.FilterTermPositions

Base class for filtering TermEnum implementations.

Base class for filtering TermPositions implementations.

FSDirectory

Straightforward implementation of Directory as a directory of files.

FuzzyQuery

Implements the fuzzy search query.

FuzzyTermEnum

Subclass of FilteredTermEnum for enumerating all terms that are similiar to the specified filter term.

Hit

Wrapper used by HitIterator to provide a lazily loaded hit from Hits .

HitCollector

Lower-level search API.

HitIterator

An iterator over Hits that provides lazy fetching of each document.

Hits

A ranked list of documents, used to hold search results.

IndexFileNameFilter

Filename filter that accept filenames and extensions only created by Lucene.

IndexInput

Abstract base class for input from a file in a Directory .

IndexModifier

A class to modify an index, i.e.

IndexOutput

Abstract base class for output to a file in a Directory.

IndexReader

IndexReader is an abstract class, providing an interface for accessing an index.

IndexReader.FieldOption

No description provided.

IndexSearcher

Implements search over a single IndexReader.

IndexWriter

An IndexWriter creates and maintains an index.

ISOLatin1AccentFilter

A filter that replaces accented characters in the ISO Latin 1 character set (ISO-8859-1) by their unaccented equivalent.

KeywordAnalyzer

"Tokenizes" the entire stream as a single token.

KeywordTokenizer

Emits the entire input as a single token.

LengthFilter

Removes words that are too long and too short from the stream.

LetterTokenizer

A LetterTokenizer is a tokenizer that divides text at non-letters.

Lock

An interprocess mutex lock.

Lock.With

Utility class for executing code with exclusive access.

LowerCaseFilter

Normalizes token text to lower case.

LowerCaseTokenizer

LowerCaseTokenizer performs the function of LetterTokenizer and LowerCaseFilter together.

LucenePackage

org.apache.lucene

Lucene's package information, including version.

MatchAllDocsQuery

A query that matches all documents.

MMapDirectory

File-based Directory implementation that uses mmap for input.

MultiFieldQueryParser

A QueryParser which constructs queries to search multiple fields.

MultiPhraseQuery

MultiPhraseQuery is a generalized version of PhraseQuery, with an added method add(Term[]) .

MultipleTermPositions

Describe class MultipleTermPositions here.

MultiReader

An IndexReader which reads multiple indexes, appending their content.

MultiSearcher

Implements search over a set of Searchables.

MultiTermQuery

A Query that matches documents containing a subset of terms provided by a FilteredTermEnum enumeration.

NumberTools

Provides support for converting longs to Strings, and back again.

ParallelMultiSearcher

Implements parallel search over a set of Searchables.

ParallelReader

An IndexReader which reads multiple, parallel indexes.

Parameter

A serializable Enum class.

PerFieldAnalyzerWrapper

This analyzer is used to facilitate scenarios where different fields require different analysis techniques.

PhraseQuery

A Query that matches documents containing a particular sequence of terms.

PorterStemFilter

Transforms the token stream as per the Porter stemming algorithm.

PrefixQuery

A Query that matches documents containing terms with a specified prefix.

PriorityQueue

A PriorityQueue maintains a partial ordering of its elements such that the least element can always be found in constant time.

Query

The abstract base class for queries.

QueryFilter

Constrains search results to only match those which also match a provided query.

QueryParser

This class is generated by JavaCC.

QueryParser.Operator

The default operator for parsing queries.

QueryParserTokenManager

No description provided.

QueryTermVector

No description provided.

RAMDirectory

A memory-resident Directory implementation.

RAMOutputStream

A memory-resident IndexOutput implementation.

RangeFilter

A Filter that restricts search results to a range of values in a given field.

RangeQuery

A Query that matches documents within an exclusive range.

RemoteSearchable

A remote searchable implementation.

ReqExclScorer

A Scorer for queries with a required subscorer and an excluding (prohibited) subscorer.

ReqOptSumScorer

A Scorer for queries with a required part and an optional part.

ScoreDoc

Expert: Returned by low-level search implementations.

Scorer

Expert: Common scoring functionality for different types of queries.

Searcher

SegmentTermPositionVector

An abstract base class for search implementations.

Similarity

Expert: Scoring API.

SimilarityDelegator

Expert: Delegating scoring implementation.

SimpleAnalyzer

An Analyzer that filters LetterTokenizer with LowerCaseFilter.

SmallFloat

Floating point numbers smaller than 32 bits.

Sort

Encapsulates sort criteria for returned hits.

SortComparator

Abstract base class for sorting hits returned by a Query.

SortField

Stores information about how to sort documents by terms in an individual field.

SpanFirstQuery

Matches spans near the beginning of a field.

SpanNearQuery

Matches spans which are near one another.

SpanNotQuery

Removes matches which overlap with another SpanQuery.

SpanOrQuery

Matches the union of its clauses.

SpanQuery

Base class for span-based queries.

SpanTermQuery

Matches spans containing a term.

StandardAnalyzer

Filters StandardTokenizer with StandardFilter , LowerCaseFilter and StopFilter , using a list of English stop words.

StandardFilter

Normalizes tokens extracted with StandardTokenizer .

StandardTokenizer

StandardTokenizerTokenManager

A grammar-based tokenizer constructed with JavaCC.

No description provided.

StopAnalyzer

Filters LetterTokenizer with LowerCaseFilter and StopFilter.

StopFilter

Removes stop words from a token stream.

StringHelper

Methods for manipulating strings.

Term

A Term represents a word from text.

TermEnum

Abstract class for enumerating terms.

TermQuery

A Query that matches documents containing a term.

TermVectorOffsetInfo

Token

Describes the input token stream.

Token

A Token is an occurence of a term from the text of a field.

Token

Describes the input token stream.

TokenFilter

A TokenFilter is a TokenStream whose input is another token stream.

Tokenizer

A Tokenizer is a TokenStream whose input is a Reader.

TokenStream

A TokenStream enumerates the sequence of tokens, either from fields of a document or from query text.

TopDocCollector

A HitCollector implementation that collects the top-scoring documents, returning them as a TopDocs .

TopDocs

Expert: Returned by low-level search implementations.

TopFieldDocCollector

A HitCollector implementation that collects the top-sorting documents, returning them as a TopFieldDocs .

TopFieldDocs

Expert: Returned by low-level sorted search implementations.

ToStringUtils

WhitespaceAnalyzer

An Analyzer that uses WhitespaceTokenizer.

WhitespaceTokenizer

A WhitespaceTokenizer is a tokenizer that divides text at whitespace.

WildcardQuery

Implements the wildcard search query.

WildcardTermEnum

Subclass of FilteredTermEnum for enumerating all terms that match the specified wildcard filter term.

WordlistLoader