Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Namespaces | Classes | Enumerations
Package Lucene.Net.Search

Namespaces

package  Function
 
package  Highlight
 
package  Payloads
 
package  Similar
 
package  Spans
 
package  Vectorhighlight
 

Classes

class  BooleanFilter
 
class  BoostingQuery
 The BoostingQuery class can be used to effectively demote results that match a given query. Unlike the "NOT" clause, this still selects documents that contain undesirable terms, but reduces their overall score: More...
 
class  DuplicateFilter
 
class  FilterClause
 
class  FuzzyLikeThisQuery
 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. More...
 
class  TermsFilter
 A filter that contains multiple terms. More...
 
class  Extensions
 
class  SimpleFacetedSearch
 
class  FieldValuesBitSets
 
class  BooleanClause
 A clause in a BooleanQuery. More...
 
class  OccurExtensions
 
class  BooleanQuery
 A Query that matches documents matching boolean combinations of other queries, e.g. TermQuerys, PhraseQuerys or other BooleanQuerys. More...
 
class  BooleanScorer
 
class  BooleanScorer2
 An alternative to BooleanScorer that also allows a minimum number of optional scorers that should match.
Implements skipTo(), and has no limitations on the numbers of added scorers.
Uses ConjunctionScorer, DisjunctionScorer, ReqOptScorer and ReqExclScorer. More...
 
class  CachingSpanFilter
 Wraps another SpanFilter's result and caches it. The purpose is to allow filters to simply filter, and then wrap with this class to add caching. More...
 
class  CachingWrapperFilter
 Wraps another filter's result and caches it. The purpose is to allow filters to simply filter, and then wrap with this class to add caching. More...
 
class  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. More...
 
class  ComplexExplanation
 Expert: Describes the score computation for document and query, and can distinguish a match independent of a positive value. More...
 
class  ConjunctionScorer
 Scorer for conjunctions, sets of queries, all of which are required. More...
 
class  ConstantScoreQuery
 A query that wraps a filter and simply returns a constant score equal to the query boost for every document in the filter. More...
 
class  DefaultSimilarity
 Expert: Default scoring implementation. More...
 
class  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. More...
 
class  DisjunctionMaxScorer
 The Scorer for DisjunctionMaxQuery's. The union of all documents generated by the the subquery scorers is generated in document number order. The score for each document is the maximum of the scores computed by the subquery scorers that generate that document, plus tieBreakerMultiplier times the sum of the scores for the other subqueries that generate the document. More...
 
class  DisjunctionSumScorer
 A Scorer for OR like queries, counterpart of ConjunctionScorer. This Scorer implements DocIdSetIterator.Advance(int) and uses skipTo() on the given Scorers. More...
 
class  DocIdSet
 A DocIdSet contains a set of doc ids. Implementing classes must only implement Iterator to provide access to the set. More...
 
class  DocIdSetIterator
 This abstract class defines methods to iterate over a set of non-decreasing doc ids. Note that this class assumes it iterates on doc Ids, and therefore NO_MORE_DOCS is set to Int32.MaxValue in order to be used as a sentinel object. Implementations of this class are expected to consider int.MaxValue as an invalid value. More...
 
class  ExactPhraseScorer
 
class  Explanation
 Expert: Describes the score computation for document and query. More...
 
class  CreationPlaceholder
 Expert: Maintains caches of term values. More...
 
class  StringIndex
 Expert: Stores term text values and document ordering data. More...
 
class  CacheEntry
 EXPERT: A unique Identifier/Description for each item in the FieldCache. Can be useful for logging/debugging. EXPERIMENTAL API: This API is considered extremely advanced and experimental. It may be removed or altered w/o warning in future releases of Lucene. More...
 
struct  FieldCache_Fields
 
class  AnonymousClassByteParser
 
class  AnonymousClassShortParser
 
class  AnonymousClassIntParser
 
class  AnonymousClassFloatParser
 
class  AnonymousClassLongParser
 
class  AnonymousClassDoubleParser
 
class  AnonymousClassIntParser1
 
class  AnonymousClassFloatParser1
 
class  AnonymousClassLongParser1
 
class  AnonymousClassDoubleParser1
 
interface  FieldCache
 
interface  Parser
 Marker interface as super-interface to all parsers. It is used to specify a custom parser to SortField(String, Parser). More...
 
interface  ByteParser
 Interface to parse bytes from document fields. More...
 
interface  ShortParser
 Interface to parse shorts from document fields. More...
 
interface  IntParser
 Interface to parse ints from document fields. More...
 
interface  FloatParser
 Interface to parse floats from document fields. More...
 
interface  LongParser
 Interface to parse long from document fields. More...
 
interface  DoubleParser
 Interface to parse doubles from document fields. More...
 
class  FieldCacheImpl
 Expert: The default cache implementation, storing all values in memory. A WeakDictionary is used for storage. More...
 
class  FieldCacheRangeFilter
 A range filter built on top of a cached single term field (in FieldCache).
 
class  FieldCacheRangeFilter< T >
 
class  FieldCacheTermsFilter
 A Filter that only accepts documents whose single term value in the specified field is contained in the provided set of allowed terms. More...
 
class  FieldComparator
 Expert: a FieldComparator compares hits so as to determine their sort order when collecting the top results with TopFieldCollector . The concrete public FieldComparator classes here correspond to the SortField types. More...
 
class  FieldComparatorSource
 Provides a FieldComparator for custom field sorting. More...
 
class  FieldDoc
 Expert: A ScoreDoc which also contains information about how to sort the referenced document. In addition to the document number and score, this object contains an array of values for the document from the field(s) used to sort. For example, if the sort criteria was to sort by fields "a", "b" then "c", the fields object array will have three elements, corresponding respectively to the term values for the document in fields "a", "b" and "c". The class of each element in the array will be either Integer, Float or String depending on the type of values in the terms of each field. More...
 
class  FieldDocSortedHitQueue
 Expert: Collects sorted results from Searchable's and collates them. The elements put into this queue must be of type FieldDoc. More...
 
class  FieldValueHitQueue
 Expert: A hit queue for sorting by hits by terms in more than one field. Uses FieldCache.DEFAULT for maintaining internal term lookup tables. More...
 
class  Filter
 Abstract base class for restricting which documents may be returned during searching. More...
 
class  FilteredDocIdSet
 Abstract decorator class for a DocIdSet implementation that provides on-demand filtering/validation mechanism on a given DocIdSet. More...
 
class  FilteredDocIdSetIterator
 Abstract decorator class of a DocIdSetIterator implementation that provides on-demand filter/validation mechanism on an underlying DocIdSetIterator. See FilteredDocIdSet More...
 
class  FilteredQuery
 A query that applies a filter to the results of another query. More...
 
class  FilteredTermEnum
 Abstract class for enumerating a subset of all terms. Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it. More...
 
class  FilterManager
 Filter caching singleton. It can be used to save filters locally for reuse. This class makes it possble to cache Filters even when using RMI, as it keeps the cache on the seaercher side of the RMI connection. More...
 
class  FuzzyQuery
 Implements the fuzzy search query. The similarity measurement is based on the Levenshtein (edit distance) algorithm. More...
 
class  FuzzyTermEnum
 Subclass of FilteredTermEnum for enumerating all terms that are similiar to the specified filter term. More...
 
class  HitQueue
 
class  IndexSearcher
 Implements search over a single IndexReader. More...
 
class  MatchAllDocsQuery
 A query that matches all documents. More...
 
class  MultiPhraseQuery
 MultiPhraseQuery is a generalized version of PhraseQuery, with an added method 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. More...
 
class  MultiSearcher
 Implements search over a set of Searchables. More...
 
class  MultiTermQuery
 An abstract Query that matches documents containing a subset of terms provided by a FilteredTermEnum enumeration. More...
 
class  RewriteMethod
 Abstract class that defines how the query is rewritten. More...
 
class  MultiTermQueryWrapperFilter< T >
 A wrapper for MultiTermQuery, that exposes its functionality as a Filter. MultiTermQueryWrapperFilter is not designed to be used by itself. Normally you subclass it to provide a Filter counterpart for a MultiTermQuery subclass. For example, TermRangeFilter and PrefixFilter extend MultiTermQueryWrapperFilter. This class also provides the functionality behind MultiTermQuery.CONSTANT_SCORE_FILTER_REWRITE; this is why it is not abstract. More...
 
class  NumericRangeFilter< T >
 A Filter that only accepts numeric values within a specified range. To use this, you must first index the numeric values using NumericField (expert: NumericTokenStream ). More...
 
class  NumericRangeFilter
 
class  NumericRangeQuery< T >
 A Query that matches numeric values within a specified range. To use this, you must first index the numeric values using NumericField (expert: NumericTokenStream ). If your terms are instead textual, you should use TermRangeQuery. NumericRangeFilter{T} is the filter equivalent of this query. More...
 
class  NumericRangeQuery
 
class  ParallelMultiSearcher
 Implements parallel search over a set of Searchables. More...
 
class  PhrasePositions
 Position of a term in a document that takes into account the term offset within the phrase. More...
 
class  PhraseQuery
 A Query that matches documents containing a particular sequence of terms. A PhraseQuery is built by QueryParser for input like "new york". More...
 
class  PhraseQueue
 
class  PhraseScorer
 Expert: Scoring functionality for phrase queries.
A document is considered matching if it contains the phrase-query terms at "valid" positons. What "valid positions" are depends on the type of the phrase query: for an exact phrase query terms are required to appear in adjacent locations, while for a sloppy phrase query some distance between the terms is allowed. The abstract method PhraseFreq() of extending classes is invoked for each document containing all the phrase query terms, in order to compute the frequency of the phrase query in that document. A non zero frequency means a match. More...
 
class  PositiveScoresOnlyCollector
 A Collector implementation which wraps another Collector and makes sure only documents with scores > 0 are collected. More...
 
class  PrefixFilter
 A Filter that restricts search results to values that have a matching prefix in a given field. More...
 
class  PrefixQuery
 A Query that matches documents containing terms with a specified prefix. A PrefixQuery is built by QueryParser for input like app*. More...
 
class  PrefixTermEnum
 Subclass of FilteredTermEnum for enumerating all terms that match the specified prefix filter term. Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it. More...
 
class  Query
 The abstract base class for queries. Instantiable subclasses are:

A parser for queries is contained in:

More...
 
class  QueryTermVector
  More...
 
class  QueryWrapperFilter
 Constrains search results to only match those which also match a provided query. More...
 
class  ReqExclScorer
 A Scorer for queries with a required subscorer and an excluding (prohibited) sub DocIdSetIterator.
This Scorer implements DocIdSetIterator.Advance(int), and it uses the skipTo() on the given scorers. More...
 
class  ReqOptSumScorer
 A Scorer for queries with a required part and an optional part. Delays skipTo() on the optional part until a score() is needed.
This Scorer implements DocIdSetIterator.Advance(int). More...
 
class  ScoreCachingWrappingScorer
 A Scorer which wraps another scorer and caches the score of the current document. Successive calls to Score() will return the same result and will not invoke the wrapped Scorer's score() method, unless the current document has changed.
This class might be useful due to the changes done to the Collector interface, in which the score is not computed for a document by default, only if the collector requests it. Some collectors may need to use the score in several places, however all they have in hand is a Scorer object, and might end up computing the score of a document more than once. More...
 
class  ScoreDoc
 Expert: Returned by low-level search implementations. More...
 
class  Scorer
 Expert: Common scoring functionality for different types of queries. More...
 
interface  Searchable
 The interface for search implementations. More...
 
class  Searcher
 An abstract base class for search implementations. Implements the main search methods. More...
 
class  Similarity
 Expert: Scoring API. Subclasses implement search scoring. More...
 
class  SimilarityDelegator
 Expert: Delegating scoring implementation. Useful in Query.GetSimilarity(Searcher) implementations, to override only certain methods of a Searcher's Similiarty implementation.. More...
 
class  SingleTermEnum
 Subclass of FilteredTermEnum for enumerating a single term. This can be used by MultiTermQuerys that need only visit one term, but want to preserve MultiTermQuery semantics such as RewriteMethod. More...
 
class  SloppyPhraseScorer
 
class  Sort
 Encapsulates sort criteria for returned hits. More...
 
class  SortField
 Stores information about how to sort documents by terms in an individual field. Fields must be indexed in order to sort by them. More...
 
class  SpanFilter
 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. For instance, if you had a SpanFilter that marked all the occurrences of the word "foo" in documents, and then you entered a new SpanQuery containing bar, you could not only filter by the word foo, but you could then compare position information for post processing. More...
 
class  SpanFilterResult
 The results of a SpanQueryFilter. Wraps the BitSet and the position information from the SpanQuery More...
 
class  SpanQueryFilter
 Constrains search results to only match those which also match a provided query. Also provides position information about where each document matches at the cost of extra space compared with the QueryWrapperFilter. There is an added cost to this above what is stored in a QueryWrapperFilter. Namely, the position information for each matching document is stored. This filter does not cache. See the Lucene.Net.Search.CachingSpanFilter for a wrapper that caches. More...
 
class  TermQuery
 A Query that matches documents containing a term. This may be combined with other terms with a BooleanQuery. More...
 
class  TermRangeFilter
 A Filter that restricts search results to a range of values in a given field. More...
 
class  TermRangeQuery
 A Query that matches documents within an exclusive range of terms. More...
 
class  TermRangeTermEnum
 Subclass of FilteredTermEnum for enumerating all terms that match the specified range parameters. Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it. More...
 
class  TermScorer
 Expert: A Scorer for documents matching a Term. More...
 
class  TimeLimitingCollector
 The TimeLimitingCollector is used to timeout search requests that take longer than the maximum allowed search time limit. After this time is exceeded, the search thread is stopped by throwing a TimeExceededException. More...
 
class  TopDocs
 Represents hits returned by Searcher.Search(Query,Filter,int) and Searcher.Search(Query,int) More...
 
class  TopDocsCollector< T >
 A base class for all collectors that return a Lucene.Net.Search.TopDocs output. This collector allows easy extension by providing a single constructor which accepts a PriorityQueue{T} as well as protected members for that priority queue and a counter of the number of total hits.
Extending classes can override TopDocs(int, int) and TotalHits in order to provide their own implementation. More...
 
class  TopFieldCollector
 A Collector that sorts by SortField using FieldComparators. See the Create method for instantiating a TopFieldCollector. More...
 
class  TopFieldDocs
 Represents hits returned by Searcher.Search(Query,Filter,int,Sort). More...
 
class  TopScoreDocCollector
 A Collector implementation that collects the top-scoring hits, returning them as a TopDocs. This is used by IndexSearcher to implement TopDocs-based search. Hits are sorted by score descending and then (when the scores are tied) docID ascending. When you create an instance of this collector you should know in advance whether documents are going to be collected in doc Id order or not. More...
 
class  Weight
 Expert: Calculate query weights and build query scorers. The purpose of Weight is to ensure searching does not modify a Query, so that a Query instance can be reused.
Searcher dependent state of the query should reside in the Weight.
IndexReader dependent state should reside in the Scorer. A Weight is used in the following way:

More...
 
class  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 ?. More...
 
class  WildcardTermEnum
 Subclass of FilteredTermEnum for enumerating all terms that match the specified wildcard filter term. Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it. More...
 

Enumerations

enum  Occur { MUST, SHOULD, MUST_NOT }
 

Enumeration Type Documentation

Enumerator
MUST 
SHOULD 
MUST_NOT 

Definition at line 84 of file BooleanClause.cs.