Lucene.Net.Search.Spans.SpanTermQuery Class Reference

Matches spans containing a term. More...

Inherits Lucene.Net.Search.Spans.SpanQuery.

Public Member Functions
	SpanTermQuery (Term term)
	Construct a SpanTermQuery matching the named term's spans.
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 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 int	GetHashCode ()
override bool	Equals (System.Object obj)
override Spans	GetSpans (IndexReader reader)
	Expert: Returns the matches for this query in an index. Used internally to search for spans.
Public Member Functions inherited from Lucene.Net.Search.Spans.SpanQuery
override Weight	CreateWeight (Searcher searcher)
	Expert: Constructs an appropriate Weight implementation for this query.
Public Member Functions inherited from Lucene.Net.Search.Query
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)

Properties
virtual Term	Term [get]
	Return the term whose spans are matched.
override string	Field [get]
Properties inherited from Lucene.Net.Search.Spans.SpanQuery
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

Matches spans containing a term.

Definition at line 29 of file SpanTermQuery.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.Spans.SpanTermQuery.SpanTermQuery

(

Term

term

)

Construct a SpanTermQuery matching the named term's spans.

Definition at line 34 of file SpanTermQuery.cs.

Member Function Documentation

override bool Lucene.Net.Search.Spans.SpanTermQuery.Equals

(

System.Object

obj

)

Definition at line 76 of file SpanTermQuery.cs.

override void Lucene.Net.Search.Spans.SpanTermQuery.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 50 of file SpanTermQuery.cs.

override int Lucene.Net.Search.Spans.SpanTermQuery.GetHashCode

(

)

Definition at line 68 of file SpanTermQuery.cs.

override Spans Lucene.Net.Search.Spans.SpanTermQuery.GetSpans ( IndexReader  reader )

virtual

Expert: Returns the matches for this query in an index. Used internally to search for spans.

Implements Lucene.Net.Search.Spans.SpanQuery.

Definition at line 95 of file SpanTermQuery.cs.

override System.String Lucene.Net.Search.Spans.SpanTermQuery.ToString ( System.String  field )

virtual

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.

Implements Lucene.Net.Search.Query.

Definition at line 55 of file SpanTermQuery.cs.

Property Documentation

override string Lucene.Net.Search.Spans.SpanTermQuery.Field

get

Definition at line 46 of file SpanTermQuery.cs.

virtual Term Lucene.Net.Search.Spans.SpanTermQuery.Term

get

Return the term whose spans are matched.

Definition at line 41 of file SpanTermQuery.cs.

---

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

• core/Search/Spans/SpanTermQuery.cs