Package org.apache.lucene.search

Interface Summary

Interface	Description
BoostAttribute	Add this Attribute to a TermsEnum returned by MultiTermQuery.getTermsEnum(Terms,AttributeSource) and update the boost on each returned term.
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<C extends Collector,T>	A manager of collectors.
FuzzyTermsEnum.LevenshteinAutomataAttribute	reuses compiled automata across different segments, because they are independent of the index
LeafCollector	Collector decouples the score from the collected doc: the score computation is skipped entirely if it's not needed.
LeafFieldComparator	Expert: comparator that gets instantiated on each leaf from a top-level FieldComparator instance.
Matches	Reports the positions and optionally offsets of all matching terms in a query for a single document To obtain a MatchesIterator for a particular field, call Matches.getMatches(String).
MatchesIterator	An iterator over match positions (and optionally offsets) for a single document and field To iterate over the matches, call MatchesIterator.next() until it returns false, retrieving positions and/or offsets after each call.
MaxNonCompetitiveBoostAttribute	Add this Attribute to a fresh AttributeSource before calling MultiTermQuery.getTermsEnum(Terms,AttributeSource).
QueryCache	A cache for queries.
QueryCachingPolicy	A policy defining which filters should be cached.
ReferenceManager.RefreshListener	Use to receive notification when a refresh has finished.
SegmentCacheable	Interface defining whether or not an object can be cached against a LeafReader Objects that depend only on segment-immutable structures such as Points or postings lists can just return true from SegmentCacheable.isCacheable(LeafReaderContext) Objects that depend on doc values should return DocValues.isCacheable(LeafReaderContext, String...), which will check to see if the doc values fields have been updated.

Class Summary

Class	Description
AutomatonQuery	A Query that will match terms against a finite-state machine.
BlendedTermQuery	A Query that blends index statistics across multiple terms.
BlendedTermQuery.Builder	A Builder for BlendedTermQuery.
BlendedTermQuery.DisjunctionMaxRewrite	A BlendedTermQuery.RewriteMethod that creates a DisjunctionMaxQuery out of the sub queries.
BlendedTermQuery.RewriteMethod	A BlendedTermQuery.RewriteMethod defines how queries for individual terms should be merged.
BlockMaxDISI	DocIdSetIterator that skips non-competitive docs by checking the max score of the provided Scorer for the current block.
BooleanClause	A clause in a BooleanQuery.
BooleanQuery	A Query that matches documents matching boolean combinations of other queries, e.g.
BooleanQuery.Builder	A builder for boolean queries.
BoostQuery	A Query 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 by Weight.bulkScorer(org.apache.lucene.index.LeafReaderContext).
CollectionStatistics	Contains statistics for a collection (field).
ConjunctionDISI	A conjunction of DocIdSetIterators.
ConstantScoreQuery	A query that wraps another query and simply returns a constant score equal to 1 for every document that matches the query.
ConstantScoreQuery.ConstantBulkScorer	We return this as our BulkScorer so that if the CSQ wraps a query with its own optimized top-level scorer (e.g.
ConstantScoreScorer	A constant-scoring Scorer.
ConstantScoreWeight	A Weight that has a constant score equal to the boost of the wrapped query.
CoveringQuery	A Query that allows to have a configurable number or required matches per document.
DisiPriorityQueue	A priority queue of DocIdSetIterators that orders by current doc ID.
DisiWrapper	Wrapper used in DisiPriorityQueue.
DisjunctionDISIApproximation	A DocIdSetIterator which is a disjunction of the approximations of the provided iterators.
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.
DiversifiedTopDocsCollector	A TopDocsCollector that controls diversity in results by ensuring no more than maxHitsPerKey results from a common source are collected in the final results.
DiversifiedTopDocsCollector.ScoreDocKey	An extension to ScoreDoc that includes a key used for grouping purposes
DocIdSet	A DocIdSet contains a set of doc ids.
DocIdSetIterator	This abstract class defines methods to iterate over a set of non-decreasing doc ids.
DocValuesFieldExistsQuery	A Query that matches documents that have a value for a given field as reported by doc values iterators.
DoubleValues	Per-segment, per-document double values, which can be calculated at search-time
DoubleValuesSource	Base class for producing DoubleValues To obtain a DoubleValues object for a leaf reader, clients should call DoubleValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then call DoubleValuesSource.getValues(LeafReaderContext, DoubleValues) on the resulting DoubleValuesSource.
Explanation	Expert: Describes the score computation for document and query.
FieldComparator<T>	Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top results with TopFieldCollector.
FieldComparator.DocComparator	Sorts by ascending docID
FieldComparator.DoubleComparator	Parses field's values as double (using LeafReader.getNumericDocValues(java.lang.String) and sorts by ascending value
FieldComparator.FloatComparator	Parses field's values as float (using LeafReader.getNumericDocValues(String) and sorts by ascending value
FieldComparator.IntComparator	Parses field's values as int (using LeafReader.getNumericDocValues(String) and sorts by ascending value
FieldComparator.LongComparator	Parses field's values as long (using LeafReader.getNumericDocValues(String) and sorts by ascending value
FieldComparator.NumericComparator<T extends Number>	Base FieldComparator class for numeric types
FieldComparator.RelevanceComparator	Sorts by descending relevance.
FieldComparator.TermOrdValComparator	Sorts by field's natural Term sort order, using ordinals.
FieldComparator.TermValComparator	Sorts by field's natural Term sort order.
FieldComparatorSource	Provides a FieldComparator for custom field sorting.
FieldDoc	Expert: A ScoreDoc which also contains information about how to sort the referenced document.
FieldValueHitQueue<T extends FieldValueHitQueue.Entry>	Expert: A hit queue for sorting by hits by terms in more than one field.
FieldValueHitQueue.Entry	Extension of ScoreDoc to also store the FieldComparator slot.
FilterCollector	Collector delegator.
FilteredDocIdSetIterator	Abstract decorator class of a DocIdSetIterator implementation that provides on-demand filter/validation mechanism on an underlying DocIdSetIterator.
FilterLeafCollector	LeafCollector delegator.
FilterMatchesIterator	A MatchesIterator that delegates all calls to another MatchesIterator
FilterScorable	Filter a Scorable, intercepting methods and optionally changing their return values The default implementation simply passes all calls to its delegate, with the exception of Scorable.setMinCompetitiveScore(float) which defaults to a no-op.
FilterScorer	A FilterScorer contains another Scorer, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.
FilterWeight	A FilterWeight contains another Weight and implements all abstract methods by calling the contained weight's method.
FuzzyQuery	Implements the fuzzy search query.
FuzzyTermsEnum	Subclass of TermsEnum for enumerating all terms that are similar to the specified filter term.
FuzzyTermsEnum.LevenshteinAutomataAttributeImpl	Stores compiled automata as a list (indexed by edit distance)
ImpactsDISI	DocIdSetIterator that skips non-competitive docs thanks to the indexed impacts.
IndexOrDocValuesQuery	A query that uses either an index structure (points or terms) or doc values in order to run a query, depending which one is more efficient.
IndexSearcher	Implements search over a single IndexReader.
IndexSearcher.LeafSlice	A class holding a subset of the IndexSearchers leaf contexts to be executed within a single thread.
LeafSimScorer	Similarity.SimScorer on a specific LeafReader.
LongValues	Per-segment, per-document long values, which can be calculated at search-time
LongValuesSource	Base class for producing LongValues To obtain a LongValues object for a leaf reader, clients should call LongValuesSource.rewrite(IndexSearcher) against the top-level searcher, and then LongValuesSource.getValues(LeafReaderContext, DoubleValues).
LRUQueryCache	A QueryCache that evicts queries using a LRU (least-recently-used) eviction policy in order to remain under a given maximum size and number of bytes used.
MatchAllDocsQuery	A query that matches all documents.
MatchesUtils	Contains static functions that aid the implementation of Matches and MatchesIterator interfaces.
MatchNoDocsQuery	A query that matches no documents.
MultiCollector	A Collector which allows running a search with several Collectors.
MultiPhraseQuery	A generalized version of PhraseQuery, with the possibility of adding more than one term at the same position that are treated as a disjunction (OR).
MultiPhraseQuery.Builder	A builder for multi-phrase queries
MultiTermQuery	An abstract Query that matches documents containing a subset of terms provided by a FilteredTermsEnum enumeration.
MultiTermQuery.RewriteMethod	Abstract class that defines how the query is rewritten.
MultiTermQuery.TopTermsBlendedFreqScoringRewrite	A rewrite method that first translates each term into BooleanClause.Occur.SHOULD clause in a BooleanQuery, but adjusts the frequencies used for scoring to be blended across the terms, otherwise the rarest term typically ranks highest (often not useful eg in the set of expanded terms in a FuzzyQuery).
MultiTermQuery.TopTermsBoostOnlyBooleanQueryRewrite	A rewrite method that first translates each term into BooleanClause.Occur.SHOULD clause in a BooleanQuery, but the scores are only computed as the boost.
MultiTermQuery.TopTermsScoringBooleanQueryRewrite	A rewrite method that first translates each term into BooleanClause.Occur.SHOULD clause in a BooleanQuery, and keeps the scores as computed by the query.
NormsFieldExistsQuery	A Query that matches documents that have a value for a given field as reported by field norms.
PhraseQuery	A Query that matches documents containing a particular sequence of terms.
PhraseQuery.Builder	A builder for phrase queries.
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 as IntPoint.
PrefixQuery	A Query that matches documents containing terms with a specified prefix.
Query	The abstract base class for queries.
QueryRescorer	A Rescorer that uses a provided Query to assign scores to the first-pass hits.
QueryVisitor	Allows recursion through a query tree
ReferenceManager<G>	Utility class to safely share instances of a certain type across multiple threads, while periodically refreshing them.
RegexpQuery	A fast regular expression query based on the org.apache.lucene.util.automaton package.
Rescorer	Re-scores the topN results (TopDocs) from an original query.
Scorable	Allows access to the score of a Query
Scorable.ChildScorable	A child Scorer and its relationship to its parent.
ScoreCachingWrappingScorer	A Scorer which wraps another scorer and caches the score of the current document.
ScoreDoc	Holds one hit in TopDocs.
Scorer	Expert: Common scoring functionality for different types of queries.
ScorerSupplier	A supplier of Scorer.
ScoringRewrite<B>	Base rewrite method that translates each term into a query, and keeps the scores as computed by the query.
SearcherFactory	Factory class used by SearcherManager to create new IndexSearchers.
SearcherManager	Utility class to safely share IndexSearcher instances across multiple threads, while periodically reopening.
SimpleCollector	Base Collector implementation that is used to collect all contexts.
SimpleFieldComparator<T>	Base FieldComparator implementation that is used for all contexts.
Sort	Encapsulates sort criteria for returned hits.
SortedNumericSelector	Selects a value from the document's list to use as the representative value
SortedNumericSortField	SortField for SortedNumericDocValues.
SortedSetSelector	Selects a value from the document's set to use as the representative value
SortedSetSortField	SortField for SortedSetDocValues.
SortField	Stores information about how to sort documents by terms in an individual field.
SynonymQuery	A query that treats multiple terms as synonyms.
SynonymQuery.Builder	A builder for SynonymQuery.
TermInSetQuery	Specialization for a disjunction over many terms that behaves like a ConstantScoreQuery over a BooleanQuery containing only BooleanClause.Occur.SHOULD clauses.
TermQuery	A Query that matches documents containing a term.
TermRangeQuery	A Query that matches documents within an range of terms.
TermStatistics	Contains statistics for a specific term
TopDocs	Represents hits returned by IndexSearcher.search(Query,int).
TopDocsCollector<T extends ScoreDoc>	A base class for all collectors that return a TopDocs output.
TopFieldCollector	A Collector that sorts by SortField using FieldComparators.
TopFieldDocs	Represents hits returned by IndexSearcher.search(Query,int,Sort).
TopScoreDocCollector	A Collector implementation that collects the top-scoring hits, returning them as a TopDocs.
TopTermsRewrite<B>	Base rewrite method for collecting only the top terms via a priority queue.
TotalHitCountCollector	Just counts the total number of hits.
TotalHits	Description of the total number of hits of a query.
TwoPhaseIterator	Returned by Scorer.twoPhaseIterator() to expose an approximation of a DocIdSetIterator.
UsageTrackingQueryCachingPolicy	A QueryCachingPolicy that tracks usage statistics of recently-used filters in order to decide on which filters are worth caching.
Weight	Expert: Calculate query weights and build query scorers.
Weight.DefaultBulkScorer	Just wraps a Scorer and performs top scoring using it.
WildcardQuery	Implements the wildcard search query.

Enum Summary

Enum	Description
BooleanClause.Occur	Specifies how clauses are to occur in matching documents.
ScoreMode	Different modes of search.
SortedNumericSelector.Type	Type of selection to perform.
SortedSetSelector.Type	Type of selection to perform.
SortField.Type	Specifies the type of the terms to be sorted, or special types such as CUSTOM
TotalHits.Relation	How the TotalHits.value should be interpreted.

Exception Summary

Exception	Description
BooleanQuery.TooManyClauses	Thrown when an attempt is made to add more than BooleanQuery.getMaxClauseCount() clauses.
CollectionTerminatedException	Throw this exception in LeafCollector.collect(int) to prematurely terminate collection of the current leaf.