## Uses of Package
org.apache.lucene.search

Packages that use org.apache.lucene.search
org.apache.lucene.benchmark.byTask: Benchmarking Lucene By Tasks.
org.apache.lucene.benchmark.byTask.feeds: Sources for benchmark inputs: documents and queries.
org.apache.lucene.benchmark.byTask.tasks: Extendable benchmark tasks.
org.apache.lucene.benchmark.quality: Search Quality Benchmarking.
org.apache.lucene.benchmark.quality.utils: Miscellaneous utilities for search quality benchmarking: query parsing, submission reports.
org.apache.lucene.demo: Demo applications for indexing and searching.
org.apache.lucene.facet.search: Faceted Search API
org.apache.lucene.facet.util: Various utilities for faceted search
org.apache.lucene.index: Code to maintain and access indices.
org.apache.lucene.index.memory: High-performance single-document main memory Apache Lucene fulltext search index.
org.apache.lucene.index.pruning: Static Index Pruning Tools
org.apache.lucene.misc: Miscellaneous index tools.
org.apache.lucene.queryParser: A simple query parser implemented with JavaCC.
org.apache.lucene.queryParser.analyzing: QueryParser that passes Fuzzy-, Prefix-, Range-, and WildcardQuerys through the given analyzer.
org.apache.lucene.queryParser.complexPhrase: QueryParser which permits complex phrase query syntax eg "(john jon jonathan~) peters*"
org.apache.lucene.queryParser.ext: Extendable QueryParser provides a simple and flexible extension mechanism by overloading query field names.
org.apache.lucene.queryParser.standard: Contains the implementation of the Lucene query parser using the flexible query parser frameworks
org.apache.lucene.queryParser.standard.builders: Standard Lucene Query Node Builders
org.apache.lucene.queryParser.standard.config: Standard Lucene Query Configuration
org.apache.lucene.queryParser.surround.query: This package contains SrndQuery and its subclasses.
org.apache.lucene.search: Code to search indices.
org.apache.lucene.search.function: Programmatic control over documents scores.
org.apache.lucene.search.grouping: This module enables search result grouping with Lucene, where hits with the same value in the specified single-valued group field are grouped together.
org.apache.lucene.search.highlight: The highlight package contains classes to provide "keyword in context" features typically used to highlight search terms in the text of results pages.
org.apache.lucene.search.join: This modules support index-time and query-time joins.
org.apache.lucene.search.payloads: The payloads package provides Query mechanisms for finding and using payloads.
org.apache.lucene.search.regex: Regular expression Query.
org.apache.lucene.search.similar: Document similarity query generators.
org.apache.lucene.search.spans: The calculus of spans.
org.apache.lucene.search.vectorhighlight: This is an another highlighter implementation.
org.apache.lucene.spatial.geohash: Support for Geohash encoding, decoding, and filtering.
org.apache.lucene.spatial.tier: Support for filtering based upon geographic location.
org.apache.lucene.store.instantiated: InstantiatedIndex, alternative RAM store for small corpora.
org.apache.lucene.util: Some utility classes.
org.apache.lucene.xmlparser: Parser that produces Lucene Query objects from XML streams.
org.apache.lucene.xmlparser.builders: Builders to support various Lucene queries.

Classes in org.apache.lucene.search used by org.apache.lucene.benchmark.byTask
IndexSearcher Implements search over a single IndexReader.

Classes in org.apache.lucene.search used by org.apache.lucene.benchmark.byTask.feeds
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.benchmark.byTask.tasks
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.
Query The abstract base class for queries.
Sort Encapsulates sort criteria for returned hits.

Classes in org.apache.lucene.search used by org.apache.lucene.benchmark.quality
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.benchmark.quality.utils
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
TopDocs Represents hits returned by `Searcher.search(Query,Filter,int)` and `Searcher.search(Query,int)`.

Classes in org.apache.lucene.search used by org.apache.lucene.demo
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.facet.search
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.
Query The abstract base class for queries.
Scorer Expert: Common scoring functionality for different types of queries.

Classes in org.apache.lucene.search used by org.apache.lucene.facet.util
DocIdSet A DocIdSet contains a set of doc ids.

Classes in org.apache.lucene.search used by org.apache.lucene.index
Filter Abstract base class for restricting which documents may be returned during searching.
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
Similarity Expert: Scoring API.

Classes in org.apache.lucene.search used by org.apache.lucene.index.memory
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.index.pruning
ScoreDoc Holds one hit in `TopDocs`.
Similarity Expert: Scoring API.

Classes in org.apache.lucene.search used by org.apache.lucene.misc
DefaultSimilarity Expert: Default scoring implementation.
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.queryParser.analyzing
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.queryParser.complexPhrase
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.queryParser.ext
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.queryParser.standard
BooleanClause A clause in a BooleanQuery.
BooleanClause.Occur Specifies how clauses are to occur in matching documents.
MultiTermQuery.RewriteMethod Abstract class that defines how the query is rewritten.
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.queryParser.standard.builders
BooleanQuery A Query that matches documents matching boolean combinations of other queries, e.g.
FuzzyQuery Implements the fuzzy search query.
MatchAllDocsQuery A query that matches all documents.
MultiPhraseQuery MultiPhraseQuery is a generalized version of PhraseQuery, with an added method `MultiPhraseQuery.add(Term[])`.
NumericRangeQuery A `Query` that matches numeric values within a specified range.
PhraseQuery A Query that matches documents containing a particular sequence of terms.
PrefixQuery A Query that matches documents containing terms with a specified prefix.
Query The abstract base class for queries.
TermQuery A Query that matches documents containing a term.
TermRangeQuery A Query that matches documents within an range of terms.
WildcardQuery Implements the wildcard search query.

Classes in org.apache.lucene.search used by org.apache.lucene.queryParser.standard.config
MultiTermQuery.RewriteMethod Abstract class that defines how the query is rewritten.

Classes in org.apache.lucene.search used by org.apache.lucene.queryParser.surround.query
Query The abstract base class for queries.
TermQuery A Query that matches documents containing a term.

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.
CachingCollector Caches all docs, and optionally also scores, coming from a search, and is then able to replay them to another collector.
CachingWrapperFilter Wraps another filter's result and caches it.
CachingWrapperFilter.DeletesMode Expert: Specifies how new deletions against a reopened reader should be handled.
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`.
FieldComparator.NumericComparator
FieldComparatorSource Provides a `FieldComparator` for custom field sorting.
FieldValueHitQueue Expert: A hit queue for sorting by hits by terms in more than one field.
FieldValueHitQueue.Entry
Filter Abstract base class for restricting which documents may be returned during searching.
FilterClause A Filter that wrapped with an indication of how that filter is used when composed with another filter.
FilteredTermEnum Abstract class for enumerating a subset of all terms.
FilterManager Deprecated. used by remote package which is deprecated as well. You should use `CachingWrapperFilter` if you wish to cache `Filter`s.
FilterManager.FilterCleaner Deprecated. Keeps the cache from getting too big.
FilterManager.FilterItem Deprecated. Holds the filter and the last time the filter was used, to make LRU-based cache cleaning possible.
IndexSearcher Implements search over a single IndexReader.
MultiSearcher Deprecated. If you are using MultiSearcher over IndexSearchers, please use MultiReader instead; this class does not properly handle certain kinds of queries (see LUCENE-2756).
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`.
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.
RMIRemoteSearchable Deprecated. This package (all of contrib/remote) will be removed in 4.0.
ScoreDoc Holds one hit in `TopDocs`.
Scorer Expert: Common scoring functionality for different types of queries.
Scorer.ScorerVisitor A callback to gather information from a scorer and its sub-scorers.
ScoringRewrite
Searchable Deprecated. In 4.0 this interface is removed/absorbed into IndexSearcher
Searcher Deprecated. In 4.0 this abstract class is removed/absorbed into IndexSearcher
SearcherFactory Factory class used by `SearcherManager` and `NRTManager` to create new IndexSearchers.
SearcherLifetimeManager.Pruner See `SearcherLifetimeManager.prune(org.apache.lucene.search.SearcherLifetimeManager.Pruner)`.
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.
TimeLimitingCollector.TimerThread
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 `FieldComparator`s.
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`.
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.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 Deprecated. In 4.0 this abstract class is removed/absorbed into IndexSearcher
Weight Expert: Calculate query weights and build query scorers.

Classes in org.apache.lucene.search used by org.apache.lucene.search.grouping
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.
Filter Abstract base class for restricting which documents may be returned during searching.
ScoreDoc Holds one hit in `TopDocs`.
Scorer Expert: Common scoring functionality for different types of queries.
Sort Encapsulates sort criteria for returned hits.
SortField Stores information about how to sort documents by terms in an individual field.
TopDocsCollector A base class for all collectors that return a `TopDocs` output.

Classes in org.apache.lucene.search used by org.apache.lucene.search.highlight
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.search.join
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.
Filter Abstract base class for restricting which documents may be returned during searching.
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
Scorer Expert: Common scoring functionality for different types of queries.
Searcher Deprecated. In 4.0 this abstract class is removed/absorbed into IndexSearcher
Sort Encapsulates sort criteria for returned hits.
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 Deprecated. In 4.0 this abstract class is removed/absorbed into IndexSearcher
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.regex
FilteredTermEnum Abstract class for enumerating a subset of all terms.
MultiTermQuery An abstract `Query` that matches documents containing a subset of terms provided by a `FilteredTermEnum` enumeration.
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.search.similar
Query The abstract base class for queries.
Similarity Expert: Scoring API.

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.
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.
Query The abstract base class for queries.
Scorer Expert: Common scoring functionality for different types of queries.
Searcher Deprecated. In 4.0 this abstract class is removed/absorbed into IndexSearcher
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.vectorhighlight
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.spatial.geohash
DocIdSet A DocIdSet contains a set of doc ids.
Filter Abstract base class for restricting which documents may be returned during searching.

Classes in org.apache.lucene.search used by org.apache.lucene.spatial.tier
DocIdSet A DocIdSet contains a set of doc ids.
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.
Filter Abstract base class for restricting which documents may be returned during searching.
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.store.instantiated
Similarity Expert: Scoring API.

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.
IndexSearcher Implements search over a single IndexReader.
Scorer Expert: Common scoring functionality for different types of queries.
TopDocs Represents hits returned by `Searcher.search(Query,Filter,int)` and `Searcher.search(Query,int)`.

Classes in org.apache.lucene.search used by org.apache.lucene.xmlparser
Filter Abstract base class for restricting which documents may be returned during searching.
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.xmlparser.builders
Filter Abstract base class for restricting which documents may be returned during searching.
Query The abstract base class for queries.