Uses of Package
org.apache.lucene.search
Packages that use org.apache.lucene.search
Package
Description
Provides various convenience classes for creating boosts on Tokens.
Uses already seen data (the indexed documents) to classify an input ( can be simple text or a structured document).
Uses already seen data (the indexed documents) to classify new documents.
Utilities for evaluation, data preparation, etc.
StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.
A primary-key postings format that associates a version (long) with each term and
can provide fail-fast lookups by ID and version.
Components from the Lucene 5.0 index format
See
org.apache.lucene.codecs.lucene80 for an overview
of the index format.Components from the Lucene 7.0 index format.
Components from the Lucene 8.0 index format
See
org.apache.lucene.codecs.lucene84 for an overview
of the index format.Components from the Lucene 8.4 index format.
Term dictionary, DocValues or Postings formats that are read
entirely into memory.
Simpletext Codec: writes human readable postings.
Pluggable term index / block terms dictionary implementations.
The logical representation of a
Document for indexing and searching.Expressions.
Code to maintain and access indices.
High-performance single-document main memory Apache Lucene fulltext search index.
Monitoring framework
Experimental classes for interacting with payloads
Filters and Queries that add to core Lucene.
Queries that compute score based upon a function.
FunctionValues for different data types.
A variety of functions to use with FunctionQuery.
Intervals queries
Document similarity query generators.
The payloads package provides Query mechanisms for finding and using payloads.
A simple query parser implemented with JavaCC.
QueryParser which permits complex phrase query syntax eg "(john jon jonathan~) peters*"
Extendable QueryParser provides a simple and flexible extension mechanism by overloading query field names.
Implementation of the Lucene classic query parser using the flexible query parser frameworks
Standard Lucene Query Node Builders.
Standard Lucene Query Configuration.
A simple query parser for human-entered queries.
This package contains SrndQuery and its subclasses.
Parser that produces Lucene Query objects from XML streams.
XML Parser factories for different Lucene Query/Filters.
Additional queries (some may have caveats or limitations)
Code to search indices.
Comparators, used to compare hits so as to determine their
sort order when collecting the top results with
TopFieldCollector.Grouping.
Highlighting search terms.
Support for index-time and query-time joins.
This package contains the various ranking models that can be used in Lucene.
Misc similarity implementations.
The calculus of spans.
Suggest alternate spellings for words.
Support for Autocomplete/Autosuggest
Analyzer based autosuggest.
Support for document suggestion
The UnifiedHighlighter -- a flexible highlighter that can get offsets from postings, term vectors, or analysis.
Another highlighter implementation based on term vectors.
Some utility classes.
Finite-state automaton for regular expressions.
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.boostClassDescriptionAdd this
Attributeto aTermsEnumreturned byMultiTermQuery.getTermsEnum(Terms,AttributeSource)and update the boost on each returned term. -
Classes in org.apache.lucene.search used by org.apache.lucene.classificationClassDescriptionImplements search over a single IndexReader.The abstract base class for queries.Represents hits returned by
IndexSearcher.search(Query,int). -
Classes in org.apache.lucene.search used by org.apache.lucene.classification.documentClassDescriptionThe abstract base class for queries.Represents hits returned by
IndexSearcher.search(Query,int). -
Classes in org.apache.lucene.search used by org.apache.lucene.classification.utilsClassDescriptionThe abstract base class for queries.Allows recursion through a query treeHolds one hit in
TopDocs. -
Classes in org.apache.lucene.search used by org.apache.lucene.codecs.compressingClassDescriptionThis 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.idversionClassDescriptionThis 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.lucene50ClassDescriptionThis 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.lucene70ClassDescriptionThis 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.lucene80ClassDescriptionThis 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.lucene84ClassDescriptionThis 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.memoryClassDescriptionThis 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.simpletextClassDescriptionThis 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.documentClassDescriptionThis abstract class defines methods to iterate over a set of non-decreasing doc ids.Per-segment, per-document double values, which can be calculated at search-timeBase class for producing
DoubleValuesTo obtain aDoubleValuesobject for a leaf reader, clients should callDoubleValuesSource.rewrite(IndexSearcher)against the top-level searcher, and then callDoubleValuesSource.getValues(LeafReaderContext, DoubleValues)on the resulting DoubleValuesSource.Expert: Describes the score computation for document and query.Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top results withTopFieldCollector.Implements search over a single IndexReader.Expert: comparator that gets instantiated on each leaf from a top-levelFieldComparatorinstance.Abstract class for range queries involving multiple ranges against physical points such asIntPointsAll ranges are logically ORed together TODO: Add capability for handling overlapping ranges at rewrite timeA builder for multirange queries.The abstract base class for queries.Allows recursion through a query treeAllows access to the score of a QueryDifferent modes of search.Expert: Common scoring functionality for different types of queries.A supplier ofScorer.Interface defining whether or not an object can be cached against aLeafReaderObjects that depend only on segment-immutable structures such as Points or postings lists can just returntruefromSegmentCacheable.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.BaseFieldComparatorimplementation that is used for all contexts.Stores information about how to sort documents by terms in an individual field.Represents hits returned byIndexSearcher.search(Query,int,Sort).Returned byScorer.twoPhaseIterator()to expose an approximation of aDocIdSetIterator.Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.expressionsClassDescriptionPer-segment, per-document double values, which can be calculated at search-timeBase class for producing
DoubleValuesTo obtain aDoubleValuesobject for a leaf reader, clients should callDoubleValuesSource.rewrite(IndexSearcher)against the top-level searcher, and then callDoubleValuesSource.getValues(LeafReaderContext, DoubleValues)on the resulting DoubleValuesSource.Expert: Describes the score computation for document and query.Implements search over a single IndexReader.Re-scores the topN results (TopDocs) from an original query.Interface defining whether or not an object can be cached against aLeafReaderObjects that depend only on segment-immutable structures such as Points or postings lists can just returntruefromSegmentCacheable.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.Stores information about how to sort documents by terms in an individual field.ARescorerthat re-sorts according to a provided Sort. -
Classes in org.apache.lucene.search used by org.apache.lucene.indexClassDescriptionA DocIdSet contains a set of doc ids.This abstract class defines methods to iterate over a set of non-decreasing doc ids.The abstract base class for queries.Utility class to safely share instances of a certain type across multiple threads, while periodically refreshing them.Expert: Common scoring functionality for different types of queries.Encapsulates sort criteria for returned hits.Stores information about how to sort documents by terms in an individual field.Expert: Calculate query weights and build query scorers.
-
Classes in org.apache.lucene.search used by org.apache.lucene.index.memoryClassDescriptionThis abstract class defines methods to iterate over a set of non-decreasing doc ids.Implements search over a single IndexReader.The abstract base class for queries.
-
Classes in org.apache.lucene.search used by org.apache.lucene.monitorClassDescriptionSpecifies how clauses are to occur in matching documents.A Query that matches documents matching boolean combinations of other queries, e.g.A builder for boolean queries.A
Querywrapper that allows to give a boost to the wrapped query.Expert: Collectors are primarily meant to be used to gather raw results from a search, and implement sorting or custom result filtering, collation, etc.Expert: Describes the score computation for document and query.Implements search over a single IndexReader.Collector decouples the score from the collected doc: the score computation is skipped entirely if it's not needed.The abstract base class for queries.Allows recursion through a query treeAllows access to the score of a QueryDifferent modes of search.Factory class used bySearcherManagerto create new IndexSearchers.Utility class to safely shareIndexSearcherinstances across multiple threads, while periodically reopening.BaseCollectorimplementation that is used to collect all contexts.Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.payloads
-
Classes in org.apache.lucene.search used by org.apache.lucene.queriesClassDescriptionSpecifies how clauses are to occur in matching documents.The abstract base class for queries.Allows recursion through a query tree
-
Classes in org.apache.lucene.search used by org.apache.lucene.queries.functionClassDescriptionThis abstract class defines methods to iterate over a set of non-decreasing doc ids.Per-segment, per-document double values, which can be calculated at search-timeBase class for producing
DoubleValuesTo obtain aDoubleValuesobject for a leaf reader, clients should callDoubleValuesSource.rewrite(IndexSearcher)against the top-level searcher, and then callDoubleValuesSource.getValues(LeafReaderContext, DoubleValues)on the resulting DoubleValuesSource.Expert: Describes the score computation for document and query.Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top results withTopFieldCollector.Provides aFieldComparatorfor custom field sorting.Implements search over a single IndexReader.Expert: comparator that gets instantiated on each leaf from a top-levelFieldComparatorinstance.Per-segment, per-document long values, which can be calculated at search-timeBase class for producingLongValuesTo obtain aLongValuesobject for a leaf reader, clients should callLongValuesSource.rewrite(IndexSearcher)against the top-level searcher, and thenLongValuesSource.getValues(LeafReaderContext, DoubleValues).Reports the positions and optionally offsets of all matching terms in a query for a single document To obtain aMatchesIteratorfor a particular field, callMatches.getMatches(String).The abstract base class for queries.Allows recursion through a query treeAllows access to the score of a QueryDifferent modes of search.Expert: Common scoring functionality for different types of queries.Interface defining whether or not an object can be cached against aLeafReaderObjects that depend only on segment-immutable structures such as Points or postings lists can just returntruefromSegmentCacheable.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.BaseFieldComparatorimplementation that is used for all contexts.Stores information about how to sort documents by terms in an individual field.Returned byScorer.twoPhaseIterator()to expose an approximation of aDocIdSetIterator.Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.queries.function.docvalues
-
Classes in org.apache.lucene.search used by org.apache.lucene.queries.function.valuesourceClassDescriptionThis abstract class defines methods to iterate over a set of non-decreasing doc ids.Implements search over a single IndexReader.The abstract base class for queries.Expert: Common scoring functionality for different types of queries.Type of selection to perform.Type of selection to perform.Stores information about how to sort documents by terms in an individual field.Returned by
Scorer.twoPhaseIterator()to expose an approximation of aDocIdSetIterator.Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.queries.intervalsClassDescriptionThis abstract class defines methods to iterate over a set of non-decreasing doc ids.Expert: Describes the score computation for document and query.A MatchesIterator that delegates all calls to another MatchesIteratorImplements search over a single IndexReader.Reports the positions and optionally offsets of all matching terms in a query for a single document To obtain a
MatchesIteratorfor a particular field, callMatches.getMatches(String).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.The abstract base class for queries.Allows recursion through a query treeAllows access to the score of a QueryDifferent modes of search.Expert: Common scoring functionality for different types of queries.Interface defining whether or not an object can be cached against aLeafReaderObjects that depend only on segment-immutable structures such as Points or postings lists can just returntruefromSegmentCacheable.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.Returned byScorer.twoPhaseIterator()to expose an approximation of aDocIdSetIterator.Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.queries.mltClassDescriptionThe abstract base class for queries.Allows recursion through a query tree
-
Classes in org.apache.lucene.search used by org.apache.lucene.queries.payloadsClassDescriptionThis abstract class defines methods to iterate over a set of non-decreasing doc ids.Expert: Describes the score computation for document and query.Implements search over a single IndexReader.
Similarity.SimScoreron a specificLeafReader.The abstract base class for queries.Allows recursion through a query treeAllows access to the score of a QueryDifferent modes of search.Expert: Common scoring functionality for different types of queries.Interface defining whether or not an object can be cached against aLeafReaderObjects that depend only on segment-immutable structures such as Points or postings lists can just returntruefromSegmentCacheable.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.Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.classicClassDescriptionA clause in a BooleanQuery.Specifies how clauses are to occur in matching documents.Abstract class that defines how the query is rewritten.A Query that matches documents containing a particular sequence of terms.The abstract base class for queries.
-
Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.complexPhraseClassDescriptionA Query that matches documents matching boolean combinations of other queries, e.g.The abstract base class for queries.Allows recursion through a query treeA query that treats multiple terms as synonyms.
-
Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.ext
-
Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.flexible.standardClassDescriptionSpecifies how clauses are to occur in matching documents.Abstract class that defines how the query is rewritten.The abstract base class for queries.
-
Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.flexible.standard.buildersClassDescriptionSpecifies how clauses are to occur in matching documents.A Query that matches documents matching boolean combinations of other queries, e.g.Implements the fuzzy search query.A query that matches all documents.A query that matches no documents.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).A Query that matches documents containing terms with a specified prefix.The abstract base class for queries.A fast regular expression query based on theorg.apache.lucene.util.automatonpackage.A Query that matches documents containing a term.A Query that matches documents within an range of terms.Implements the wildcard search query. -
Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.flexible.standard.configClassDescriptionAbstract class that defines how the query is rewritten.
-
Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.simpleClassDescriptionSpecifies how clauses are to occur in matching documents.A Query that matches documents matching boolean combinations of other queries, e.g.The abstract base class for queries.
-
Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.surround.queryClassDescriptionSpecifies how clauses are to occur in matching documents.A builder for boolean queries.The abstract base class for queries.Allows recursion through a query treeA Query that matches documents containing a term.
-
Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.xml
-
Classes in org.apache.lucene.search used by org.apache.lucene.queryparser.xml.buildersClassDescriptionSpecifies how clauses are to occur in matching documents.The abstract base class for queries.
-
Classes in org.apache.lucene.search used by org.apache.lucene.sandbox.queriesClassDescriptionThe abstract base class for queries.Allows recursion through a query tree
-
Classes in org.apache.lucene.search used by org.apache.lucene.searchClassDescriptionA
Querythat will match terms against a finite-state machine.AQuerythat blends index statistics across multiple terms.A Builder forBlendedTermQuery.ABlendedTermQuery.RewriteMethoddefines how queries for individual terms should be merged.DocIdSetIteratorthat skips non-competitive docs by checking the max score of the providedScorerfor the current block.AQuerythat treats multiple fields as a single stream and scores terms as if you had indexed them as a single term in a single field.A builder forBM25FQuery.A clause in a BooleanQuery.Specifies how clauses are to occur in matching documents.A Query that matches documents matching boolean combinations of other queries, e.g.A builder for boolean queries.Expert: the Weight for BooleanQuery, used to normalize, score and explain these queries.Add thisAttributeto aTermsEnumreturned byMultiTermQuery.getTermsEnum(Terms,AttributeSource)and update the boost on each returned term.AQuerywrapper that allows to give a boost to the wrapped query.This class is used to score a range of documents at once, and is returned byWeight.bulkScorer(org.apache.lucene.index.LeafReaderContext).Caches all docs, and optionally also scores, coming from a search, and is then able to replay them to another collector.Contains statistics for a collection (field).Expert: Collectors are primarily meant to be used to gather raw results from a search, and implement sorting or custom result filtering, collation, etc.A manager of collectors.A Weight that has a constant score equal to the boost of the wrapped query.A priority queue of DocIdSetIterators that orders by current doc ID.Wrapper used inDisiPriorityQueue.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.A helper to propagate block boundaries for disjunctions.Base class for Scorers that score disjunctions.An extension to ScoreDoc that includes a key used for grouping purposesA DocIdSet contains a set of doc ids.This abstract class defines methods to iterate over a set of non-decreasing doc ids.LikeDocValuesTermsQuery, but this query only runs on a longNumericDocValuesFieldor aSortedNumericDocValuesField, matching all documents whose value in the specified field is contained in the provided set of long values.Holds statistics for a DocValues field.Holds statistics for a numeric DocValues field.Holds statistics for a sorted-numeric DocValues field.AQuerythat only accepts documents whose term value in the specified field is contained in the provided set of allowed terms.Per-segment, per-document double values, which can be calculated at search-timeBase class for producingDoubleValuesTo obtain aDoubleValuesobject for a leaf reader, clients should callDoubleValuesSource.rewrite(IndexSearcher)against the top-level searcher, and then callDoubleValuesSource.getValues(LeafReaderContext, DoubleValues)on the resulting DoubleValuesSource.Expert: Describes the score computation for document and query.Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top results withTopFieldCollector.Provides aFieldComparatorfor custom field sorting.Expert: A ScoreDoc which also contains information about how to sort the referenced document.Expert: A hit queue for sorting by hits by terms in more than one field.Extension of ScoreDoc to also store theFieldComparatorslot.Collectordelegator.LeafCollectordelegator.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.AFilterScorercontains anotherScorer, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.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.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.Used for defining custom algorithms to allow searches to early terminateDocIdSetIteratorthat skips non-competitive docs thanks to the indexed impacts.Implements search over a single IndexReader.A class holding a subset of theIndexSearchers leaf contexts to be executed within a single thread.Compares the given document's value with a stored reference value.Collector decouples the score from the collected doc: the score computation is skipped entirely if it's not needed.Expert: comparator that gets instantiated on each leaf from a top-levelFieldComparatorinstance.Similarity.SimScoreron a specificLeafReader.Per-segment, per-document long values, which can be calculated at search-timeBase class for producingLongValuesTo obtain aLongValuesobject for a leaf reader, clients should callLongValuesSource.rewrite(IndexSearcher)against the top-level searcher, and thenLongValuesSource.getValues(LeafReaderContext, DoubleValues).Reports the positions and optionally offsets of all matching terms in a query for a single document To obtain aMatchesIteratorfor a particular field, callMatches.getMatches(String).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.Add thisAttributeto a freshAttributeSourcebefore callingMultiTermQuery.getTermsEnum(Terms,AttributeSource).Maintains the maximum score and its corresponding document id concurrentlyCompute maximum scores based onImpactsand keep them in a cache in order not to run expensive similarity score computations multiple times on the same data.Utility class to propagate scoring information inBooleanQuery, which compute the score as the sum of the scores of its matching clauses.Copy ofLeafSimScorerthat sums document's norms from multiple fields.A generalized version ofPhraseQuery, with the possibility of adding more than one term at the same position that are treated as a disjunction (OR).A builder for multi-phrase queriesTakes the logical union of multiple PostingsEnum iterators.disjunction of postings ordered by docid.queue of terms for a single document.Abstract class for range queries involving multiple ranges against physical points such asIntPointsAll ranges are logically ORed together TODO: Add capability for handling overlapping ranges at rewrite timeA builder for multirange queries.Representation of a single clause in a MultiRangeQueryAn abstractQuerythat matches documents containing a subset of terms provided by aFilteredTermsEnumenumeration.Abstract class that defines how the query is rewritten.Utility class to help extract the set of sub queries that have matched from a larger query.This is aPhraseQuerywhich is optimized for n-gram phrase query.Base class for exact and sloppy phrase matching To find matches on a document, first advancePhraseMatcher.approximation()to the relevant document, then callPhraseMatcher.reset().Position of a term in a document that takes into account the term offset within the phrase.A Query that matches documents containing a particular sequence of terms.A builder for phrase queries.A generalized version ofPhraseQuery, built with one or moreMultiTermQuerythat provides term expansions for multi-terms (one of the expanded terms must match).Builds aPhraseWildcardQuery.Phrase term with expansions.AllPhraseWildcardQuery.PhraseTermare light and immutable.Phrase term with no expansion.Holds a pair of term bytes - term state.Holds theTermStateandTermStatisticsfor all the matched and collectedTerm, for all phrase terms, for all segments.Accumulates the doc freq and total term freq.Test counters incremented when assertions are enabled.Abstract query class to find all documents whose single or multi-dimensional point values, previously indexed with e.g.Iterator of encoded point values.Abstract class for range queries against single or multidimensional points such asIntPoint.The abstract base class for queries.A cache for queries.A policy defining which filters should be cached.Allows recursion through a query treeUtility class to safely share instances of a certain type across multiple threads, while periodically refreshing them.Use to receive notification when a refresh has finished.Re-scores the topN results (TopDocs) from an original query.Allows access to the score of a QueryA child Scorer and its relationship to its parent.Used byBulkScorers that need to pass aScorabletoLeafCollector.setScorer(org.apache.lucene.search.Scorable).Holds one hit inTopDocs.Different modes of search.Expert: Common scoring functionality for different types of queries.A supplier ofScorer.Base rewrite method that translates each term into a query, and keeps the scores as computed by the query.Special implementation of BytesStartArray that keeps parallel arrays for boost and docFreqFactory class used bySearcherManagerto create new IndexSearchers.Interface defining whether or not an object can be cached against aLeafReaderObjects that depend only on segment-immutable structures such as Points or postings lists can just returntruefromSegmentCacheable.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.BaseCollectorimplementation that is used to collect all contexts.Encapsulates sort criteria for returned hits.Type of selection to perform.Type of selection to perform.Stores information about how to sort documents by terms in an individual field.Specifies the type of the terms to be sorted, or special types such as CUSTOMA query that treats multiple terms as synonyms.A builder forSynonymQuery.A proximity query that lets you express an automaton, whose transitions are terms, to match documents.Specialization for a disjunction over many terms that behaves like aConstantScoreQueryover aBooleanQuerycontaining onlyBooleanClause.Occur.SHOULDclauses.A Query that matches documents within an range of terms.Expert: AScorerfor documents matching aTerm.Contains statistics for a specific termThread used to timeout search requests.Represents hits returned byIndexSearcher.search(Query,int).A base class for all collectors that return aTopDocsoutput.Represents hits returned byIndexSearcher.search(Query,int,Sort).Base rewrite method for collecting only the top terms via a priority queue.Description of the total number of hits of a query.How theTotalHits.valueshould be interpreted.Returned byScorer.twoPhaseIterator()to expose an approximation of aDocIdSetIterator.Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.search.comparatorsClassDescriptionThis abstract class defines methods to iterate over a set of non-decreasing doc ids.Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top results with
TopFieldCollector.Expert: comparator that gets instantiated on each leaf from a top-levelFieldComparatorinstance.Allows access to the score of a Query -
Classes in org.apache.lucene.search used by org.apache.lucene.search.groupingClassDescriptionExpert: Collectors are primarily meant to be used to gather raw results from a search, and implement sorting or custom result filtering, collation, etc.This abstract class defines methods to iterate over a set of non-decreasing doc ids.Per-segment, per-document double values, which can be calculated at search-timeBase class for producing
DoubleValuesTo obtain aDoubleValuesobject for a leaf reader, clients should callDoubleValuesSource.rewrite(IndexSearcher)against the top-level searcher, and then callDoubleValuesSource.getValues(LeafReaderContext, DoubleValues)on the resulting DoubleValuesSource.Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top results withTopFieldCollector.Collectordelegator.Implements search over a single IndexReader.Collector decouples the score from the collected doc: the score computation is skipped entirely if it's not needed.Expert: comparator that gets instantiated on each leaf from a top-levelFieldComparatorinstance.Per-segment, per-document long values, which can be calculated at search-timeBase class for producingLongValuesTo obtain aLongValuesobject for a leaf reader, clients should callLongValuesSource.rewrite(IndexSearcher)against the top-level searcher, and thenLongValuesSource.getValues(LeafReaderContext, DoubleValues).The abstract base class for queries.Allows access to the score of a QueryHolds one hit inTopDocs.Different modes of search.BaseCollectorimplementation that is used to collect all contexts.Encapsulates sort criteria for returned hits.Stores information about how to sort documents by terms in an individual field.A base class for all collectors that return aTopDocsoutput.Description of the total number of hits of a query.Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.search.highlightClassDescriptionSpecifies how clauses are to occur in matching documents.Implements search over a single IndexReader.The abstract base class for queries.Allows recursion through a query tree
-
Classes in org.apache.lucene.search used by org.apache.lucene.search.joinClassDescriptionExpert: Collectors are primarily meant to be used to gather raw results from a search, and implement sorting or custom result filtering, collation, etc.A Weight that has a constant score equal to the boost of the wrapped query.A DocIdSet contains a set of doc ids.This abstract class defines methods to iterate over a set of non-decreasing doc ids.Expert: Describes the score computation for document and query.Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top results with
TopFieldCollector.AFilterWeightcontains anotherWeightand implements all abstract methods by calling the contained weight's method.Implements search over a single IndexReader.Collector decouples the score from the collected doc: the score computation is skipped entirely if it's not needed.Reports the positions and optionally offsets of all matching terms in a query for a single document To obtain aMatchesIteratorfor a particular field, callMatches.getMatches(String).An abstractQuerythat matches documents containing a subset of terms provided by aFilteredTermsEnumenumeration.Iterator of encoded point values.The abstract base class for queries.Allows recursion through a query treeAllows access to the score of a QueryA child Scorer and its relationship to its parent.Different modes of search.Expert: Common scoring functionality for different types of queries.A supplier ofScorer.Interface defining whether or not an object can be cached against aLeafReaderObjects that depend only on segment-immutable structures such as Points or postings lists can just returntruefromSegmentCacheable.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.BaseCollectorimplementation that is used to collect all contexts.Stores information about how to sort documents by terms in an individual field.Specifies the type of the terms to be sorted, or special types such as CUSTOMReturned byScorer.twoPhaseIterator()to expose an approximation of aDocIdSetIterator.Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.search.similaritiesClassDescriptionContains statistics for a collection (field).Expert: Describes the score computation for document and query.Contains statistics for a specific term
-
Classes in org.apache.lucene.search used by org.apache.lucene.search.similarityClassDescriptionContains statistics for a collection (field).Contains statistics for a specific term
-
Classes in org.apache.lucene.search used by org.apache.lucene.search.spansClassDescriptionThis abstract class defines methods to iterate over a set of non-decreasing doc ids.Expert: Describes the score computation for document and query.Implements search over a single IndexReader.
Similarity.SimScoreron a specificLeafReader.Reports the positions and optionally offsets of all matching terms in a query for a single document To obtain aMatchesIteratorfor a particular field, callMatches.getMatches(String).An abstractQuerythat matches documents containing a subset of terms provided by aFilteredTermsEnumenumeration.Abstract class that defines how the query is rewritten.The abstract base class for queries.Allows recursion through a query treeAllows access to the score of a QueryDifferent modes of search.Expert: Common scoring functionality for different types of queries.Interface defining whether or not an object can be cached against aLeafReaderObjects that depend only on segment-immutable structures such as Points or postings lists can just returntruefromSegmentCacheable.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.Base rewrite method for collecting only the top terms via a priority queue.Returned byScorer.twoPhaseIterator()to expose an approximation of aDocIdSetIterator.Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.search.spellClassDescriptionA builder for boolean queries.Implements search over a single IndexReader.
-
Classes in org.apache.lucene.search used by org.apache.lucene.search.suggestClassDescriptionA Query that matches documents matching boolean combinations of other queries, e.g.Per-segment, per-document long values, which can be calculated at search-timeBase class for producing
LongValuesTo obtain aLongValuesobject 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.analyzingClassDescriptionSpecifies how clauses are to occur in matching documents.A Query that matches documents matching boolean combinations of other queries, e.g.A builder for boolean queries.Implements search over a single IndexReader.The abstract base class for queries.Utility class to safely share
IndexSearcherinstances across multiple threads, while periodically reopening.Encapsulates sort criteria for returned hits.Represents hits returned byIndexSearcher.search(Query,int,Sort). -
Classes in org.apache.lucene.search used by org.apache.lucene.search.suggest.documentClassDescriptionThis class is used to score a range of documents at once, and is returned by
Weight.bulkScorer(org.apache.lucene.index.LeafReaderContext).Expert: Collectors are primarily meant to be used to gather raw results from a search, and implement sorting or custom result filtering, collation, etc.Expert: Describes the score computation for document and query.Implements search over a single IndexReader.Collector decouples the score from the collected doc: the score computation is skipped entirely if it's not needed.The abstract base class for queries.Allows recursion through a query treeHolds one hit inTopDocs.Different modes of search.Expert: Common scoring functionality for different types of queries.Interface defining whether or not an object can be cached against aLeafReaderObjects that depend only on segment-immutable structures such as Points or postings lists can just returntruefromSegmentCacheable.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.BaseCollectorimplementation that is used to collect all contexts.Represents hits returned byIndexSearcher.search(Query,int).Description of the total number of hits of a query.Expert: Calculate query weights and build query scorers. -
Classes in org.apache.lucene.search used by org.apache.lucene.search.uhighlightClassDescriptionSpecifies how clauses are to occur in matching documents.This abstract class defines methods to iterate over a set of non-decreasing doc ids.Implements search over a single IndexReader.An iterator over match positions (and optionally offsets) for a single document and field To iterate over the matches, call
MatchesIterator.next()until it returnsfalse, retrieving positions and/or offsets after each call.The abstract base class for queries.Allows recursion through a query treeRepresents hits returned byIndexSearcher.search(Query,int). -
Classes in org.apache.lucene.search used by org.apache.lucene.search.vectorhighlightClassDescriptionA Query that matches documents containing a particular sequence of terms.The abstract base class for queries.
-
Classes in org.apache.lucene.search used by org.apache.lucene.utilClassDescriptionSpecifies how clauses are to occur in matching documents.A Query that matches documents matching boolean combinations of other queries, e.g.A builder for boolean queries.A DocIdSet contains a set of doc ids.This abstract class defines methods to iterate over a set of non-decreasing doc ids.A builder for multi-phrase queriesThe abstract base class for queries.Allows recursion through a query tree
-
Classes in org.apache.lucene.search used by org.apache.lucene.util.automatonClassDescriptionThe abstract base class for queries.Allows recursion through a query tree
-
Classes in org.apache.lucene.search used by org.apache.lucene.util.bkdClassDescriptionThis abstract class defines methods to iterate over a set of non-decreasing doc ids.