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 | Protected Attributes | List of all members
Lucene.Net.Spatial.Util.FunctionQuery Class Reference

Port of Solr's FunctionQuery (v1.4) More...

Inherits Lucene.Net.Search.Query.


class  AllScorer
class  FunctionWeight

Public Member Functions

 FunctionQuery (ValueSource func)
ValueSource GetValueSource ()
override Query Rewrite (Index.IndexReader reader)
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 string ToString (string field)
override bool Equals (object o)
override int GetHashCode ()
- 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 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.
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.
virtual System.Object Clone ()
 Returns a clone of this query.
override int GetHashCode ()
override bool Equals (System.Object obj)

Protected Attributes

readonly ValueSource func

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.
- 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.

Detailed Description

Port of Solr's FunctionQuery (v1.4)

Returns a score for each document based on a ValueSource, often some function of the value of a field.

Note: This API is experimental and may change in non backward-compatible ways in the future

Definition at line 34 of file FunctionQuery.cs.

Constructor & Destructor Documentation

Lucene.Net.Spatial.Util.FunctionQuery.FunctionQuery ( ValueSource  func)

Definition at line 38 of file FunctionQuery.cs.

Member Function Documentation

override Weight Lucene.Net.Spatial.Util.FunctionQuery.CreateWeight ( Searcher  searcher)

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 189 of file FunctionQuery.cs.

override bool Lucene.Net.Spatial.Util.FunctionQuery.Equals ( object  o)

Definition at line 201 of file FunctionQuery.cs.

override void Lucene.Net.Spatial.Util.FunctionQuery.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.

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

Reimplemented from Lucene.Net.Search.Query.

Definition at line 57 of file FunctionQuery.cs.

override int Lucene.Net.Spatial.Util.FunctionQuery.GetHashCode ( )

Definition at line 210 of file FunctionQuery.cs.

ValueSource Lucene.Net.Spatial.Util.FunctionQuery.GetValueSource ( )

The associated ValueSource

Definition at line 47 of file FunctionQuery.cs.

override Query Lucene.Net.Spatial.Util.FunctionQuery.Rewrite ( Index.IndexReader  reader)

Definition at line 52 of file FunctionQuery.cs.

override string Lucene.Net.Spatial.Util.FunctionQuery.ToString ( string  field)

Definition at line 194 of file FunctionQuery.cs.

Member Data Documentation

readonly ValueSource Lucene.Net.Spatial.Util.FunctionQuery.func

Definition at line 36 of file FunctionQuery.cs.

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