| org.apache.lucene.search |
|
| Java Source File Name | Type | Comment |
| BaseTestRangeFilter.java | Class | |
| BooleanClause.java | Class | A clause in a BooleanQuery. |
| BooleanFilter.java | Class | A container Filter that allows Boolean composition of Filters. |
| BooleanFilterTest.java | Class | |
| BooleanQuery.java | Class | A Query that matches documents matching boolean combinations of other
queries, e.g. |
| BooleanScorer.java | Class | |
| BooleanScorer2.java | Class | An alternative to BooleanScorer that also allows a minimum number
of optional scorers that should match. |
| BoostingQuery.java | Class | The BoostingQuery class can be used to effectively demote results that match a given query. |
| CachingSpanFilter.java | Class | Wraps another SpanFilter's result and caches it. |
| CachingWrapperFilter.java | Class | Wraps another filter's result and caches it. |
| CachingWrapperFilterHelper.java | Class | A unit test helper class to test when the filter is getting cached and when it is not. |
| CheckHits.java | Class | |
| ComplexExplanation.java | Class | Expert: Describes the score computation for document and query, andcan distinguish a match independent of a positive value. |
| ConjunctionScorer.java | Class | Scorer for conjunctions, sets of queries, all of which are required. |
| ConstantScoreQuery.java | Class | A query that wraps a filter and simply returns a constant score equal to the
query boost for every document in the filter. |
| ConstantScoreRangeQuery.java | Class | A range query that returns a constant score equal to its boost for
all documents in the range.
It does not have an upper bound on the number of clauses covered in the range.
If an endpoint is null, it is said to be "open".
Either or both endpoints may be open. |
| DefaultSimilarity.java | Class | Expert: Default scoring implementation. |
| DisjunctionMaxQuery.java | Class | 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). |
| DisjunctionMaxScorer.java | Class | The Scorer for DisjunctionMaxQuery's. |
| DisjunctionSumScorer.java | Class | A Scorer for OR like queries, counterpart of ConjunctionScorer.
This Scorer implements
Scorer.skipTo(int) and uses skipTo() on the given Scorers. |
| DuplicateFilter.java | Class | |
| DuplicateFilterTest.java | Class | |
| ExactPhraseScorer.java | Class | |
| Explanation.java | Class | Expert: Describes the score computation for document and query. |
| ExtendedFieldCache.java | Interface | |
| ExtendedFieldCacheImpl.java | Class | |
| FieldCache.java | Interface | Expert: Maintains caches of term values. |
| FieldCacheImpl.java | Class | Expert: The default cache implementation, storing all values in memory. |
| FieldDoc.java | Class | Expert: A ScoreDoc which also contains information about
how to sort the referenced document. |
| FieldDocSortedHitQueue.java | Class | Expert: Collects sorted results from Searchable's and collates them. |
| FieldSortedHitQueue.java | Class | Expert: A hit queue for sorting by hits by terms in more than one field. |
| Filter.java | Class | Abstract base class providing a mechanism to restrict searches to a subset
of an index. |
| FilterClause.java | Class | A Filter that wrapped with an indication of how that filter
is used when composed with another filter. |
| FilteredQuery.java | Class | A query that applies a filter to the results of another query. |
| FilteredTermEnum.java | Class | Abstract class for enumerating a subset of all terms. |
| FilterManager.java | Class | Filter caching singleton. |
| FuzzyLikeThisQuery.java | Class | Fuzzifies ALL terms provided as strings and then picks the best n differentiating terms.
In effect this mixes the behaviour of FuzzyQuery and MoreLikeThis but with special consideration
of fuzzy scoring factors.
This generally produces good results for queries where users may provide details in a number of
fields and have no knowledge of boolean query syntax and also want a degree of fuzzy matching and
a fast query.
For each source term the fuzzy variants are held in a BooleanQuery with no coord factor (because
we are not looking for matches on multiple variants in any one doc). |
| FuzzyQuery.java | Class | Implements the fuzzy search query. |
| FuzzyTermEnum.java | Class | Subclass of FilteredTermEnum for enumerating all terms that are similiar
to the specified filter term.
Term enumerations are always ordered by Term.compareTo(). |
| Hit.java | Class | Wrapper used by
HitIterator to provide a lazily loaded hit
from
Hits . |
| HitCollector.java | Class | Lower-level search API. |
| HitIterator.java | Class | An iterator over
Hits that provides lazy fetching of each document.
Hits.iterator returns an instance of this class. |
| HitQueue.java | Class | |
| Hits.java | Class | A ranked list of documents, used to hold search results.
Caution: Iterate only over the hits needed. |
| IndexSearcher.java | Class | Implements search over a single IndexReader.
Applications usually need only call the inherited
IndexSearcher.search(Query) or
IndexSearcher.search(Query,Filter) methods. |
| MatchAllDocsQuery.java | Class | A query that matches all documents. |
| MockFilter.java | Class | |
| MultiPhraseQuery.java | Class | MultiPhraseQuery is a generalized version of PhraseQuery, with an added
method
MultiPhraseQuery.add(Term[]) . |
| MultiSearcher.java | Class | Implements search over a set of Searchables. |
| MultiTermQuery.java | Class | A
Query that matches documents containing a subset of terms provided
by a
FilteredTermEnum enumeration.
MultiTermQuery is not designed to be used by itself.
The reason being that it is not intialized with a
FilteredTermEnum enumeration. |
| NonMatchingScorer.java | Class | A scorer that matches no document at all. |
| ParallelMultiSearcher.java | Class | Implements parallel search over a set of Searchables. |
| PhrasePositions.java | Class | Position of a term in a document that takes into account the term offset within the phrase. |
| PhraseQuery.java | Class | A Query that matches documents containing a particular sequence of terms. |
| PhraseQueue.java | Class | |
| PhraseScorer.java | Class | Expert: Scoring functionality for phrase queries.
A document is considered matching if it contains the phrase-query terms
at "valid" positons. |
| PrefixFilter.java | Class | |
| PrefixQuery.java | Class | A Query that matches documents containing terms with a specified prefix. |
| Query.java | Class | The abstract base class for queries. |
| QueryFilter.java | Class | Constrains search results to only match those which also match a provided
query. |
| QueryTermVector.java | Class | |
| QueryUtils.java | Class | |
| QueryWrapperFilter.java | Class | Constrains search results to only match those which also match a provided
query. |
| RangeFilter.java | Class | A Filter that restricts search results to a range of values in a given
field. |
| RangeQuery.java | Class | A Query that matches documents within an exclusive range. |
| RemoteCachingWrapperFilter.java | Class | Provides caching of
Filter s themselves on the remote end of an RMI connection. |
| RemoteCachingWrapperFilterHelper.java | Class | A unit test helper class to help with RemoteCachingWrapperFilter testing and
assert that it is working correctly. |
| RemoteSearchable.java | Class | A remote searchable implementation. |
| ReqExclScorer.java | Class | A Scorer for queries with a required subscorer and an excluding (prohibited) subscorer. |
| ReqOptSumScorer.java | Class | A Scorer for queries with a required part and an optional part. |
| SampleComparable.java | Class | An example Comparable for use with the custom sort tests.
It implements a comparable for "id" sort of values which
consist of an alphanumeric part and a numeric part, such as:
ABC-123, A-1, A-7, A-100, B-99999
Such values cannot be sorted as strings, since A-100 needs
to come after A-7.
It could be argued that the "ids" should be rewritten as
A-0001, A-0100, etc. |
| ScoreDoc.java | Class | Expert: Returned by low-level search implementations. |
| ScoreDocComparator.java | Interface | Expert: Compares two ScoreDoc objects for sorting. |
| Scorer.java | Class | Expert: Common scoring functionality for different types of queries. |
| Searchable.java | Interface | The interface for search implementations.
Searchable is the abstract network protocol for searching. |
| Searcher.java | Class | An abstract base class for search implementations.
Implements the main search methods.
Note that you can only access Hits from a Searcher as long as it is
not yet closed, otherwise an IOException will be thrown. |
| Similarity.java | Class | Expert: Scoring API.
Subclasses implement search scoring.
The score of query q for document d correlates to the
cosine-distance or dot-product between document and query vectors in a
Vector Space Model (VSM) of Information Retrieval.
A document whose vector is closer to the query vector in that model is scored higher.
The score is computed as follows:
where
-
tf(t in d)
correlates to the term's frequency,
defined as the number of times term t appears in the currently scored document d.
Documents that have more occurrences of a given term receive a higher score.
The default computation for tf(t in d) in
org.apache.lucene.search.DefaultSimilarity.tf(float) DefaultSimilarity is:
-
idf(t) stands for Inverse Document Frequency.
|
| SimilarityDelegator.java | Class | Expert: Delegating scoring implementation. |
| SingleDocTestFilter.java | Class | |
| SloppyPhraseScorer.java | Class | |
| Sort.java | Class | Encapsulates sort criteria for returned hits.
The fields used to determine sort order must be carefully chosen.
Documents must contain a single term in such a field,
and the value of the term should indicate the document's relative position in
a given sort order. |
| SortComparator.java | Class | Abstract base class for sorting hits returned by a Query.
This class should only be used if the other SortField
types (SCORE, DOC, STRING, INT, FLOAT) do not provide an
adequate sorting. |
| SortComparatorSource.java | Interface | Expert: returns a comparator for sorting ScoreDocs. |
| SortField.java | Class | Stores information about how to sort documents by terms in an individual
field. |
| SpanFilter.java | Class | Abstract base class providing a mechanism to restrict searches to a subset
of an index and also maintains and returns position information.
This is useful if you want to compare the positions from a SpanQuery with the positions of items in
a filter. |
| SpanFilterResult.java | Class | The results of a SpanQueryFilter. |
| SpanQueryFilter.java | Class | Constrains search results to only match those which also match a provided
query. |
| TermQuery.java | Class | A Query that matches documents containing a term. |
| TermScorer.java | Class | Expert: A Scorer for documents matching a Term. |
| TermsFilter.java | Class | Constructs a filter for docs matching any of the terms added to this class. |
| TestBoolean2.java | Class | Test BooleanQuery2 against BooleanQuery by overriding the standard query parser. |
| TestBooleanMinShouldMatch.java | Class | Test that BooleanQuery.setMinimumNumberShouldMatch works. |
| TestBooleanOr.java | Class | Created on 2005. |
| TestBooleanPrefixQuery.java | Class | |
| TestBooleanQuery.java | Class | |
| TestBooleanScorer.java | Class | |
| TestCachingWrapperFilter.java | Class | |
| TestComplexExplanations.java | Class | TestExplanations subclass that builds up super crazy complex queries
on the assumption that if the explanations work out right for them,
they should work for anything. |
| TestComplexExplanationsOfNonMatches.java | Class | subclass of TestSimpleExplanations that verifies non matches. |
| TestConstantScoreRangeQuery.java | Class | |
| TestCustomSearcherSort.java | Class | Unit test for sorting code. |
| TestDateFilter.java | Class | DateFilter JUnit tests. |
| TestDateSort.java | Class | Test date sorting, i.e. |
| TestDisjunctionMaxQuery.java | Class | Test of the DisjunctionMaxQuery. |
| TestDocBoost.java | Class | Document boost unit test. |
| TestExplanations.java | Class | Tests primative 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. |
| TestExtendedFieldCache.java | Class | |
| TestFilteredQuery.java | Class | FilteredQuery JUnit tests. |
| TestFuzzyQuery.java | Class | Tests
FuzzyQuery . |
| TestMatchAllDocsQuery.java | Class | Tests MatchAllDocsQuery. |
| TestMultiPhraseQuery.java | Class | This class tests the MultiPhraseQuery class. |
| TestMultiSearcher.java | Class | Tests
MultiSearcher class. |
| TestMultiSearcherRanking.java | Class | Tests
MultiSearcher ranking, i.e. |
| TestMultiThreadTermVectors.java | Class | |
| TestNot.java | Class | Similarity unit test. |
| TestParallelMultiSearcher.java | Class | |
| TestPhrasePrefixQuery.java | Class | This class tests PhrasePrefixQuery class. |
| TestPhraseQuery.java | Class | Tests
PhraseQuery . |
| TestPositionIncrement.java | Class | Term position unit test. |
| TestPrefixFilter.java | Class | Tests
PrefixFilter class. |
| TestPrefixQuery.java | Class | Tests
PrefixQuery class. |
| TestQueryTermVector.java | Class | |
| TestRangeFilter.java | Class | A basic 'positive' Unit test class for the RangeFilter class.
NOTE: at the moment, this class only tests for 'positive' results,
it does not verify the results to ensure there are no 'false positives',
nor does it adequately test 'negative' results. |
| TestRangeQuery.java | Class | |
| TestRemoteCachingWrapperFilter.java | Class | Tests that the index is cached on the searcher side of things. |
| TestRemoteSearchable.java | Class | |
| TestScorerPerf.java | Class | |
| TestSearchHitsWithDeletions.java | Class | Test Hits searches with interleaved deletions. |
| TestSetNorm.java | Class | Document boost unit test. |
| TestSimilarity.java | Class | Similarity unit test. |
| TestSimpleExplanations.java | Class | |
| TestSimpleExplanationsOfNonMatches.java | Class | subclass of TestSimpleExplanations that verifies non matches. |
| TestSort.java | Class | Unit tests for sorting code. |
| TestSpanQueryFilter.java | Class | |
| TestTermScorer.java | Class | |
| TestTermVectors.java | Class | |
| TestThreadSafe.java | Class | |
| TestWildcard.java | Class | TestWildcard tests the '*' and '?' wildcard characters. |
| TopDocCollector.java | Class | A
HitCollector implementation that collects the top-scoring
documents, returning them as a
TopDocs . |
| TopDocs.java | Class | Expert: Returned by low-level search implementations. |
| TopFieldDocCollector.java | Class | A
HitCollector implementation that collects the top-sorting
documents, returning them as a
TopFieldDocs . |
| TopFieldDocs.java | Class | Expert: Returned by low-level sorted search implementations. |
| Weight.java | Interface | Expert: Calculate query weights and build query scorers.
The purpose of Weight is to make it so that searching does not modify
a Query, so that a Query instance can be reused. |
| WildcardQuery.java | Class | Implements the wildcard search query. |
| WildcardTermEnum.java | Class | Subclass of FilteredTermEnum for enumerating all terms that match the
specified wildcard filter term.
Term enumerations are always ordered by Term.compareTo(). |