Uses of Package
org.apache.lucene.search

Packages that use org.apache.lucene.search

Package	Description
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.classification	Uses already seen data (the indexed documents) to classify an input ( can be simple text or a structured document).
org.apache.lucene.classification.document	Uses already seen data (the indexed documents) to classify new documents.
org.apache.lucene.classification.utils	Utilities for evaluation, data preparation, etc.
org.apache.lucene.demo	Demo applications for indexing and searching.
org.apache.lucene.demo.facet	Facets example code.
org.apache.lucene.document	The logical representation of a Document for indexing and searching.
org.apache.lucene.expressions	Expressions.
org.apache.lucene.facet	Faceted search.
org.apache.lucene.facet.range	Provides range faceting capabilities.
org.apache.lucene.facet.taxonomy	Taxonomy of Categories.
org.apache.lucene.geo	Geospatial Utility Implementations for Lucene Core
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.payloads	Experimental classes for interacting with payloads
org.apache.lucene.queries	Filters and Queries that add to core Lucene.
org.apache.lucene.queries.function	Queries that compute score based upon a function.
org.apache.lucene.queries.function.valuesource	A variety of functions to use with FunctionQuery.
org.apache.lucene.queries.mlt	Document similarity query generators.
org.apache.lucene.queries.payloads	The payloads package provides Query mechanisms for finding and using payloads.
org.apache.lucene.queryparser.classic	A simple query parser implemented with JavaCC.
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.flexible.standard	Implementation of the Lucene classic query parser using the flexible query parser frameworks
org.apache.lucene.queryparser.flexible.standard.builders	Standard Lucene Query Node Builders.
org.apache.lucene.queryparser.flexible.standard.config	Standard Lucene Query Configuration.
org.apache.lucene.queryparser.simple	A simple query parser for human-entered queries.
org.apache.lucene.queryparser.surround.query	This package contains SrndQuery and its subclasses.
org.apache.lucene.queryparser.xml	Parser that produces Lucene Query objects from XML streams.
org.apache.lucene.queryparser.xml.builders	XML Parser factories for different Lucene Query/Filters.
org.apache.lucene.replicator.nrt	Near-real-time replication framework
org.apache.lucene.sandbox.queries	Additional queries (some may have caveats or limitations)
org.apache.lucene.search	Code to search indices.
org.apache.lucene.search.grouping	Grouping.
org.apache.lucene.search.highlight	Highlighting search terms.
org.apache.lucene.search.intervals	Intervals queries
org.apache.lucene.search.join	Support for index-time and query-time joins.
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.search.suggest	Support for Autocomplete/Autosuggest
org.apache.lucene.search.suggest.analyzing	Analyzer based autosuggest.
org.apache.lucene.search.suggest.document	Support for document suggestion
org.apache.lucene.search.uhighlight	The UnifiedHighlighter -- a flexible highlighter that can get offsets from postings, term vectors, or analysis.
org.apache.lucene.search.vectorhighlight	Another highlighter implementation based on term vectors.
org.apache.lucene.spatial	Lucene spatial search
org.apache.lucene.spatial.bbox	Bounding Box Spatial Strategy
org.apache.lucene.spatial.composite	Composite strategies.
org.apache.lucene.spatial.prefix	Prefix Tree Strategy.
org.apache.lucene.spatial.serialized	Strategies that serialize the shape (non-indexed).
org.apache.lucene.spatial.util	Various spatial utilities.
org.apache.lucene.spatial.vector	Spatial strategy that uses two fields.
org.apache.lucene.spatial3d	Lucene field & query support for the spatial geometry implemented in org.apache.lucene.spatial3d.geom.
org.apache.lucene.util	Some utility classes.

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

Class and Description
IndexSearcher Implements search over a single IndexReader.

Classes in org.apache.lucene.search used by org.apache.lucene.benchmark.byTask.feeds

Class and Description
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.benchmark.byTask.tasks

Class and Description
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.
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
Sort Encapsulates sort criteria for returned hits.
TopDocs Represents hits returned by IndexSearcher.search(Query,int).

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

Class and Description
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

Class and Description
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
TopDocs Represents hits returned by IndexSearcher.search(Query,int).

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

Class and Description
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
TopDocs Represents hits returned by IndexSearcher.search(Query,int).

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

Class and Description
Query The abstract base class for queries.

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

Class and Description
Query The abstract base class for queries.

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

Class and Description
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.demo.facet

Class and Description
Query The abstract base class for queries.
TopDocs Represents hits returned by IndexSearcher.search(Query,int).

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

Class and Description
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
SortField Stores information about how to sort documents by terms in an individual field.
TopFieldDocs Represents hits returned by IndexSearcher.search(Query,int,Sort).

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

Class and Description
DoubleValues Per-segment, per-document double values, which can be calculated at search-time
DoubleValuesSource Base class for producing DoubleValues To obtain a DoubleValues object for a leaf reader, clients should call DoubleValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then call DoubleValuesSource.getValues(LeafReaderContext, DoubleValues) on the resulting DoubleValuesSource.
Rescorer Re-scores the topN results (TopDocs) from an original query.
SortField Stores information about how to sort documents by terms in an individual field.

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

Class and Description
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.
CollectorManager A manager of collectors.
DocIdSet A DocIdSet contains a set of doc ids.
FieldDoc Expert: A ScoreDoc which also contains information about how to sort the referenced document.
IndexSearcher Implements search over a single IndexReader.
LeafCollector Collector decouples the score from the collected doc: the score computation is skipped entirely if it's not needed.
LongValuesSource Base class for producing LongValues To obtain a LongValues object for a leaf reader, clients should call LongValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then LongValuesSource.getValues(LeafReaderContext, DoubleValues).
Query The abstract base class for queries.
ScoreDoc Holds one hit in TopDocs.
Scorer Expert: Common scoring functionality for different types of queries.
SimpleCollector Base Collector implementation that is used to collect all contexts.
Sort Encapsulates sort criteria for returned hits.
TermInSetQuery Specialization for a disjunction over many terms that behaves like a ConstantScoreQuery over a BooleanQuery containing only BooleanClause.Occur.SHOULD clauses.
TermQuery A Query that matches documents containing a term.
TopDocs Represents hits returned by IndexSearcher.search(Query,int).
TopFieldDocs Represents hits returned by IndexSearcher.search(Query,int,Sort).

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

Class and Description
DoubleValuesSource Base class for producing DoubleValues To obtain a DoubleValues object for a leaf reader, clients should call DoubleValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then call DoubleValuesSource.getValues(LeafReaderContext, DoubleValues) on the resulting DoubleValuesSource.
LongValuesSource Base class for producing LongValues To obtain a LongValues object for a leaf reader, clients should call LongValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then LongValuesSource.getValues(LeafReaderContext, DoubleValues).
Query The abstract base class for queries.

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

Class and Description
DoubleValuesSource Base class for producing DoubleValues To obtain a DoubleValues object for a leaf reader, clients should call DoubleValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then call DoubleValuesSource.getValues(LeafReaderContext, DoubleValues) on the resulting DoubleValuesSource.
IndexSearcher Implements search over a single IndexReader.
ReferenceManager Utility class to safely share instances of a certain type across multiple threads, while periodically refreshing them.
SearcherFactory Factory class used by SearcherManager to create new IndexSearchers.

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

Class and Description
Query The abstract base class for queries.

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.
IndexSearcher Implements search over a single IndexReader.
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.
Sort Encapsulates sort criteria for returned hits.

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

Class and Description
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.payloads

Class and Description
Query The abstract base class for queries.

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

Class and Description
BooleanClause.Occur Specifies how clauses are to occur in matching documents.
Explanation Expert: Describes the score computation for document and query.
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
Weight Expert: Calculate query weights and build query scorers.

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

Class and Description
DocIdSetIterator This abstract class defines methods to iterate over a set of non-decreasing doc ids.
DoubleValuesSource Base class for producing DoubleValues To obtain a DoubleValues object for a leaf reader, clients should call DoubleValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then call DoubleValuesSource.getValues(LeafReaderContext, DoubleValues) on the resulting DoubleValuesSource.
Explanation Expert: Describes the score computation for document and query.
IndexSearcher Implements search over a single IndexReader.
LongValuesSource Base class for producing LongValues To obtain a LongValues object for a leaf reader, clients should call LongValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then LongValuesSource.getValues(LeafReaderContext, DoubleValues).
Query The abstract base class for queries.
Scorer Expert: Common scoring functionality for different types of queries.
SegmentCacheable Interface defining whether or not an object can be cached against a LeafReader Objects that depend only on segment-immutable structures such as Points or postings lists can just return true from SegmentCacheable.isCacheable(LeafReaderContext) Objects that depend on doc values should return DocValues.isCacheable(LeafReaderContext, String...), which will check to see if the doc values fields have been updated.
SortField Stores information about how to sort documents by terms in an individual field.
TwoPhaseIterator Returned by Scorer.twoPhaseIterator() to expose an approximation of a DocIdSetIterator.
Weight Expert: Calculate query weights and build query scorers.

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

Class and Description
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
SortedNumericSelector.Type Type of selection to perform.
SortedSetSelector.Type Type of selection to perform.
SortField Stores information about how to sort documents by terms in an individual field.

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

Class and Description
Query The abstract base class for queries.

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

Class and Description
Explanation Expert: Describes the score computation for document and query.
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
SegmentCacheable Interface defining whether or not an object can be cached against a LeafReader Objects that depend only on segment-immutable structures such as Points or postings lists can just return true from SegmentCacheable.isCacheable(LeafReaderContext) Objects that depend on doc values should return DocValues.isCacheable(LeafReaderContext, String...), which will check to see if the doc values fields have been updated.
Weight Expert: Calculate query weights and build query scorers.

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

Class and Description
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.complexPhrase

Class and Description
Query The abstract base class for queries.

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

Class and Description
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.flexible.standard

Class and Description
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.flexible.standard.builders

Class and Description
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.
MatchNoDocsQuery A query that matches no documents.
MultiPhraseQuery A generalized version of PhraseQuery, with the possibility of adding more than one term at the same position that are treated as a disjunction (OR).
PrefixQuery A Query that matches documents containing terms with a specified prefix.
Query The abstract base class for queries.
RegexpQuery A fast regular expression query based on the org.apache.lucene.util.automaton package.
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.flexible.standard.config

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

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

Class and Description
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.
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.surround.query

Class and Description
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.queryparser.xml

Class and Description
Query The abstract base class for queries.

Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.xml.builders

Class and Description
Query The abstract base class for queries.

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

Class and Description
IndexSearcher Implements search over a single IndexReader.
ReferenceManager Utility class to safely share instances of a certain type across multiple threads, while periodically refreshing them.
SearcherFactory Factory class used by SearcherManager to create new IndexSearchers.

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

Class and Description
Query The abstract base class for queries.

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.
BaseRangeFieldQueryTestCase.Range base class for range verification
BaseRangeFieldQueryTestCase.Range.QueryType supported query relations
BlendedTermQuery A Query that blends index statistics across multiple terms.
BlendedTermQuery.Builder A Builder for BlendedTermQuery.
BlendedTermQuery.RewriteMethod A BlendedTermQuery.RewriteMethod defines how queries for individual terms should be merged.
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.
BooleanQuery.Builder A builder for boolean queries.
BoostAttribute Add this Attribute to a TermsEnum returned by MultiTermQuery.getTermsEnum(Terms,AttributeSource) and update the boost on each returned term.
BulkScorer This class is used to score a range of documents at once, and is returned by Weight.bulkScorer(org.apache.lucene.index.LeafReaderContext).
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.
CollectorManager A manager of collectors.
DisiPriorityQueue A priority queue of DocIdSetIterators that orders by current doc ID.
DisiWrapper Wrapper used in DisiPriorityQueue.
DiversifiedTopDocsCollector.ScoreDocKey An extension to ScoreDoc that includes a key used for grouping purposes
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.
DocValuesStats Holds statistics for a DocValues field.
DocValuesStats.NumericDocValuesStats Holds statistics for a numeric DocValues field.
DocValuesStats.SortedNumericDocValuesStats Holds statistics for a sorted-numeric DocValues field.
DoubleValues Per-segment, per-document double values, which can be calculated at search-time
DoubleValuesSource Base class for producing DoubleValues To obtain a DoubleValues object for a leaf reader, clients should call DoubleValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then call DoubleValuesSource.getValues(LeafReaderContext, DoubleValues) on the resulting DoubleValuesSource.
Explanation Expert: Describes the score computation for document and query.
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.
FilterCollector Collector delegator.
FilterScorer A FilterScorer contains another Scorer, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.
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 IndexSearchers leaf contexts to be executed within a single thread.
LeafCollector Collector decouples the score from the collected doc: the score computation is skipped entirely if it's not needed.
LeafFieldComparator Expert: comparator that gets instantiated on each leaf from a top-level FieldComparator instance.
LongValues Per-segment, per-document long values, which can be calculated at search-time
LongValuesSource Base class for producing LongValues To obtain a LongValues object for a leaf reader, clients should call LongValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then LongValuesSource.getValues(LeafReaderContext, DoubleValues).
Matches Reports the positions and optionally offsets of all matching terms in a query for a single document To obtain a MatchesIterator for a particular field, call Matches.getMatches(String).
MatchesIterator An iterator over match positions (and optionally offsets) for a single document and field To iterate over the matches, call MatchesIterator.next() until it returns false, retrieving positions and/or offsets after each call.
MaxNonCompetitiveBoostAttribute Add this Attribute to a fresh AttributeSource before calling MultiTermQuery.getTermsEnum(Terms,AttributeSource).
MultiCollectorManager.Collectors
MultiPhraseQuery A generalized version of PhraseQuery, with the possibility of adding more than one term at the same position that are treated as a disjunction (OR).
MultiPhraseQuery.Builder A builder for multi-phrase queries
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.
PhraseQuery A Query that matches documents containing a particular sequence of terms.
PhraseQuery.Builder A builder for phrase queries.
PointInSetQuery.Stream Iterator of encoded point values.
Query The abstract base class for queries.
QueryCache A cache for queries.
QueryCachingPolicy A policy defining which filters should be cached.
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.
Rescorer Re-scores the topN results (TopDocs) from an original query.
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.
ScorerSupplier A supplier of Scorer.
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 to create new IndexSearchers.
SearcherLifetimeManager Keeps track of current plus old IndexSearchers, closing the old ones once they have timed out.
SearcherLifetimeManager.Pruner See SearcherLifetimeManager.prune(org.apache.lucene.search.SearcherLifetimeManager.Pruner).
SearcherManager Utility class to safely share IndexSearcher instances across multiple threads, while periodically reopening.
SegmentCacheable Interface defining whether or not an object can be cached against a LeafReader Objects that depend only on segment-immutable structures such as Points or postings lists can just return true from SegmentCacheable.isCacheable(LeafReaderContext) Objects that depend on doc values should return DocValues.isCacheable(LeafReaderContext, String...), which will check to see if the doc values fields have been updated.
ShardSearchingTestBase.NodeState
ShardSearchingTestBase.NodeState.ShardIndexSearcher Matches docs in the local shard but scores based on aggregated stats ("mock distributed scoring") from all nodes.
SimpleCollector Base Collector implementation that is used to collect all contexts.
SimpleFieldComparator Base FieldComparator implementation that is used for all contexts.
Sort Encapsulates sort criteria for returned hits.
SortedNumericSelector.Type Type of selection to perform.
SortedSetSelector.Type Type of selection to perform.
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
TermAutomatonQuery A proximity query that lets you express an automaton, whose transitions are terms, to match documents.
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,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 IndexSearcher.search(Query,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.
TwoPhaseIterator Returned by Scorer.twoPhaseIterator() to expose an approximation of a DocIdSetIterator.
Weight Expert: Calculate query weights and build query scorers.

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

Class and Description
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.
IndexSearcher Implements search over a single IndexReader.
LeafCollector Collector decouples the score from the collected doc: the score computation is skipped entirely if it's not needed.
Query The abstract base class for queries.
ScoreDoc Holds one hit in TopDocs.
Scorer Expert: Common scoring functionality for different types of queries.
SimpleCollector Base Collector implementation that is used to collect all contexts.
Sort Encapsulates sort criteria for returned hits.
SortField Stores information about how to sort documents by terms in an individual field.
Weight Expert: Calculate query weights and build query scorers.

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

Class and Description
Query The abstract base class for queries.

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

Class and Description
DocIdSetIterator This abstract class defines methods to iterate over a set of non-decreasing doc ids.
IndexSearcher Implements search over a single IndexReader.
MatchesIterator An iterator over match positions (and optionally offsets) for a single document and field To iterate over the matches, call MatchesIterator.next() until it returns false, retrieving positions and/or offsets after each call.
Query The abstract base class for queries.
Weight Expert: Calculate query weights and build query scorers.

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

Class and Description
DocIdSetIterator This abstract class defines methods to iterate over a set of non-decreasing doc ids.
FieldComparator Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top results with TopFieldCollector.
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
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
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.
Matches Reports the positions and optionally offsets of all matching terms in a query for a single document To obtain a MatchesIterator for a particular field, call Matches.getMatches(String).
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.
SegmentCacheable Interface defining whether or not an object can be cached against a LeafReader Objects that depend only on segment-immutable structures such as Points or postings lists can just return true from SegmentCacheable.isCacheable(LeafReaderContext) Objects that depend on doc values should return DocValues.isCacheable(LeafReaderContext, String...), which will check to see if the doc values fields have been updated.
TwoPhaseIterator Returned by Scorer.twoPhaseIterator() to expose an approximation of a DocIdSetIterator.
Weight Expert: Calculate query weights and build query scorers.

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

Class and Description
BooleanQuery A Query that matches documents matching boolean combinations of other queries, e.g.
LongValuesSource Base class for producing LongValues To obtain a LongValues object for a leaf reader, clients should call LongValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then LongValuesSource.getValues(LeafReaderContext, DoubleValues).

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

Class and Description
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.
BooleanQuery.Builder A builder for boolean queries.
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
SearcherManager Utility class to safely share IndexSearcher instances across multiple threads, while periodically reopening.
TopFieldDocs Represents hits returned by IndexSearcher.search(Query,int,Sort).

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

Class and Description
BulkScorer This class is used to score a range of documents at once, and is returned by Weight.bulkScorer(org.apache.lucene.index.LeafReaderContext).
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.
Explanation Expert: Describes the score computation for document and query.
IndexSearcher Implements search over a single IndexReader.
LeafCollector Collector decouples the score from the collected doc: the score computation is skipped entirely if it's not needed.
Query The abstract base class for queries.
ScoreDoc Holds one hit in TopDocs.
Scorer Expert: Common scoring functionality for different types of queries.
SegmentCacheable Interface defining whether or not an object can be cached against a LeafReader Objects that depend only on segment-immutable structures such as Points or postings lists can just return true from SegmentCacheable.isCacheable(LeafReaderContext) Objects that depend on doc values should return DocValues.isCacheable(LeafReaderContext, String...), which will check to see if the doc values fields have been updated.
SimpleCollector Base Collector implementation that is used to collect all contexts.
TopDocs Represents hits returned by IndexSearcher.search(Query,int).
Weight Expert: Calculate query weights and build query scorers.

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

Class and Description
DocIdSetIterator This abstract class defines methods to iterate over a set of non-decreasing doc ids.
IndexSearcher Implements search over a single IndexReader.
MatchesIterator An iterator over match positions (and optionally offsets) for a single document and field To iterate over the matches, call MatchesIterator.next() until it returns false, retrieving positions and/or offsets after each call.
Query The abstract base class for queries.
TopDocs Represents hits returned by IndexSearcher.search(Query,int).

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

Class and Description
Query The abstract base class for queries.

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

Class and Description
DoubleValuesSource Base class for producing DoubleValues To obtain a DoubleValues object for a leaf reader, clients should call DoubleValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then call DoubleValuesSource.getValues(LeafReaderContext, DoubleValues) on the resulting DoubleValuesSource.
Query The abstract base class for queries.
SegmentCacheable Interface defining whether or not an object can be cached against a LeafReader Objects that depend only on segment-immutable structures such as Points or postings lists can just return true from SegmentCacheable.isCacheable(LeafReaderContext) Objects that depend on doc values should return DocValues.isCacheable(LeafReaderContext, String...), which will check to see if the doc values fields have been updated.

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

Class and Description
DoubleValues Per-segment, per-document double values, which can be calculated at search-time
DoubleValuesSource Base class for producing DoubleValues To obtain a DoubleValues object for a leaf reader, clients should call DoubleValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then call DoubleValuesSource.getValues(LeafReaderContext, DoubleValues) on the resulting DoubleValuesSource.
Explanation Expert: Describes the score computation for document and query.
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
SegmentCacheable Interface defining whether or not an object can be cached against a LeafReader Objects that depend only on segment-immutable structures such as Points or postings lists can just return true from SegmentCacheable.isCacheable(LeafReaderContext) Objects that depend on doc values should return DocValues.isCacheable(LeafReaderContext, String...), which will check to see if the doc values fields have been updated.

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

Class and Description
DoubleValuesSource Base class for producing DoubleValues To obtain a DoubleValues object for a leaf reader, clients should call DoubleValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then call DoubleValuesSource.getValues(LeafReaderContext, DoubleValues) on the resulting DoubleValuesSource.
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
Weight Expert: Calculate query weights and build query scorers.

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

Class and Description
DocIdSet A DocIdSet contains a set of doc ids.
DoubleValuesSource Base class for producing DoubleValues To obtain a DoubleValues object for a leaf reader, clients should call DoubleValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then call DoubleValuesSource.getValues(LeafReaderContext, DoubleValues) on the resulting DoubleValuesSource.
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
Weight Expert: Calculate query weights and build query scorers.

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

Class and Description
DoubleValuesSource Base class for producing DoubleValues To obtain a DoubleValues object for a leaf reader, clients should call DoubleValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then call DoubleValuesSource.getValues(LeafReaderContext, DoubleValues) on the resulting DoubleValuesSource.
Query The abstract base class for queries.

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

Class and Description
DocIdSetIterator This abstract class defines methods to iterate over a set of non-decreasing doc ids.
DoubleValues Per-segment, per-document double values, which can be calculated at search-time
DoubleValuesSource Base class for producing DoubleValues To obtain a DoubleValues object for a leaf reader, clients should call DoubleValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then call DoubleValuesSource.getValues(LeafReaderContext, DoubleValues) on the resulting DoubleValuesSource.
Explanation Expert: Describes the score computation for document and query.
IndexSearcher Implements search over a single IndexReader.
SegmentCacheable Interface defining whether or not an object can be cached against a LeafReader Objects that depend only on segment-immutable structures such as Points or postings lists can just return true from SegmentCacheable.isCacheable(LeafReaderContext) Objects that depend on doc values should return DocValues.isCacheable(LeafReaderContext, String...), which will check to see if the doc values fields have been updated.
TwoPhaseIterator Returned by Scorer.twoPhaseIterator() to expose an approximation of a DocIdSetIterator.

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

Class and Description
DoubleValues Per-segment, per-document double values, which can be calculated at search-time
DoubleValuesSource Base class for producing DoubleValues To obtain a DoubleValues object for a leaf reader, clients should call DoubleValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then call DoubleValuesSource.getValues(LeafReaderContext, DoubleValues) on the resulting DoubleValuesSource.
IndexSearcher Implements search over a single IndexReader.
Query The abstract base class for queries.
SegmentCacheable Interface defining whether or not an object can be cached against a LeafReader Objects that depend only on segment-immutable structures such as Points or postings lists can just return true from SegmentCacheable.isCacheable(LeafReaderContext) Objects that depend on doc values should return DocValues.isCacheable(LeafReaderContext, String...), which will check to see if the doc values fields have been updated.

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

Class and Description
Query The abstract base class for queries.
SortField Stores information about how to sort documents by terms in an individual field.

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

Class and Description
BooleanClause.Occur Specifies how clauses are to occur in matching documents.
BooleanQuery.Builder A builder for boolean queries.
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.
IndexSearcher Implements search over a single IndexReader.
MultiPhraseQuery.Builder A builder for multi-phrase queries
Query The abstract base class for queries.
QueryCachingPolicy A policy defining which filters should be cached.
TopDocs Represents hits returned by IndexSearcher.search(Query,int).