Package | Description |
---|---|
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
See
org.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 |
Lucene 8.0 file format.
|
org.apache.lucene.document |
The logical representation of a
Document for indexing and searching. |
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.payloads |
Experimental classes for interacting with payloads
|
org.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.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 frameworks
|
org.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.intervals |
Intervals queries
|
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.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.
|
Class and Description |
---|
DocIdSetIterator
This abstract class defines methods to iterate over a set of non-decreasing
doc ids.
|
Class and Description |
---|
DocIdSetIterator
This abstract class defines methods to iterate over a set of non-decreasing
doc ids.
|
Class and Description |
---|
DocIdSetIterator
This abstract class defines methods to iterate over a set of non-decreasing
doc ids.
|
Class and Description |
---|
DocIdSetIterator
This abstract class defines methods to iterate over a set of non-decreasing
doc ids.
|
Class and Description |
---|
DocIdSetIterator
This abstract class defines methods to iterate over a set of non-decreasing
doc ids.
|
Class and 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.
|
FieldComparator
Expert: a FieldComparator compares hits so as to determine their
sort order when collecting the top results with
TopFieldCollector . |
IndexSearcher
Implements search over a single IndexReader.
|
LeafFieldComparator
Expert: comparator that gets instantiated on each leaf
from a top-level
FieldComparator instance. |
Query
The abstract base class for queries.
|
QueryVisitor
Allows recursion through a query tree
|
Scorable
Allows access to the score of a Query
|
ScoreMode
Different modes of search.
|
Scorer
Expert: Common scoring functionality for different types of queries.
|
ScorerSupplier
A supplier of
Scorer . |
SortField
Stores information about how to sort documents by terms in an individual
field.
|
TopFieldDocs
Represents hits returned by
IndexSearcher.search(Query,int,Sort) . |
Weight
Expert: Calculate query weights and build query scorers.
|
Class and 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.
|
SortField.Type
Specifies the type of the terms to be sorted, or special types such as CUSTOM
|
Weight
Expert: Calculate query weights and build query scorers.
|
Class and 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.
|
Class and Description |
---|
Query
The abstract base class for queries.
|
Class and 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
|
Class and 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-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
Expert: a FieldComparator compares hits so as to determine their
sort order when collecting the top results with
TopFieldCollector . |
FieldComparatorSource
Provides a
FieldComparator for custom field sorting. |
IndexSearcher
Implements search over a single IndexReader.
|
LeafFieldComparator
Expert: comparator that gets instantiated on each leaf
from a top-level
FieldComparator instance. |
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) . |
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) . |
Query
The abstract base class for queries.
|
QueryVisitor
Allows recursion through a query tree
|
Scorable
Allows access to the score of a Query
|
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 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. |
SimpleFieldComparator
Base
FieldComparator implementation that is used for all contexts. |
SortField
Stores information about how to sort documents by terms in an individual
field.
|
TwoPhaseIterator
Returned by
Scorer.twoPhaseIterator()
to expose an approximation of a DocIdSetIterator . |
Weight
Expert: Calculate query weights and build query scorers.
|
Class and Description |
---|
Weight
Expert: Calculate query weights and build query scorers.
|
Class and 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.
|
Weight
Expert: Calculate query weights and build query scorers.
|
Class and Description |
---|
Query
The abstract base class for queries.
|
QueryVisitor
Allows recursion through a query tree
|
Class and 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 specific LeafReader . |
Query
The abstract base class for queries.
|
QueryVisitor
Allows recursion through a query tree
|
Scorable
Allows access to the score of a Query
|
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 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. |
Weight
Expert: Calculate query weights and build query scorers.
|
Class and 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.
|
Class and 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 tree
|
SynonymQuery
A query that treats multiple terms as synonyms.
|
Class and Description |
---|
Query
The abstract base class for queries.
|
Class and 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.
|
Class and 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 of
PhraseQuery , 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 the
org.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.
|
Class and Description |
---|
MultiTermQuery.RewriteMethod
Abstract class that defines how the query is rewritten.
|
Class and 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.
|
Class and 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 tree
|
TermQuery
A Query that matches documents containing a term.
|
Class and Description |
---|
Query
The abstract base class for queries.
|
Class and Description |
---|
BooleanClause.Occur
Specifies how clauses are to occur in matching documents.
|
Query
The abstract base class for queries.
|
Class and Description |
---|
Query
The abstract base class for queries.
|
QueryVisitor
Allows recursion through a query tree
|
Class and 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.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. |
BM25FQuery
A
Query 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 for
BM25FQuery . |
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.
|
BoostAttribute
Add this
Attribute to a TermsEnum returned by MultiTermQuery.getTermsEnum(Terms,AttributeSource)
and update the boost on each returned term. |
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) . |
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 in
DisiPriorityQueue . |
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.
|
DisjunctionScorer
Base class for Scorers that score disjunctions.
|
DisjunctionScorer.TwoPhase |
DiversifiedTopDocsCollector.ScoreDocKey
An extension to ScoreDoc that includes a key used for grouping purposes
|
DiversifiedTopDocsCollector.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
Like
DocValuesTermsQuery , but this query only
runs on a long NumericDocValuesField or a
SortedNumericDocValuesField , 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
A
Query 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-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. |
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 with
TopFieldCollector . |
FieldComparator.NumericComparator
Base FieldComparator class for numeric types
|
FieldComparator.RelevanceComparator
Sorts by descending relevance.
|
FieldComparatorSource
Provides a
FieldComparator 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 the
FieldComparator slot. |
FilterCollector
Collector delegator. |
FilterLeafCollector
LeafCollector delegator. |
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. |
FuzzyTermsEnum.LevenshteinAutomataAttribute
reuses compiled automata across different segments,
because they are independent of the index
|
ImpactsDISI
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 the
IndexSearcher 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-level
FieldComparator instance. |
LeafSimScorer
Similarity.SimScorer on a specific LeafReader . |
LongHashSet |
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) . |
LongValuesSource.LongValuesHolder |
LRUQueryCache.LeafCache |
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) . |
MaxScoreCache
Compute maximum scores based on
Impacts 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 in
BooleanQuery , which
compute the score as the sum of the scores of its matching clauses. |
MultiCollectorManager.Collectors |
MultiNormsLeafSimScorer
Copy of
LeafSimScorer that sums document's norms from multiple fields. |
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
|
MultiPhraseQuery.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.
|
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.
|
NearestNeighbor.Cell |
NearestNeighbor.NearestHit |
NGramPhraseQuery
This is a
PhraseQuery which is optimized for n-gram phrase query. |
PhraseMatcher
Base class for exact and sloppy phrase matching
To find matches on a document, first advance
PhraseMatcher.approximation to the
relevant document, then call PhraseMatcher.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 |
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 . |
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 tree
|
ReferenceManager
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 Query
|
Scorable.ChildScorable
A child Scorer and its relationship to its parent.
|
ScoreAndDoc
Used by
BulkScorer s that need to pass a Scorable to LeafCollector.setScorer(org.apache.lucene.search.Scorable) . |
ScoreDoc
Holds one hit in
TopDocs . |
ScoreMode
Different modes of search.
|
Scorer
Expert: Common scoring functionality for different types of queries.
|
ScorerSupplier
A supplier of
Scorer . |
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 docFreq
|
SearcherFactory
Factory class used by
SearcherManager to
create new IndexSearchers. |
SearcherLifetimeManager.Pruner |
SearcherLifetimeManager.SearcherTracker |
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. |
SimpleCollector
Base
Collector implementation that is used to collect all contexts. |
SimpleFieldComparator
Base
FieldComparator 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 CUSTOM
|
SynonymQuery
A query that treats multiple terms as synonyms.
|
SynonymQuery.Builder
A builder for
SynonymQuery . |
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 a
ConstantScoreQuery over a BooleanQuery containing only
BooleanClause.Occur.SHOULD clauses. |
TermRangeQuery
A Query that matches documents within an range of terms.
|
TermScorer
Expert: A
Scorer for documents matching a Term . |
TermStatistics
Contains statistics for a specific term
|
TimeLimitingCollector.TimerThread
Thread used to timeout search requests.
|
TopDocs
Represents hits returned by
IndexSearcher.search(Query,int) . |
TopDocs.ShardRef |
TopDocsCollector
A base class for all collectors that return a
TopDocs output. |
TopFieldCollector |
TopFieldDocs
Represents hits returned by
IndexSearcher.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 the
TotalHits.value should be interpreted. |
TwoPhaseIterator
Returned by
Scorer.twoPhaseIterator()
to expose an approximation of a DocIdSetIterator . |
Weight
Expert: Calculate query weights and build query scorers.
|
Class and 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.
|
FieldComparator
Expert: a FieldComparator compares hits so as to determine their
sort order when collecting the top results with
TopFieldCollector . |
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-level
FieldComparator instance. |
Query
The abstract base class for queries.
|
Scorable
Allows access to the score of a Query
|
ScoreDoc
Holds one hit in
TopDocs . |
ScoreMode
Different modes of search.
|
SimpleCollector
Base
Collector 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 a
TopDocs output. |
TotalHits
Description of the total number of hits of a query.
|
Weight
Expert: Calculate query weights and build query scorers.
|
Class and 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
|
Class and 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 MatchesIterator
|
IndexSearcher
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 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. |
Query
The abstract base class for queries.
|
QueryVisitor
Allows recursion through a query tree
|
Scorable
Allows access to the score of a Query
|
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 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. |
TwoPhaseIterator
Returned by
Scorer.twoPhaseIterator()
to expose an approximation of a DocIdSetIterator . |
Weight
Expert: Calculate query weights and build query scorers.
|
Class and 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 with
TopFieldCollector . |
FilterWeight
A
FilterWeight contains another Weight 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 a
MatchesIterator for a particular field, call Matches.getMatches(String) . |
MultiTermQuery
An abstract
Query that matches documents
containing a subset of terms provided by a FilteredTermsEnum enumeration. |
PointInSetQuery.Stream
Iterator of encoded point values.
|
Query
The abstract base class for queries.
|
QueryVisitor
Allows recursion through a query tree
|
Scorable
Allows access to the score of a Query
|
Scorable.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 of
Scorer . |
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. |
SimpleCollector
Base
Collector 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 CUSTOM
|
TwoPhaseIterator
Returned by
Scorer.twoPhaseIterator()
to expose an approximation of a DocIdSetIterator . |
Weight
Expert: Calculate query weights and build query scorers.
|
Class and 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
|
Class and Description |
---|
CollectionStatistics
Contains statistics for a collection (field).
|
TermStatistics
Contains statistics for a specific term
|
Class and 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 specific LeafReader . |
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) . |
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.
|
Query
The abstract base class for queries.
|
QueryVisitor
Allows recursion through a query tree
|
Scorable
Allows access to the score of a Query
|
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 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. |
TopTermsRewrite
Base rewrite method for collecting only the top terms
via a priority queue.
|
TwoPhaseIterator
Returned by
Scorer.twoPhaseIterator()
to expose an approximation of a DocIdSetIterator . |
Weight
Expert: Calculate query weights and build query scorers.
|
Class and 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, call
MatchesIterator.next() until it returns false , retrieving
positions and/or offsets after each call. |
Query
The abstract base class for queries.
|
QueryVisitor
Allows recursion through a query tree
|
TopDocs
Represents hits returned by
IndexSearcher.search(Query,int) . |
Class and Description |
---|
PhraseQuery
A Query that matches documents containing a particular sequence of terms.
|
Query
The abstract base class for queries.
|
Class and 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 queries
|
Query
The abstract base class for queries.
|