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

A query that wraps a filter and simply returns a constant score equal to the query boost for every document in the filter. More...

Inherits Lucene.Net.Search.Query.

Classes

class  ConstantScorer
 
class  ConstantWeight
 

Public Member Functions

 ConstantScoreQuery (Filter 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 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.
 
override Weight CreateWeight (Searcher searcher)
 Expert: Constructs an appropriate Weight implementation for this query.
 
override System.String ToString (string field)
 Prints a user-readable version of this query.
 
override bool Equals (System.Object o)
 Returns true if o is equal to this.
 
override int GetHashCode ()
 Returns a hash code value for this object.
 
override System.Object Clone ()
 Returns a clone of this query.
 
- Public Member Functions inherited from Lucene.Net.Search.Query
abstract System.String ToString (System.String field)
 Prints a query to a string, with field assumed to be the default field and omitted. The representation used is one that is supposed to be readable by QueryParser. However, there are the following limitations:

  • If the query was created by the parser, the printed representation may not be exactly what was parsed. For example, characters that need to be escaped will be represented without the required backslash.
  • Some of the more complicated queries (e.g. span queries) don't have a representation that can be parsed by QueryParser.

 
override System.String ToString ()
 Prints a query to a string.
 
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 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.
 
override int GetHashCode ()
 
override bool Equals (System.Object obj)
 

Properties

virtual Filter Filter [get]
 Returns the encapsulated filter
 
- 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.
 

Detailed Description

A query that wraps a filter and simply returns a constant score equal to the query boost for every document in the filter.

Definition at line 29 of file ConstantScoreQuery.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.ConstantScoreQuery.ConstantScoreQuery ( Filter  filter)

Definition at line 33 of file ConstantScoreQuery.cs.

Member Function Documentation

override System.Object Lucene.Net.Search.ConstantScoreQuery.Clone ( )
virtual

Returns a clone of this query.

Reimplemented from Lucene.Net.Search.Query.

Definition at line 228 of file ConstantScoreQuery.cs.

override Weight Lucene.Net.Search.ConstantScoreQuery.CreateWeight ( Searcher  searcher)
virtual

Expert: Constructs an appropriate Weight implementation for this query.

Only implemented by primitive queries, which re-write to themselves.

Reimplemented from Lucene.Net.Search.Query.

Definition at line 199 of file ConstantScoreQuery.cs.

override bool Lucene.Net.Search.ConstantScoreQuery.Equals ( System.Object  o)

Returns true if o is equal to this.

Definition at line 211 of file ConstantScoreQuery.cs.

override void Lucene.Net.Search.ConstantScoreQuery.ExtractTerms ( System.Collections.Generic.ISet< Term terms)
virtual

Expert: adds all terms occuring in this query to the terms set. Only works if this query is in its rewritten form.

<throws> UnsupportedOperationException if this query is not yet rewritten </throws>

Reimplemented from Lucene.Net.Search.Query.

Definition at line 49 of file ConstantScoreQuery.cs.

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

Returns a hash code value for this object.

Definition at line 222 of file ConstantScoreQuery.cs.

override Query Lucene.Net.Search.ConstantScoreQuery.Rewrite ( IndexReader  reader)
virtual

Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.

Reimplemented from Lucene.Net.Search.Query.

Definition at line 44 of file ConstantScoreQuery.cs.

override System.String Lucene.Net.Search.ConstantScoreQuery.ToString ( string  field)

Prints a user-readable version of this query.

Definition at line 205 of file ConstantScoreQuery.cs.

Property Documentation

virtual Filter Lucene.Net.Search.ConstantScoreQuery.Filter
get

Returns the encapsulated filter

Definition at line 40 of file ConstantScoreQuery.cs.


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