Uses of Package
org.apache.lucene.search

Packages that use org.apache.lucene.search

org.apache.lucene.index	Code to maintain and access indices.
org.apache.lucene.queryParser	A simple query parser implemented with JavaCC.
org.apache.lucene.search	Code to search indices.
org.apache.lucene.search.function	Programmatic control over documents scores.
org.apache.lucene.search.payloads	The payloads package provides Query mechanisms for finding and using payloads.
org.apache.lucene.search.spans	The calculus of spans.
org.apache.lucene.util	Some utility classes.

Classes in org.apache.lucene.search used by org.apache.lucene.index

Query
The abstract base class for queries.

Similarity
Expert: Scoring API.

Classes in org.apache.lucene.search used by org.apache.lucene.queryParser

BooleanClause
A clause in a BooleanQuery.

BooleanClause.Occur
Specifies how clauses are to occur in matching documents.

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

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

MultiTermQuery.RewriteMethod
Abstract class that defines how the query is rewritten.

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

Query
The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.search

BooleanClause
A clause in a BooleanQuery.

BooleanClause.Occur
Specifies how clauses are to occur in matching documents.

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

Collector
Expert: Collectors are primarily meant to be used to gather raw results from a search, and implement sorting or custom result filtering, collation, etc.

DocIdSet
A DocIdSet contains a set of doc ids.

DocIdSetIterator
This abstract class defines methods to iterate over a set of non-decreasing doc ids.

Explanation
Expert: Describes the score computation for document and query.

Explanation.IDFExplanation
Small Util class used to pass both an idf factor as well as an explanation for that factor.

FieldCache
Expert: Maintains caches of term values.

FieldCache.ByteParser
Interface to parse bytes from document fields.

FieldCache.CacheEntry
EXPERT: A unique Identifier/Description for each item in the FieldCache.

FieldCache.DoubleParser
Interface to parse doubles from document fields.

FieldCache.FloatParser
Interface to parse floats from document fields.

FieldCache.IntParser
Interface to parse ints from document fields.

FieldCache.LongParser
Interface to parse long from document fields.

FieldCache.Parser
Marker interface as super-interface to all parsers.

FieldCache.ShortParser
Interface to parse shorts from document fields.

FieldCache.StringIndex
Expert: Stores term text values and document ordering data.

FieldCacheRangeFilter
A range filter built on top of a cached single term field (in FieldCache).

FieldComparator
Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top results with TopFieldCollector.

FieldComparatorSource
Provides a FieldComparator for custom field sorting.

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

Filter
Abstract base class for restricting which documents may be returned during searching.

FilteredTermEnum
Abstract class for enumerating a subset of all terms.

FilterManager
Filter caching singleton.

FilterManager.FilterCleaner
Keeps the cache from getting too big.

FilterManager.FilterItem
Holds the filter and the last time the filter was used, to make LRU-based cache cleaning possible.

MultiSearcher
Implements search over a set of Searchables.

MultiTermQuery
An abstract Query that matches documents containing a subset of terms provided by a FilteredTermEnum enumeration.

MultiTermQuery.RewriteMethod
Abstract class that defines how the query is rewritten.

MultiTermQueryWrapperFilter
A wrapper for MultiTermQuery, that exposes its functionality as a Filter.

NumericRangeFilter
A Filter that only accepts numeric values within a specified range.

NumericRangeQuery
A Query that matches numeric values within a specified range.

Query
The abstract base class for queries.

ScoreDoc
Expert: Returned by low-level search implementations.

Scorer
Expert: Common scoring functionality for different types of queries.

Searchable
The interface for search implementations.

Searcher
An abstract base class for search implementations.

Similarity
Expert: Scoring API.

Sort
Encapsulates sort criteria for returned hits.

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

SpanFilter
Abstract base class providing a mechanism to restrict searches to a subset of an index and also maintains and returns position information.

SpanFilterResult
The results of a SpanQueryFilter.

SpanFilterResult.PositionInfo

SpanFilterResult.StartEnd

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

TopDocs
Represents hits returned by Searcher.search(Query,Filter,int) and Searcher.search(Query,int).

TopDocsCollector
A base class for all collectors that return a TopDocs output.

TopFieldCollector
A Collector that sorts by SortField using FieldComparators.

TopFieldDocs
Represents hits returned by Searcher.search(Query,Filter,int,Sort).

TopScoreDocCollector
A Collector implementation that collects the top-scoring hits, returning them as a TopDocs.

Weight
Expert: Calculate query weights and build query scorers.

Classes in org.apache.lucene.search used by org.apache.lucene.search.function

Explanation
Expert: Describes the score computation for document and query.

FieldCache
Expert: Maintains caches of term values.

FieldCache.ByteParser
Interface to parse bytes from document fields.

FieldCache.FloatParser
Interface to parse floats from document fields.

FieldCache.IntParser
Interface to parse ints from document fields.

FieldCache.ShortParser
Interface to parse shorts from document fields.

Query
The abstract base class for queries.

Searcher
An abstract base class for search implementations.

Weight
Expert: Calculate query weights and build query scorers.

Classes in org.apache.lucene.search used by org.apache.lucene.search.payloads

DocIdSetIterator
This abstract class defines methods to iterate over a set of non-decreasing doc ids.

Explanation
Expert: Describes the score computation for document and query.

Query
The abstract base class for queries.

Scorer
Expert: Common scoring functionality for different types of queries.

Searcher
An abstract base class for search implementations.

Similarity
Expert: Scoring API.

Weight
Expert: Calculate query weights and build query scorers.

Classes in org.apache.lucene.search used by org.apache.lucene.search.spans

DocIdSetIterator
This abstract class defines methods to iterate over a set of non-decreasing doc ids.

Explanation
Expert: Describes the score computation for document and query.

Query
The abstract base class for queries.

Scorer
Expert: Common scoring functionality for different types of queries.

Searcher
An abstract base class for search implementations.

Similarity
Expert: Scoring API.

Weight
Expert: Calculate query weights and build query scorers.

Classes in org.apache.lucene.search used by org.apache.lucene.util

DocIdSet
A DocIdSet contains a set of doc ids.

DocIdSetIterator
This abstract class defines methods to iterate over a set of non-decreasing doc ids.

FieldCache
Expert: Maintains caches of term values.

FieldCache.CacheEntry
EXPERT: A unique Identifier/Description for each item in the FieldCache.

Scorer
Expert: Common scoring functionality for different types of queries.