Uses of Package
org.apache.lucene.search
-
Packages that use org.apache.lucene.search Package Description org.apache.lucene.document The logical representation of aDocument
for indexing and searching.org.apache.lucene.index Code to maintain and access indices.org.apache.lucene.search Code to search indices.org.apache.lucene.search.similarities This package contains the various ranking models that can be used in Lucene.org.apache.lucene.search.spans The calculus of spans.org.apache.lucene.util Some utility classes.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.document Class Description DoubleValuesSource 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.IndexSearcher Implements search over a single IndexReader.Query The abstract base class for queries.QueryVisitor Allows recursion through a query treeScoreMode Different modes of search.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 Class Description DocIdSetIterator This abstract class defines methods to iterate over a set of non-decreasing doc ids.Query The abstract base class for queries.ReferenceManager Utility class to safely share instances of a certain type across multiple threads, while periodically refreshing them.Sort Encapsulates sort criteria for returned hits. -
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.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 thisAttribute
to aTermsEnum
returned byMultiTermQuery.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 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.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 inDisiPriorityQueue
.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.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
.FieldComparator.NumericComparator Base FieldComparator class for numeric typesFieldComparatorSource 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.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.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)
.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)
.MultiCollectorManager.Collectors 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 queriesMultiTermQuery 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.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.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.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.SearcherFactory Factory class used bySearcherManager
to create new IndexSearchers.SearcherLifetimeManager.Pruner 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
.TermRangeQuery A Query that matches documents within an range of terms.TermStatistics Contains statistics for a specific termTimeLimitingCollector.TimerThread Thread used to timeout search requests.TopDocs Represents hits returned byIndexSearcher.search(Query,int)
.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.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.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.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.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.util Class 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.MultiPhraseQuery.Builder A builder for multi-phrase queriesQuery The abstract base class for queries. -
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.