Uses of Package
org.apache.lucene.search
-
Packages that use org.apache.lucene.search Package Description org.apache.lucene.analysis.boost Provides various convenience classes for creating boosts on Tokens.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.codecs.compressing StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.org.apache.lucene.codecs.idversion A primary-key postings format that associates a version (long) with each term and can provide fail-fast lookups by ID and version.org.apache.lucene.codecs.lucene50 Components from the Lucene 5.0 index format Seeorg.apache.lucene.codecs.lucene80
for an overview of the index format.org.apache.lucene.codecs.lucene70 Components from the Lucene 7.0 index format.org.apache.lucene.codecs.lucene80 Components from the Lucene 8.0 index format Seeorg.apache.lucene.codecs.lucene84
for an overview of the index format.org.apache.lucene.codecs.lucene84 Components from the Lucene 8.4 index format.org.apache.lucene.codecs.memory Term dictionary, DocValues or Postings formats that are read entirely into memory.org.apache.lucene.codecs.simpletext Simpletext Codec: writes human readable postings.org.apache.lucene.codecs.uniformsplit.sharedterms Pluggable term index / block terms dictionary implementations.org.apache.lucene.document The logical representation of aDocument
for indexing and searching.org.apache.lucene.expressions Expressions.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.monitor Monitoring frameworkorg.apache.lucene.payloads Experimental classes for interacting with payloadsorg.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.docvalues FunctionValues for different data types.org.apache.lucene.queries.function.valuesource A variety of functions to use with FunctionQuery.org.apache.lucene.queries.intervals Intervals queriesorg.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 frameworksorg.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.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.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.similarity Misc similarity implementations.org.apache.lucene.search.spans The calculus of spans.org.apache.lucene.search.spell Suggest alternate spellings for words.org.apache.lucene.search.suggest Support for Autocomplete/Autosuggestorg.apache.lucene.search.suggest.analyzing Analyzer based autosuggest.org.apache.lucene.search.suggest.document Support for document suggestionorg.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.util Some utility classes.org.apache.lucene.util.automaton Finite-state automaton for regular expressions.org.apache.lucene.util.bkd Block KD-tree, implementing the generic spatial data structure described in this paper. -
Classes in org.apache.lucene.search used by org.apache.lucene.analysis.boost Class Description BoostAttribute Add thisAttribute
to aTermsEnum
returned byMultiTermQuery.getTermsEnum(Terms,AttributeSource)
and update the boost on each returned term. -
Classes in org.apache.lucene.search used by org.apache.lucene.classification Class Description IndexSearcher Implements search over a single IndexReader.Query The abstract base class for queries.TopDocs Represents hits returned byIndexSearcher.search(Query,int)
. -
Classes in org.apache.lucene.search used by org.apache.lucene.classification.document Class Description Query The abstract base class for queries.TopDocs Represents hits returned byIndexSearcher.search(Query,int)
. -
Classes in org.apache.lucene.search used by org.apache.lucene.classification.utils Class Description Query The abstract base class for queries.QueryVisitor Allows recursion through a query treeScoreDoc Holds one hit inTopDocs
. -
Classes in org.apache.lucene.search used by org.apache.lucene.codecs.compressing Class 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.codecs.idversion Class 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.codecs.lucene50 Class 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.codecs.lucene70 Class 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.codecs.lucene80 Class 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.codecs.lucene84 Class 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.codecs.memory Class 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.codecs.simpletext Class 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.codecs.uniformsplit.sharedterms Class 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.document Class 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-timeDoubleValuesSource Base class for producingDoubleValues
To obtain aDoubleValues
object for a leaf reader, clients should callDoubleValuesSource.rewrite(IndexSearcher)
against the top-level searcher, and then callDoubleValuesSource.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 withTopFieldCollector
.IndexSearcher Implements search over a single IndexReader.LeafFieldComparator Expert: comparator that gets instantiated on each leaf from a top-levelFieldComparator
instance.MultiRangeQuery Abstract class for range queries involving multiple ranges against physical points such asIntPoints
All ranges are logically ORed together TODO: Add capability for handling overlapping ranges at rewrite timeMultiRangeQuery.Builder A builder for multirange queries.Query The abstract base class for queries.QueryVisitor Allows recursion through a query treeScorable Allows access to the score of a QueryScoreMode Different modes of search.Scorer Expert: Common scoring functionality for different types of queries.ScorerSupplier A supplier ofScorer
.SegmentCacheable Interface defining whether or not an object can be cached against aLeafReader
Objects that depend only on segment-immutable structures such as Points or postings lists can just returntrue
fromSegmentCacheable.isCacheable(LeafReaderContext)
Objects that depend on doc values should returnDocValues.isCacheable(LeafReaderContext, String...)
, which will check to see if the doc values fields have been updated.SimpleFieldComparator BaseFieldComparator
implementation that is used for all contexts.SortField Stores information about how to sort documents by terms in an individual field.TopFieldDocs Represents hits returned byIndexSearcher.search(Query,int,Sort)
.Weight Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.expressions Class Description DoubleValues Per-segment, per-document double values, which can be calculated at search-timeDoubleValuesSource Base class for producingDoubleValues
To obtain aDoubleValues
object for a leaf reader, clients should callDoubleValuesSource.rewrite(IndexSearcher)
against the top-level searcher, and then callDoubleValuesSource.getValues(LeafReaderContext, DoubleValues)
on the resulting DoubleValuesSource.Explanation Expert: Describes the score computation for document and query.IndexSearcher Implements search over a single IndexReader.Rescorer Re-scores the topN results (TopDocs
) from an original query.SegmentCacheable Interface defining whether or not an object can be cached against aLeafReader
Objects that depend only on segment-immutable structures such as Points or postings lists can just returntrue
fromSegmentCacheable.isCacheable(LeafReaderContext)
Objects that depend on doc values should returnDocValues.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.SortRescorer ARescorer
that re-sorts according to a provided Sort. -
Classes in org.apache.lucene.search used by org.apache.lucene.index Class 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.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.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.Weight Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.index.memory Class 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. -
Classes in org.apache.lucene.search used by org.apache.lucene.monitor Class 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.BoostQuery AQuery
wrapper that allows to give a boost to the wrapped query.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.QueryVisitor Allows recursion through a query treeScorable Allows access to the score of a QueryScoreMode Different modes of search.SearcherFactory Factory class used bySearcherManager
to create new IndexSearchers.SearcherManager Utility class to safely shareIndexSearcher
instances across multiple threads, while periodically reopening.SimpleCollector BaseCollector
implementation that is used to collect all contexts.Weight Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.payloads Class Description Query The abstract base class for queries. -
Classes in org.apache.lucene.search used by org.apache.lucene.queries Class Description BooleanClause.Occur Specifies how clauses are to occur in matching documents.Query The abstract base class for queries.QueryVisitor Allows recursion through a query tree -
Classes in org.apache.lucene.search used by org.apache.lucene.queries.function Class 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-timeDoubleValuesSource Base class for producingDoubleValues
To obtain aDoubleValues
object for a leaf reader, clients should callDoubleValuesSource.rewrite(IndexSearcher)
against the top-level searcher, and then callDoubleValuesSource.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 withTopFieldCollector
.FieldComparatorSource Provides aFieldComparator
for custom field sorting.IndexSearcher Implements search over a single IndexReader.LeafFieldComparator Expert: comparator that gets instantiated on each leaf from a top-levelFieldComparator
instance.LongValues Per-segment, per-document long values, which can be calculated at search-timeLongValuesSource Base class for producingLongValues
To obtain aLongValues
object for a leaf reader, clients should callLongValuesSource.rewrite(IndexSearcher)
against the top-level searcher, and thenLongValuesSource.getValues(LeafReaderContext, DoubleValues)
.Matches Reports the positions and optionally offsets of all matching terms in a query for a single document To obtain aMatchesIterator
for a particular field, callMatches.getMatches(String)
.Query The abstract base class for queries.QueryVisitor Allows recursion through a query treeScorable Allows access to the score of a QueryScoreMode Different modes of search.Scorer Expert: Common scoring functionality for different types of queries.SegmentCacheable Interface defining whether or not an object can be cached against aLeafReader
Objects that depend only on segment-immutable structures such as Points or postings lists can just returntrue
fromSegmentCacheable.isCacheable(LeafReaderContext)
Objects that depend on doc values should returnDocValues.isCacheable(LeafReaderContext, String...)
, which will check to see if the doc values fields have been updated.SimpleFieldComparator BaseFieldComparator
implementation that is used for all contexts.SortField Stores information about how to sort documents by terms in an individual field.TwoPhaseIterator Returned byScorer.twoPhaseIterator()
to expose an approximation of aDocIdSetIterator
.Weight Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.queries.function.docvalues Class Description Weight Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.queries.function.valuesource Class 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.Scorer Expert: Common scoring functionality for different types of 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.TwoPhaseIterator Returned byScorer.twoPhaseIterator()
to expose an approximation of aDocIdSetIterator
.Weight Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.queries.intervals Class 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.FilterMatchesIterator A MatchesIterator that delegates all calls to another MatchesIteratorIndexSearcher 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 aMatchesIterator
for a particular field, callMatches.getMatches(String)
.MatchesIterator An iterator over match positions (and optionally offsets) for a single document and field To iterate over the matches, callMatchesIterator.next()
until it returnsfalse
, retrieving positions and/or offsets after each call.Query The abstract base class for queries.QueryVisitor Allows recursion through a query treeScorable Allows access to the score of a QueryScoreMode Different modes of search.Scorer Expert: Common scoring functionality for different types of queries.SegmentCacheable Interface defining whether or not an object can be cached against aLeafReader
Objects that depend only on segment-immutable structures such as Points or postings lists can just returntrue
fromSegmentCacheable.isCacheable(LeafReaderContext)
Objects that depend on doc values should returnDocValues.isCacheable(LeafReaderContext, String...)
, which will check to see if the doc values fields have been updated.TwoPhaseIterator Returned byScorer.twoPhaseIterator()
to expose an approximation of aDocIdSetIterator
.Weight Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.queries.mlt Class Description Query The abstract base class for queries.QueryVisitor Allows recursion through a query tree -
Classes in org.apache.lucene.search used by org.apache.lucene.queries.payloads Class 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.LeafSimScorer Similarity.SimScorer
on a specificLeafReader
.Query The abstract base class for queries.QueryVisitor Allows recursion through a query treeScorable Allows access to the score of a QueryScoreMode Different modes of search.Scorer Expert: Common scoring functionality for different types of queries.SegmentCacheable Interface defining whether or not an object can be cached against aLeafReader
Objects that depend only on segment-immutable structures such as Points or postings lists can just returntrue
fromSegmentCacheable.isCacheable(LeafReaderContext)
Objects that depend on doc values should returnDocValues.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 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.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.complexPhrase Class Description BooleanQuery A Query that matches documents matching boolean combinations of other queries, e.g.Query The abstract base class for queries.QueryVisitor Allows recursion through a query treeSynonymQuery A query that treats multiple terms as synonyms. -
Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.ext Class Description Query The abstract base class for queries. -
Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.flexible.standard Class 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 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.FuzzyQuery Implements the fuzzy search query.MatchAllDocsQuery A query that matches all documents.MatchNoDocsQuery A query that matches no documents.MultiPhraseQuery A generalized version ofPhraseQuery
, 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 theorg.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 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 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 Description BooleanClause.Occur Specifies how clauses are to occur in matching documents.BooleanQuery.Builder A builder for boolean queries.Query The abstract base class for queries.QueryVisitor Allows recursion through a query treeTermQuery A Query that matches documents containing a term. -
Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.xml Class Description Query The abstract base class for queries. -
Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.xml.builders Class Description BooleanClause.Occur Specifies how clauses are to occur in matching documents.Query The abstract base class for queries. -
Classes in org.apache.lucene.search used by org.apache.lucene.sandbox.queries Class Description Query The abstract base class for queries.QueryVisitor Allows recursion through a query tree -
Classes in org.apache.lucene.search used by org.apache.lucene.search Class Description AutomatonQuery AQuery
that will match terms against a finite-state machine.BlendedTermQuery AQuery
that blends index statistics across multiple terms.BlendedTermQuery.Builder A Builder forBlendedTermQuery
.BlendedTermQuery.RewriteMethod ABlendedTermQuery.RewriteMethod
defines how queries for individual terms should be merged.BlockMaxDISI DocIdSetIterator
that skips non-competitive docs by checking the max score of the providedScorer
for the current block.BM25FQuery AQuery
that treats multiple fields as a single stream and scores terms as if you had indexed them as a single term in a single field.BM25FQuery.Builder A builder forBM25FQuery
.BM25FQuery.FieldAndWeight 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.BooleanScorer.Bucket BooleanScorer.BulkScorerAndDoc BooleanScorer.HeadPriorityQueue BooleanScorer.OrCollector BooleanScorer.TailPriorityQueue BooleanWeight Expert: the Weight for BooleanQuery, used to normalize, score and explain these queries.BooleanWeight.WeightedBooleanClause BoostAttribute Add thisAttribute
to aTermsEnum
returned byMultiTermQuery.getTermsEnum(Terms,AttributeSource)
and update the boost on each returned term.BoostQuery AQuery
wrapper that allows to give a boost to the wrapped query.BulkScorer This class is used to score a range of documents at once, and is returned byWeight.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.CachingCollector.NoScoreCachingCollector CachingCollector.NoScoreCachingLeafCollector 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.ConstantScoreWeight A Weight that has a constant score equal to the boost of the wrapped query.DisiPriorityQueue A priority queue of DocIdSetIterators that orders by current doc ID.DisiWrapper Wrapper used inDisiPriorityQueue
.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.DisjunctionScoreBlockBoundaryPropagator A helper to propagate block boundaries for disjunctions.DisjunctionScorer Base class for Scorers that score disjunctions.DisjunctionScorer.TwoPhase DiversifiedTopDocsCollector.ScoreDocKey An extension to ScoreDoc that includes a key used for grouping purposesDiversifiedTopDocsCollector.ScoreDocKeyQueue 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.DocValuesNumbersQuery LikeDocValuesTermsQuery
, but this query only runs on a longNumericDocValuesField
or aSortedNumericDocValuesField
, matching all documents whose value in the specified field is contained in the provided set of long values.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.DocValuesTermsQuery AQuery
that only accepts documents whose term value in the specified field is contained in the provided set of allowed terms.DoubleValues Per-segment, per-document double values, which can be calculated at search-timeDoubleValuesSource Base class for producingDoubleValues
To obtain aDoubleValues
object for a leaf reader, clients should callDoubleValuesSource.rewrite(IndexSearcher)
against the top-level searcher, and then callDoubleValuesSource.getValues(LeafReaderContext, DoubleValues)
on the resulting DoubleValuesSource.DoubleValuesSource.DoubleValuesHolder ExactPhraseMatcher.PostingsAndPosition 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 withTopFieldCollector
.FieldComparator.NumericComparator Base FieldComparator class for numeric typesFieldComparator.RelevanceComparator Sorts by descending relevance.FieldComparatorSource Provides aFieldComparator
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 theFieldComparator
slot.FilterCollector Collector
delegator.FilterLeafCollector LeafCollector
delegator.FilterScorable Filter aScorable
, intercepting methods and optionally changing their return values The default implementation simply passes all calls to its delegate, with the exception ofScorable.setMinCompetitiveScore(float)
which defaults to a no-op.FilterScorer AFilterScorer
contains anotherScorer
, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.FuzzyAutomatonBuilder Builds a set of CompiledAutomaton for fuzzy matching on a given term, with specified maximum edit distance, fixed prefix and whether or not to allow transpositions.FuzzyTermsEnum.AutomatonAttribute Used for sharing automata between segments Levenshtein automata are large and expensive to build; we don't want to build them directly on the query because this can blow up caches that use queries as keys; we also don't want to rebuild them for every segment.HitQueue HitsThresholdChecker Used for defining custom algorithms to allow searches to early terminateImpactsDISI DocIdSetIterator
that skips non-competitive docs thanks to the indexed impacts.IndexSearcher Implements search over a single IndexReader.IndexSearcher.LeafSlice A class holding a subset of theIndexSearcher
s leaf contexts to be executed within a single thread.IndexSortSortedNumericDocValuesRangeQuery.ValueComparator Compares the given document's value with a stored reference value.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-levelFieldComparator
instance.LeafSimScorer Similarity.SimScorer
on a specificLeafReader
.LongHashSet LongValues Per-segment, per-document long values, which can be calculated at search-timeLongValuesSource Base class for producingLongValues
To obtain aLongValues
object for a leaf reader, clients should callLongValuesSource.rewrite(IndexSearcher)
against the top-level searcher, and thenLongValuesSource.getValues(LeafReaderContext, DoubleValues)
.LongValuesSource.LongValuesHolder LRUQueryCache.LeafCache Matches Reports the positions and optionally offsets of all matching terms in a query for a single document To obtain aMatchesIterator
for a particular field, callMatches.getMatches(String)
.MatchesIterator An iterator over match positions (and optionally offsets) for a single document and field To iterate over the matches, callMatchesIterator.next()
until it returnsfalse
, retrieving positions and/or offsets after each call.MaxNonCompetitiveBoostAttribute Add thisAttribute
to a freshAttributeSource
before callingMultiTermQuery.getTermsEnum(Terms,AttributeSource)
.MaxScoreAccumulator Maintains the maximum score and its corresponding document id concurrentlyMaxScoreAccumulator.DocAndScore MaxScoreCache Compute maximum scores based onImpacts
and keep them in a cache in order not to run expensive similarity score computations multiple times on the same data.MaxScoreSumPropagator Utility class to propagate scoring information inBooleanQuery
, which compute the score as the sum of the scores of its matching clauses.MultiCollectorManager.Collectors MultiNormsLeafSimScorer Copy ofLeafSimScorer
that sums document's norms from multiple fields.MultiPhraseQuery A generalized version ofPhraseQuery
, 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 queriesMultiPhraseQuery.PostingsAndPosition MultiPhraseQuery.UnionPostingsEnum Takes the logical union of multiple PostingsEnum iterators.MultiPhraseQuery.UnionPostingsEnum.DocsQueue disjunction of postings ordered by docid.MultiPhraseQuery.UnionPostingsEnum.PositionsQueue queue of terms for a single document.MultiRangeQuery Abstract class for range queries involving multiple ranges against physical points such asIntPoints
All ranges are logically ORed together TODO: Add capability for handling overlapping ranges at rewrite timeMultiRangeQuery.Builder A builder for multirange queries.MultiRangeQuery.RangeClause Representation of a single clause in a MultiRangeQueryMultiTermQuery An abstractQuery
that matches documents containing a subset of terms provided by aFilteredTermsEnum
enumeration.MultiTermQuery.RewriteMethod Abstract class that defines how the query is rewritten.NamedMatches Utility class to help extract the set of sub queries that have matched from a larger query.NearestNeighbor.Cell NearestNeighbor.NearestHit NGramPhraseQuery This is aPhraseQuery
which is optimized for n-gram phrase query.PhraseMatcher Base class for exact and sloppy phrase matching To find matches on a document, first advancePhraseMatcher.approximation()
to the relevant document, then callPhraseMatcher.reset()
.PhrasePositions Position of a term in a document that takes into account the term offset within the phrase.PhraseQuery A Query that matches documents containing a particular sequence of terms.PhraseQuery.Builder A builder for phrase queries.PhraseQuery.PostingsAndFreq PhraseQueue PhraseWeight PhraseWildcardQuery A generalized version ofPhraseQuery
, built with one or moreMultiTermQuery
that provides term expansions for multi-terms (one of the expanded terms must match).PhraseWildcardQuery.Builder Builds aPhraseWildcardQuery
.PhraseWildcardQuery.MultiTerm Phrase term with expansions.PhraseWildcardQuery.PhraseTerm AllPhraseWildcardQuery.PhraseTerm
are light and immutable.PhraseWildcardQuery.SingleTerm Phrase term with no expansion.PhraseWildcardQuery.TermBytesTermState Holds a pair of term bytes - term state.PhraseWildcardQuery.TermData PhraseWildcardQuery.TermsData Holds theTermState
andTermStatistics
for all the matched and collectedTerm
, for all phrase terms, for all segments.PhraseWildcardQuery.TermStats Accumulates the doc freq and total term freq.PhraseWildcardQuery.TestCounters Test counters incremented when assertions are enabled.PointInSetQuery Abstract query class to find all documents whose single or multi-dimensional point values, previously indexed with e.g.PointInSetQuery.Stream Iterator of encoded point values.PointRangeQuery Abstract class for range queries against single or multidimensional points such asIntPoint
.Query The abstract base class for queries.QueryCache A cache for queries.QueryCachingPolicy A policy defining which filters should be cached.QueryVisitor Allows recursion through a query treeReferenceManager 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.Scorable Allows access to the score of a QueryScorable.ChildScorable A child Scorer and its relationship to its parent.ScoreAndDoc Used byBulkScorer
s that need to pass aScorable
toLeafCollector.setScorer(org.apache.lucene.search.Scorable)
.ScoreDoc Holds one hit inTopDocs
.ScoreMode Different modes of search.Scorer Expert: Common scoring functionality for different types of queries.ScorerSupplier A supplier ofScorer
.ScoringRewrite Base rewrite method that translates each term into a query, and keeps the scores as computed by the query.ScoringRewrite.TermFreqBoostByteStart Special implementation of BytesStartArray that keeps parallel arrays for boost and docFreqSearcherFactory Factory class used bySearcherManager
to create new IndexSearchers.SearcherLifetimeManager.Pruner SearcherLifetimeManager.SearcherTracker SegmentCacheable Interface defining whether or not an object can be cached against aLeafReader
Objects that depend only on segment-immutable structures such as Points or postings lists can just returntrue
fromSegmentCacheable.isCacheable(LeafReaderContext)
Objects that depend on doc values should returnDocValues.isCacheable(LeafReaderContext, String...)
, which will check to see if the doc values fields have been updated.SimpleCollector BaseCollector
implementation that is used to collect all contexts.SimpleFieldComparator BaseFieldComparator
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 CUSTOMSynonymQuery A query that treats multiple terms as synonyms.SynonymQuery.Builder A builder forSynonymQuery
.SynonymQuery.TermAndBoost TermAutomatonQuery A proximity query that lets you express an automaton, whose transitions are terms, to match documents.TermAutomatonQuery.EnumAndScorer TermAutomatonQuery.TermAutomatonWeight TermAutomatonScorer.PosState TermCollectingRewrite TermCollectingRewrite.TermCollector TermInSetQuery Specialization for a disjunction over many terms that behaves like aConstantScoreQuery
over aBooleanQuery
containing onlyBooleanClause.Occur.SHOULD
clauses.TermRangeQuery A Query that matches documents within an range of terms.TermScorer Expert: AScorer
for documents matching aTerm
.TermStatistics Contains statistics for a specific termTimeLimitingCollector.TimerThread Thread used to timeout search requests.TopDocs Represents hits returned byIndexSearcher.search(Query,int)
.TopDocs.ShardRef TopDocsCollector A base class for all collectors that return aTopDocs
output.TopFieldCollector TopFieldDocs Represents hits returned byIndexSearcher.search(Query,int,Sort)
.TopScoreDocCollector TopTermsRewrite Base rewrite method for collecting only the top terms via a priority queue.TopTermsRewrite.ScoreTerm TotalHits Description of the total number of hits of a query.TotalHits.Relation How theTotalHits.value
should be interpreted.TwoPhaseIterator Returned byScorer.twoPhaseIterator()
to expose an approximation of aDocIdSetIterator
.Weight Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.search.grouping Class 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.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-timeDoubleValuesSource Base class for producingDoubleValues
To obtain aDoubleValues
object for a leaf reader, clients should callDoubleValuesSource.rewrite(IndexSearcher)
against the top-level searcher, and then callDoubleValuesSource.getValues(LeafReaderContext, DoubleValues)
on the resulting DoubleValuesSource.FieldComparator Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top results withTopFieldCollector
.FilterCollector Collector
delegator.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.LeafFieldComparator Expert: comparator that gets instantiated on each leaf from a top-levelFieldComparator
instance.LongValues Per-segment, per-document long values, which can be calculated at search-timeLongValuesSource Base class for producingLongValues
To obtain aLongValues
object for a leaf reader, clients should callLongValuesSource.rewrite(IndexSearcher)
against the top-level searcher, and thenLongValuesSource.getValues(LeafReaderContext, DoubleValues)
.Query The abstract base class for queries.Scorable Allows access to the score of a QueryScoreDoc Holds one hit inTopDocs
.ScoreMode Different modes of search.SimpleCollector BaseCollector
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.TopDocsCollector A base class for all collectors that return aTopDocs
output.TotalHits Description of the total number of hits of a query.Weight Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.search.highlight Class Description BooleanClause.Occur Specifies how clauses are to occur in matching documents.IndexSearcher Implements search over a single IndexReader.Query The abstract base class for queries.QueryVisitor Allows recursion through a query tree -
Classes in org.apache.lucene.search used by org.apache.lucene.search.join Class 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.ConstantScoreWeight A Weight that has a constant score equal to the boost of the wrapped query.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.FieldComparator Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top results withTopFieldCollector
.FilterWeight AFilterWeight
contains anotherWeight
and implements all abstract methods by calling the contained weight's method.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.Matches Reports the positions and optionally offsets of all matching terms in a query for a single document To obtain aMatchesIterator
for a particular field, callMatches.getMatches(String)
.MultiTermQuery An abstractQuery
that matches documents containing a subset of terms provided by aFilteredTermsEnum
enumeration.PointInSetQuery.Stream Iterator of encoded point values.Query The abstract base class for queries.QueryVisitor Allows recursion through a query treeScorable Allows access to the score of a QueryScorable.ChildScorable A child Scorer and its relationship to its parent.ScoreMode Different modes of search.Scorer Expert: Common scoring functionality for different types of queries.ScorerSupplier A supplier ofScorer
.SegmentCacheable Interface defining whether or not an object can be cached against aLeafReader
Objects that depend only on segment-immutable structures such as Points or postings lists can just returntrue
fromSegmentCacheable.isCacheable(LeafReaderContext)
Objects that depend on doc values should returnDocValues.isCacheable(LeafReaderContext, String...)
, which will check to see if the doc values fields have been updated.SimpleCollector BaseCollector
implementation that is used to collect all contexts.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 CUSTOMTwoPhaseIterator Returned byScorer.twoPhaseIterator()
to expose an approximation of aDocIdSetIterator
.Weight Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.search.similarities Class 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.similarity Class Description CollectionStatistics Contains statistics for a collection (field).TermStatistics Contains statistics for a specific term -
Classes in org.apache.lucene.search used by org.apache.lucene.search.spans Class 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.LeafSimScorer Similarity.SimScorer
on a specificLeafReader
.Matches Reports the positions and optionally offsets of all matching terms in a query for a single document To obtain aMatchesIterator
for a particular field, callMatches.getMatches(String)
.MultiTermQuery An abstractQuery
that matches documents containing a subset of terms provided by aFilteredTermsEnum
enumeration.MultiTermQuery.RewriteMethod Abstract class that defines how the query is rewritten.Query The abstract base class for queries.QueryVisitor Allows recursion through a query treeScorable Allows access to the score of a QueryScoreMode Different modes of search.Scorer Expert: Common scoring functionality for different types of queries.SegmentCacheable Interface defining whether or not an object can be cached against aLeafReader
Objects that depend only on segment-immutable structures such as Points or postings lists can just returntrue
fromSegmentCacheable.isCacheable(LeafReaderContext)
Objects that depend on doc values should returnDocValues.isCacheable(LeafReaderContext, String...)
, which will check to see if the doc values fields have been updated.TopTermsRewrite Base rewrite method for collecting only the top terms via a priority queue.TwoPhaseIterator Returned byScorer.twoPhaseIterator()
to expose an approximation of aDocIdSetIterator
.Weight Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.search.spell Class Description BooleanQuery.Builder A builder for boolean queries.IndexSearcher Implements search over a single IndexReader. -
Classes in org.apache.lucene.search used by org.apache.lucene.search.suggest Class Description BooleanQuery A Query that matches documents matching boolean combinations of other queries, e.g.LongValues Per-segment, per-document long values, which can be calculated at search-timeLongValuesSource Base class for producingLongValues
To obtain aLongValues
object for a leaf reader, clients should callLongValuesSource.rewrite(IndexSearcher)
against the top-level searcher, and thenLongValuesSource.getValues(LeafReaderContext, DoubleValues)
. -
Classes in org.apache.lucene.search used by org.apache.lucene.search.suggest.analyzing Class 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 shareIndexSearcher
instances across multiple threads, while periodically reopening.Sort Encapsulates sort criteria for returned hits.TopFieldDocs Represents hits returned byIndexSearcher.search(Query,int,Sort)
. -
Classes in org.apache.lucene.search used by org.apache.lucene.search.suggest.document Class Description BulkScorer This class is used to score a range of documents at once, and is returned byWeight.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.QueryVisitor Allows recursion through a query treeScoreDoc Holds one hit inTopDocs
.ScoreMode Different modes of search.Scorer Expert: Common scoring functionality for different types of queries.SegmentCacheable Interface defining whether or not an object can be cached against aLeafReader
Objects that depend only on segment-immutable structures such as Points or postings lists can just returntrue
fromSegmentCacheable.isCacheable(LeafReaderContext)
Objects that depend on doc values should returnDocValues.isCacheable(LeafReaderContext, String...)
, which will check to see if the doc values fields have been updated.SimpleCollector BaseCollector
implementation that is used to collect all contexts.TopDocs Represents hits returned byIndexSearcher.search(Query,int)
.TotalHits Description of the total number of hits of a query.Weight Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.search.uhighlight Class Description BooleanClause.Occur Specifies how clauses are to occur in matching documents.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, callMatchesIterator.next()
until it returnsfalse
, retrieving positions and/or offsets after each call.Query The abstract base class for queries.QueryVisitor Allows recursion through a query treeTopDocs Represents hits returned byIndexSearcher.search(Query,int)
. -
Classes in org.apache.lucene.search used by org.apache.lucene.search.vectorhighlight Class Description 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.util Class 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.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.MultiPhraseQuery.Builder A builder for multi-phrase queriesQuery The abstract base class for queries.QueryVisitor Allows recursion through a query tree -
Classes in org.apache.lucene.search used by org.apache.lucene.util.automaton Class Description Query The abstract base class for queries.QueryVisitor Allows recursion through a query tree -
Classes in org.apache.lucene.search used by org.apache.lucene.util.bkd Class Description DocIdSetIterator This abstract class defines methods to iterate over a set of non-decreasing doc ids.