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
Public Member Functions | Properties | List of all members
Lucene.Net.Search.PrefixQuery Class Reference

A Query that matches documents containing terms with a specified prefix. A PrefixQuery is built by QueryParser for input like app*. More...

Inherits Lucene.Net.Search.MultiTermQuery.

Public Member Functions

 PrefixQuery (Term prefix)
 Constructs a query for terms starting with prefix.
 
override System.String ToString (System.String field)
 Prints a user-readable version of this query.
 
override int GetHashCode ()
 
override bool Equals (System.Object obj)
 
- Public Member Functions inherited from Lucene.Net.Search.MultiTermQuery
virtual void ClearTotalNumberOfTerms ()
 Expert: Resets the counting of unique terms. Do this before executing the query/filter.
 
override Query Rewrite (IndexReader reader)
 Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.
 
override int GetHashCode ()
 
override bool Equals (System.Object obj)
 
- Public Member Functions inherited from Lucene.Net.Search.Query
override System.String ToString ()
 Prints a query to a string.
 
virtual Weight CreateWeight (Searcher searcher)
 Expert: Constructs an appropriate Weight implementation for this query.
 
virtual Weight Weight (Searcher searcher)
 Expert: Constructs and initializes a Weight for a top-level query.
 
virtual Query Combine (Query[] queries)
 Expert: called when re-writing queries under MultiSearcher.
 
virtual void ExtractTerms (System.Collections.Generic.ISet< Term > terms)
 Expert: adds all terms occuring in this query to the terms set. Only works if this query is in its rewritten form.
 
virtual Similarity GetSimilarity (Searcher searcher)
 Expert: Returns the Similarity implementation to be used for this query. Subclasses may override this method to specify their own Similarity implementation, perhaps one that delegates through that of the Searcher. By default the Searcher's Similarity implementation is returned.
 
virtual System.Object Clone ()
 Returns a clone of this query.
 
override int GetHashCode ()
 
override bool Equals (System.Object obj)
 

Properties

virtual Term Prefix [get]
 Returns the prefix of this query.
 
- Properties inherited from Lucene.Net.Search.MultiTermQuery
virtual int TotalNumberOfTerms [get]
 Expert: Return the number of unique terms visited during execution of the query. If there are many of them, you may consider using another query type or optimize your total term count in index. This method is not thread safe, be sure to only call it when no query is running! If you re-use the same query instance for another search, be sure to first reset the term counter with ClearTotalNumberOfTerms. On optimized indexes / no MultiReaders, you get the correct number of unique terms for the whole index. Use this number to compare different queries. For non-optimized indexes this number can also be achived in non-constant-score mode. In constant-score mode you get the total number of terms seeked for all segments / sub-readers.
 
virtual RewriteMethod RewriteMethod [get, set]
 Sets the rewrite method to be used when executing the query. You can use one of the four core methods, or implement your own subclass of Search.RewriteMethod.
 
- Properties inherited from Lucene.Net.Search.Query
virtual float Boost [get, set]
 Gets or sets the boost for this query clause to b. Documents matching this clause will (in addition to the normal weightings) have their score multiplied by b. The boost is 1.0 by default.
 

Additional Inherited Members

- Static Public Member Functions inherited from Lucene.Net.Search.Query
static Query MergeBooleanQueries (params BooleanQuery[] queries)
 Expert: merges the clauses of a set of BooleanQuery's into a single BooleanQuery.
 
- Static Public Attributes inherited from Lucene.Net.Search.MultiTermQuery
static readonly RewriteMethod CONSTANT_SCORE_FILTER_REWRITE = new ConstantScoreFilterRewrite()
 A rewrite method that first creates a private Filter, by visiting each term in sequence and marking all docs for that term. Matching documents are assigned a constant score equal to the query's boost.
 
static readonly RewriteMethod SCORING_BOOLEAN_QUERY_REWRITE = new ScoringBooleanQueryRewrite()
 A rewrite method that first translates each term into Occur.SHOULD clause in a BooleanQuery, and keeps the scores as computed by the query. Note that typically such scores are meaningless to the user, and require non-trivial CPU to compute, so it's almost always better to use CONSTANT_SCORE_AUTO_REWRITE_DEFAULT instead.
 
static readonly RewriteMethod CONSTANT_SCORE_BOOLEAN_QUERY_REWRITE = new ConstantScoreBooleanQueryRewrite()
 Like SCORING_BOOLEAN_QUERY_REWRITE except scores are not computed. Instead, each matching document receives a constant score equal to the query's boost.
 
static readonly RewriteMethod CONSTANT_SCORE_AUTO_REWRITE_DEFAULT
 Read-only default instance of ConstantScoreAutoRewrite , with ConstantScoreAutoRewrite.TermCountCutoff set to ConstantScoreAutoRewrite.DEFAULT_TERM_COUNT_CUTOFF
 
- Protected Member Functions inherited from Lucene.Net.Search.MultiTermQuery
 MultiTermQuery ()
 Constructs a query matching terms that cannot be represented with a single Term.
 

Detailed Description

A Query that matches documents containing terms with a specified prefix. A PrefixQuery is built by QueryParser for input like app*.

This query uses the MultiTermQuery.CONSTANT_SCORE_AUTO_REWRITE_DEFAULT rewrite method.

Definition at line 35 of file PrefixQuery.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.PrefixQuery.PrefixQuery ( Term  prefix)

Constructs a query for terms starting with prefix.

Definition at line 40 of file PrefixQuery.cs.

Member Function Documentation

override bool Lucene.Net.Search.PrefixQuery.Equals ( System.Object  obj)

Definition at line 81 of file PrefixQuery.cs.

override int Lucene.Net.Search.PrefixQuery.GetHashCode ( )

Definition at line 72 of file PrefixQuery.cs.

override System.String Lucene.Net.Search.PrefixQuery.ToString ( System.String  field)
virtual

Prints a user-readable version of this query.

Implements Lucene.Net.Search.Query.

Definition at line 57 of file PrefixQuery.cs.

Property Documentation

virtual Term Lucene.Net.Search.PrefixQuery.Prefix
get

Returns the prefix of this query.

Definition at line 47 of file PrefixQuery.cs.


The documentation for this class was generated from the following file: