| Class |
Description |
|
AnonymousClassScoreDocComparator
|
|
|
AnonymousClassScoreDocComparator1
|
|
|
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. {@link TermQuery}s, {@link PhraseQuery}s or other BooleanQuerys. |
|
BooleanQuery.TooManyClauses
|
Thrown when an attempt is made to add more than {@link #GetMaxClauseCount()} clauses. This typically happens if a PrefixQuery, FuzzyQuery, WildcardQuery, or RangeQuery is expanded to many terms during search. |
|
CachingWrapperFilter
|
Wraps another filter's result and caches it. The caching behavior is like {@link QueryFilter}. The purpose is to allow filters to simply filter, and then wrap with this class to add caching, keeping the two concerns decoupled yet composable. |
|
ComplexExplanation
|
Expert: Describes the score computation for document and query, andcan distinguish a match independent of a positive value. |
|
ConstantScoreQuery
|
A query that wraps a filter and simply returns a constant score equal to the query boost for every document in the filter. |
|
ConstantScoreQuery.ConstantScorer
|
|
|
ConstantScoreQuery.ConstantWeight
|
|
|
ConstantScoreRangeQuery
|
|
|
DefaultSimilarity
|
Expert: Default scoring implementation. |
|
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. This is useful when searching for a word in multiple fields with different boost factors (so that the fields cannot be combined equivalently into a single search field). We want the primary score to be the one associated with the highest boost, not the sum of the field scores (as BooleanQuery would give). If the query is "albino elephant" this ensures that "albino" matching one field and "elephant" matching another gets a higher score than "albino" matching both fields. To get this result, use both BooleanQuery and DisjunctionMaxQuery: for each term a DisjunctionMaxQuery searches for it in each field, while the set of these DisjunctionMaxQuery's is combined into a BooleanQuery. The tie breaker capability allows results that include the same term in multiple fields to be judged better than results that include this term in only the best of those multiple fields, without confusing this with the better case of two different terms in the multiple fields. |
|
Explanation
|
Expert: Describes the score computation for document and query. |
|
FieldDoc
|
|
|
FieldSortedHitQueue
|
|
|
Filter
|
Abstract base class providing a mechanism to restrict searches to a subset of an index. |
|
FilteredQuery
|
|
|
FilteredTermEnum
|
|
|
FuzzyQuery
|
Implements the fuzzy search query. The similiarity measurement is based on the Levenshtein (edit distance) algorithm. |
|
FuzzyQuery.ScoreTerm
|
|
|
FuzzyQuery.ScoreTermQueue
|
|
|
FuzzyTermEnum
|
|
|
Hit
|
Wrapper used by {@link HitIterator} to provide a lazily loaded hit from {@link Hits}. |
|
HitCollector
|
|
|
HitIterator
|
An iterator over {@link Hits} that provides lazy fetching of each document. {@link Hits#Iterator()} returns an instance of this class. Calls to {@link #Next()} return a {@link Hit} instance. |
|
Hits
|
A ranked list of documents, used to hold search results. |
|
IndexSearcher
|
|
|
MatchAllDocsQuery
|
A query that matches all documents. |
|
MultiPhraseQuery
|
MultiPhraseQuery is a generalized version of PhraseQuery, with an added method {@link #Add(Term[])}. To use this class, to search for the phrase "Microsoft app*" first use add(Term) on the term "Microsoft", then find all terms that have "app" as prefix using IndexReader.terms(Term), and use MultiPhraseQuery.add(Term[] terms) to add them to the query. |
|
MultiSearcher
|
|
|
MultiTermQuery
|
|
|
ParallelMultiSearcher
|
|
|
PhraseQuery
|
|
|
PrefixFilter
|
|
|
PrefixQuery
|
A Query that matches documents containing terms with a specified prefix. A PrefixQuery is built by QueryParser for input like app* . |
|
Query
|
|
|
QueryFilter
|
|
|
QueryTermVector
|
|
|
RangeFilter
|
A Filter that restricts search results to a range of values in a given field. This code borrows heavily from {@link RangeQuery}, but is implemented as a Filter
|
|
RangeQuery
|
A Query that matches documents within an exclusive range. A RangeQuery is built by QueryParser for input like [010 TO 120] but only if the QueryParser has the useOldRangeQuery property set to true. The QueryParser default behaviour is to use the newer ConstantScoreRangeQuery class. This is generally preferable because:
- It is faster than RangeQuery
- Unlike RangeQuery, it does not cause a BooleanQuery.TooManyClauses exception if the range of values is large
- Unlike RangeQuery it does not influence scoring based on the scarcity of individual terms that may match
|
|
RemoteSearchable
|
A remote searchable implementation. |
|
ReqExclScorer
|
|
|
ReqOptSumScorer
|
|
|
ScoreDoc
|
Expert: Returned by low-level search implementations. |
|
Scorer
|
|
|
Searcher
|
|
|
Similarity
|
|
|
SimilarityDelegator
|
Expert: Delegating scoring implementation. Useful in {@link Query#GetSimilarity(Searcher)} implementations, to override only certain methods of a Searcher's Similiarty implementation.. |
|
Sort
|
|
|
SortComparator
|
|
|
SortField
|
|
|
StringIndex
|
|
|
TermQuery
|
A Query that matches documents containing a term. This may be combined with other terms with a {@link BooleanQuery}. |
|
TopDocCollector
|
|
|
TopDocs
|
Expert: Returned by low-level search implementations. |
|
TopFieldDocCollector
|
|
|
TopFieldDocs
|
|
|
WildcardQuery
|
Implements the wildcard search query. Supported wildcards are * , which matches any character sequence (including the empty one), and ? , which matches any single character. Note this query can be slow, as it needs to iterate over many terms. In order to prevent extremely slow WildcardQueries, a Wildcard term should not start with one of the wildcards * or ? . |
|
WildcardTermEnum
|
|