Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Public Member Functions | Properties | List of all members
Lucene.Net.Search.Spans.SpanQuery Class Referenceabstract

Base class for span-based queries. More...

Inherits Lucene.Net.Search.Query.

Inherited by Contrib.Regex.SpanRegexQuery, Lucene.Net.Search.Spans.FieldMaskingSpanQuery, Lucene.Net.Search.Spans.SpanFirstQuery, Lucene.Net.Search.Spans.SpanNearQuery, Lucene.Net.Search.Spans.SpanNotQuery, Lucene.Net.Search.Spans.SpanOrQuery, and Lucene.Net.Search.Spans.SpanTermQuery.

Public Member Functions

abstract Spans GetSpans (IndexReader reader)
 Expert: Returns the matches for this query in an index. Used internally to search for spans.
override Weight CreateWeight (Searcher searcher)
 Expert: Constructs an appropriate Weight implementation for 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 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 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)


abstract string Field [get]
 Returns the name of the field matched by this query.
- 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

Base class for span-based queries.

Definition at line 30 of file SpanQuery.cs.

Member Function Documentation

override Weight Lucene.Net.Search.Spans.SpanQuery.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 40 of file SpanQuery.cs.

abstract Spans Lucene.Net.Search.Spans.SpanQuery.GetSpans ( IndexReader  reader)
pure virtual

Property Documentation

abstract string Lucene.Net.Search.Spans.SpanQuery.Field

Returns the name of the field matched by this query.

Definition at line 38 of file SpanQuery.cs.

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