# Uses of Package
org.apache.lucene.search

Packages that use org.apache.lucene.search
Package | Description
--- | ---
org.apache.lucene.codecs | Codecs API: API for customization of the encoding and structure of the index.
org.apache.lucene.index | Code to maintain and access indices.
org.apache.lucene.search | Code to search indices.
org.apache.lucene.search.payloads | The payloads package provides Query mechanisms for finding and using payloads.
org.apache.lucene.search.similarities | This package contains the various ranking models that can be used in Lucene.
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.codecs
Class and Description
DocIdSetIterator This abstract class defines methods to iterate over a set of non-decreasing doc ids.

Classes in org.apache.lucene.search used by org.apache.lucene.index
Class and Description
DocIdSetIterator This abstract class defines methods to iterate over a set of non-decreasing doc ids.
Query The abstract base class for queries.
ReferenceManager Utility class to safely share instances of a certain type across multiple threads, while periodically refreshing them.

Classes in org.apache.lucene.search used by org.apache.lucene.search
Class and Description
AutomatonQuery A `Query` that will match terms against a finite-state machine.
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.
BoostAttribute Add this `Attribute` to a `TermsEnum` returned by `MultiTermQuery.getTermsEnum(Terms,AttributeSource)` and update the boost on each returned term.
CachingCollector Caches all docs, and optionally also scores, coming from a search, and is then able to replay them to another collector.
CollectionStatistics Contains statistics for a collection (field)
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.
DisjunctionMaxQuery A query that generates the union of documents produced by its subqueries, and that scores each document with the maximum score for that document as produced by any subquery, plus a tie breaking increment for any additional matching subqueries.
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.
DocTermOrdsRangeFilter A range filter built on top of a cached multi-valued term field (in `FieldCache`).
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.Bytes Field values as 8-bit signed bytes
FieldCache.CacheEntry EXPERT: A unique Identifier/Description for each item in the FieldCache.
FieldCache.DoubleParser Interface to parse doubles from document fields.
FieldCache.Doubles Field values as 64-bit doubles
FieldCache.FloatParser Interface to parse floats from document fields.
FieldCache.Floats Field values as 32-bit floats
FieldCache.IntParser Interface to parse ints from document fields.
FieldCache.Ints Field values as 32-bit signed integers
FieldCache.LongParser Interface to parse long from document fields.
FieldCache.Longs Field values as 64-bit signed long integers
FieldCache.Parser Marker interface as super-interface to all parsers.
FieldCache.ShortParser Interface to parse shorts from document fields.
FieldCache.Shorts Field values as 16-bit signed shorts
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`.
FieldComparator.NumericComparator Base FieldComparator class for numeric types
FieldComparatorSource Provides a `FieldComparator` for custom field sorting.
FieldDoc Expert: A ScoreDoc which also contains information about how to sort the referenced document.
FieldValueHitQueue Expert: A hit queue for sorting by hits by terms in more than one field.
FieldValueHitQueue.Entry Extension of ScoreDoc to also store the `FieldComparator` slot.
Filter Abstract base class for restricting which documents may be returned during searching.
FilteredDocIdSet Abstract decorator class for a DocIdSet implementation that provides on-demand filtering/validation mechanism on a given DocIdSet.
FilteredQuery.FilterStrategy Abstract class that defines how the filter (`DocIdSet`) applied during document collection.
FuzzyTermsEnum.LevenshteinAutomataAttribute reuses compiled automata across different segments, because they are independent of the index
IndexSearcher Implements search over a single IndexReader.
IndexSearcher.LeafSlice A class holding a subset of the `IndexSearcher`s leaf contexts to be executed within a single thread.
MaxNonCompetitiveBoostAttribute Add this `Attribute` to a fresh `AttributeSource` before calling `MultiTermQuery.getTermsEnum(Terms,AttributeSource)`.
MultiTermQuery An abstract `Query` that matches documents containing a subset of terms provided by a `FilteredTermsEnum` enumeration.
MultiTermQuery.RewriteMethod Abstract class that defines how the query is rewritten.
MultiTermQueryWrapperFilter A wrapper for `MultiTermQuery`, that exposes its functionality as a `Filter`.
NRTManager Utility class to manage sharing near-real-time searchers across multiple searching thread.
NRTManager.TrackingIndexWriter Class that tracks changes to a delegated IndexWriter.
NRTManager.WaitingListener NRTManager invokes this interface to notify it when a caller is waiting for a specific generation searcher to be visible.
NumericRangeFilter A `Filter` that only accepts numeric values within a specified range.
NumericRangeQuery A `Query` that matches numeric values within a specified range.
PhraseQuery A Query that matches documents containing a particular sequence of terms.
Query The abstract base class for queries.
ReferenceManager Utility class to safely share instances of a certain type across multiple threads, while periodically refreshing them.
ReferenceManager.RefreshListener Use to receive notification when a refresh has finished.
ScoreDoc Holds one hit in `TopDocs`.
Scorer Expert: Common scoring functionality for different types of queries.
Scorer.ChildScorer A child Scorer and its relationship to its parent.
ScoringRewrite Base rewrite method that translates each term into a query, and keeps the scores as computed by the query.
SearcherFactory Factory class used by `SearcherManager` and `NRTManager` to create new IndexSearchers.
SearcherLifetimeManager.Pruner See `SearcherLifetimeManager.prune(org.apache.lucene.search.SearcherLifetimeManager.Pruner)`.
Sort Encapsulates sort criteria for returned hits.
SortField Stores information about how to sort documents by terms in an individual field.
SortField.Type Specifies the type of the terms to be sorted, or special types such as CUSTOM
TermRangeFilter A Filter that restricts search results to a range of term values in a given field.
TermRangeQuery A Query that matches documents within an range of terms.
TermStatistics Contains statistics for a specific term
TimeLimitingCollector.TimerThread Thread used to timeout search requests.
TopDocs Represents hits returned by `IndexSearcher.search(Query,Filter,int)` and `IndexSearcher.search(Query,int)`.
TopDocsCollector A base class for all collectors that return a `TopDocs` output.
TopFieldCollector A `Collector` that sorts by `SortField` using `FieldComparator`s.
TopFieldDocs Represents hits returned by `IndexSearcher.search(Query,Filter,int,Sort)`.
TopScoreDocCollector A `Collector` implementation that collects the top-scoring hits, returning them as a `TopDocs`.
TopTermsRewrite Base rewrite method for collecting only the top terms via a priority queue.
Weight Expert: Calculate query weights and build query scorers.

Classes in org.apache.lucene.search used by org.apache.lucene.search.payloads
Class and Description
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.
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
Scorer Expert: Common scoring functionality for different types of queries.
Weight Expert: Calculate query weights and build query scorers.

Classes in org.apache.lucene.search used by org.apache.lucene.search.similarities
Class and Description
CollectionStatistics Contains statistics for a collection (field)
Explanation Expert: Describes the score computation for document and query.
TermStatistics Contains statistics for a specific term

Classes in org.apache.lucene.search used by org.apache.lucene.search.spans
Class and Description
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.
IndexSearcher Implements search over a single IndexReader.
MultiTermQuery An abstract `Query` that matches documents containing a subset of terms provided by a `FilteredTermsEnum` enumeration.
MultiTermQuery.RewriteMethod Abstract class that defines how the query is rewritten.
Query The abstract base class for queries.
Scorer Expert: Common scoring functionality for different types of queries.
Weight Expert: Calculate query weights and build query scorers.

Classes in org.apache.lucene.search used by org.apache.lucene.util
Class and Description
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.