Package org.apache.lucene.search

This package contains a single proximity query, TermAutomatonQuery.

See: Description

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.
FieldCache	Expert: Maintains caches of term values.
FieldCache.ByteParser	Deprecated
FieldCache.DoubleParser	Interface to parse doubles from document fields.
FieldCache.FloatParser	Interface to parse floats from document fields.
FieldCache.IntParser	Interface to parse ints from document fields.
FieldCache.LongParser	Interface to parse long from document fields.
FieldCache.Parser	Marker interface as super-interface to all parsers.
FieldCache.ShortParser	Deprecated
FuzzyTermsEnum.LevenshteinAutomataAttribute	reuses compiled automata across different segments, because they are independent of the index
MaxNonCompetitiveBoostAttribute	Add this Attribute to a fresh AttributeSource before calling MultiTermQuery.getTermsEnum(Terms,AttributeSource).
ReferenceManager.RefreshListener	Use to receive notification when a refresh has finished.
SearcherLifetimeManager.Pruner	See SearcherLifetimeManager.prune(org.apache.lucene.search.SearcherLifetimeManager.Pruner).

Class Summary

Class	Description
AssertingBulkOutOfOrderScorer	A crazy BulkScorer that wraps another BulkScorer but shuffles the order of the collected documents.
AssertingBulkScorer	Wraps a Scorer with additional checks
AssertingCollector	Wraps another Collector and checks that acceptsDocsOutOfOrder is respected.
AssertingIndexSearcher	Helper class that adds some extra checks to ensure correct usage of IndexSearcher and Weight.
AssertingQuery	Assertion-enabled query.
AssertingScorer	Wraps a Scorer with additional checks
AutomatonQuery	A Query that will match terms against a finite-state machine.
BaseExplanationTestCase	Tests primitive queries (ie: that rewrite to themselves) to insure they match the expected set of docs, and that the score of each match is equal to the value of the scores explanation.
BaseExplanationTestCase.ItemizedFilter	Convenience subclass of FieldCacheTermsFilter
BitsFilteredDocIdSet	This implementation supplies a filtered DocIdSet, that excludes all docids which are not in a Bits instance.
BooleanClause	A clause in a BooleanQuery.
BooleanQuery	A Query that matches documents matching boolean combinations of other queries, e.g.
BoostAttributeImpl	Implementation class for BoostAttribute.
BulkScorer	This class is used to score a range of documents at once, and is returned by Weight.bulkScorer(org.apache.lucene.index.AtomicReaderContext, boolean, org.apache.lucene.util.Bits).
CachingCollector	Caches all docs, and optionally also scores, coming from a search, and is then able to replay them to another collector.
CachingWrapperFilter	Wraps another Filter's result and caches it.
CheckHits	Utility class for asserting expected hits in tests.
CheckHits.ExplanationAsserter	Asserts that the score explanation for every document matching a query corresponds with the true score.
CheckHits.ExplanationAssertingSearcher	an IndexSearcher that implicitly checks hte explanation of every match whenever it executes a search.
CheckHits.SetCollector	Just collects document ids into a set.
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.
ComplexExplanation	Expert: Describes the score computation for document and query, and can distinguish a match independent of a positive value.
ConstantScoreQuery	A query that wraps another query or a filter and simply returns a constant score equal to the query boost for every document that matches the filter or query.
ControlledRealTimeReopenThread<T>	Utility class that runs a thread to manage periodicc reopens of a ReferenceManager, with methods to wait for a specific index changes to become visible.
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.
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.
DocTermOrdsRangeFilter	A range filter built on top of a cached multi-valued term field (in FieldCache).
DocTermOrdsRewriteMethod	Rewrites MultiTermQueries into a filter, using DocTermOrds for term enumeration.
Explanation	Expert: Describes the score computation for document and query.
FieldCache.Bytes	Field values as 8-bit signed bytes
FieldCache.CacheEntry	EXPERT: A unique Identifier/Description for each item in the FieldCache.
FieldCache.CreationPlaceholder	Placeholder indicating creation of this cache is currently in-progress.
FieldCache.Doubles	Field values as 64-bit doubles
FieldCache.Floats	Field values as 32-bit floats
FieldCache.Ints	Field values as 32-bit signed integers
FieldCache.Longs	Field values as 64-bit signed long integers
FieldCache.Shorts	Field values as 16-bit signed shorts
FieldCacheDocIdSet	Base class for DocIdSet to be used with FieldCache.
FieldCacheRangeFilter<T>	A range filter built on top of a cached single term field (in FieldCache).
FieldCacheRewriteMethod	Rewrites MultiTermQueries into a filter, using the FieldCache for term enumeration.
FieldCacheTermsFilter	A Filter that only accepts documents whose single term value in the specified field is contained in the provided set of allowed terms.
FieldComparator<T>	Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top results with TopFieldCollector.
FieldComparator.ByteComparator	Deprecated
FieldComparator.DocComparator	Sorts by ascending docID
FieldComparator.DoubleComparator	Parses field's values as double (using FieldCache.getDoubles(org.apache.lucene.index.AtomicReader, java.lang.String, boolean) and sorts by ascending value
FieldComparator.FloatComparator	Parses field's values as float (using FieldCache.getFloats(org.apache.lucene.index.AtomicReader, java.lang.String, boolean) and sorts by ascending value
FieldComparator.IntComparator	Parses field's values as int (using FieldCache.getInts(org.apache.lucene.index.AtomicReader, java.lang.String, boolean) and sorts by ascending value
FieldComparator.LongComparator	Parses field's values as long (using FieldCache.getLongs(org.apache.lucene.index.AtomicReader, java.lang.String, boolean) and sorts by ascending value
FieldComparator.NumericComparator<T extends Number>	Base FieldComparator class for numeric types
FieldComparator.RelevanceComparator	Sorts by descending relevance.
FieldComparator.ShortComparator	Deprecated
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.
FieldValueFilter	A Filter that accepts all documents that have one or more values in a given field.
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.
Filter	Abstract base class for restricting which documents may be returned during searching.
FilteredDocIdSet	Abstract decorator class for a DocIdSet implementation that provides on-demand filtering/validation mechanism on a given DocIdSet.
FilteredDocIdSetIterator	Abstract decorator class of a DocIdSetIterator implementation that provides on-demand filter/validation mechanism on an underlying DocIdSetIterator.
FilteredQuery	A query that applies a filter to the results of another query.
FilteredQuery.FilterStrategy	Abstract class that defines how the filter (DocIdSet) applied during document collection.
FilteredQuery.RandomAccessFilterStrategy	A FilteredQuery.FilterStrategy that conditionally uses a random access filter if the given DocIdSet supports random access (returns a non-null value from DocIdSet.bits()) and FilteredQuery.RandomAccessFilterStrategy.useRandomAccess(Bits, int) returns true.
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)
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.
LiveFieldValues<S,T>	Tracks live field values across NRT reader reopens.
MatchAllDocsQuery	A query that matches all documents.
MaxNonCompetitiveBoostAttributeImpl	Implementation class for MaxNonCompetitiveBoostAttribute.
MultiCollector	A Collector which allows running a search with several Collectors.
MultiPhraseQuery	MultiPhraseQuery is a generalized version of PhraseQuery, with an added method MultiPhraseQuery.add(Term[]).
MultiTermQuery	An abstract Query that matches documents containing a subset of terms provided by a FilteredTermsEnum enumeration.
MultiTermQuery.ConstantScoreAutoRewrite	A rewrite method that tries to pick the best constant-score rewrite method based on term and document counts from the query.
MultiTermQuery.RewriteMethod	Abstract class that defines how the query is rewritten.
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.
MultiTermQueryWrapperFilter<Q extends MultiTermQuery>	A wrapper for MultiTermQuery, that exposes its functionality as a Filter.
NGramPhraseQuery	This is a PhraseQuery which is optimized for n-gram phrase query.
NumericRangeFilter<T extends Number>	A Filter that only accepts numeric values within a specified range.
NumericRangeQuery<T extends Number>	A Query that matches numeric values within a specified range.
PhraseQuery	A Query that matches documents containing a particular sequence of terms.
PositiveScoresOnlyCollector	A Collector implementation which wraps another Collector and makes sure only documents with scores > 0 are collected.
PrefixFilter	A Filter that restricts search results to values that have a matching prefix in a given field.
PrefixQuery	A Query that matches documents containing terms with a specified prefix.
PrefixTermsEnum	Subclass of FilteredTermEnum for enumerating all terms that match the specified prefix filter term.
Query	The abstract base class for queries.
QueryRescorer	A Rescorer that uses a provided Query to assign scores to the first-pass hits.
QueryUtils	Utility class for sanity-checking queries.
QueryUtils.FCInvisibleMultiReader	This is a MultiReader that can be used for randomly wrapping other readers without creating FieldCache insanity.
QueryWrapperFilter	Constrains search results to only match those which also match a provided query.
RandomSimilarityProvider	Similarity implementation that randomizes Similarity implementations per-field.
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.
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.
Scorer.ChildScorer	A child Scorer and its relationship to its parent.
ScoringRewrite<Q extends Query>	Base rewrite method that translates each term into a query, and keeps the scores as computed by the query.
SearchEquivalenceTestBase	Simple base class for checking search equivalence.
SearcherFactory	Factory class used by SearcherManager to create new IndexSearchers.
SearcherLifetimeManager	Keeps track of current plus old IndexSearchers, closing the old ones once they have timed out.
SearcherLifetimeManager.PruneByAge	Simple pruner that drops any searcher older by more than the specified seconds, than the newest searcher.
SearcherManager	Utility class to safely share IndexSearcher instances across multiple threads, while periodically reopening.
ShardSearchingTestBase	Base test class for simulating distributed search across multiple shards.
ShardSearchingTestBase.SearcherAndVersion	An IndexSearcher and associated version (lease)
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.
SortField	Stores information about how to sort documents by terms in an individual field.
SortRescorer	A Rescorer that re-sorts according to a provided Sort.
TermAutomatonQuery	A proximity query that lets you express an automaton, whose transitions are terms, to match documents.
TermQuery	A Query that matches documents containing a term.
TermRangeFilter	A Filter that restricts search results to a range of term values in a given field.
TermRangeQuery	A Query that matches documents within an range of terms.
TermRangeTermsEnum	Subclass of FilteredTermEnum for enumerating all terms that match the specified range parameters.
TermStatistics	Contains statistics for a specific term
TimeLimitingCollector	The TimeLimitingCollector is used to timeout search requests that take longer than the maximum allowed search time limit.
TimeLimitingCollector.TimerThread	Thread used to timeout search requests.
TokenStreamToTermAutomatonQuery	Consumes a TokenStream and creates an TermAutomatonQuery where the transition labels are tokens from the TermToBytesRefAttribute.
TopDocs	Represents hits returned by IndexSearcher.search(Query,Filter,int) and 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,Filter,int,Sort).
TopScoreDocCollector	A Collector implementation that collects the top-scoring hits, returning them as a TopDocs.
TopTermsRewrite<Q extends Query>	Base rewrite method for collecting only the top terms via a priority queue.
TotalHitCountCollector	Just counts the total number of hits.
Weight	Expert: Calculate query weights and build query scorers.
WildcardQuery	Implements the wildcard search query.

Enum Summary

Enum	Description
BooleanClause.Occur	Specifies how clauses are to occur in matching documents.
SortedNumericSelector.Type	Type of selection to perform.
SortField.Type	Specifies the type of the terms to be sorted, or special types such as CUSTOM

Exception Summary

Exception	Description
BooleanQuery.TooManyClauses	Thrown when an attempt is made to add more than BooleanQuery.getMaxClauseCount() clauses.
CollectionTerminatedException	Throw this exception in Collector.collect(int) to prematurely terminate collection of the current leaf.
ShardSearchingTestBase.SearcherExpiredException	Thrown when the lease for a searcher has expired.
TimeLimitingCollector.TimeExceededException	Thrown when elapsed search time exceeds allowed search time.

Package org.apache.lucene.search Description

This package contains a single proximity query, TermAutomatonQuery.