Lucene.Net.Search.Spans.SpanFirstQuery Class Reference

Matches spans near the beginning of a field. More...

Inherits Lucene.Net.Search.Spans.SpanQuery, and ICloneable.

Public Member Functions
	SpanFirstQuery (SpanQuery match, int end)
	Construct a SpanFirstQuery matching spans in match whose end position is less than or equal to end.
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 System.Object	Clone ()
	Returns a clone of this query.
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 Spans	GetSpans (IndexReader reader)
	Expert: Returns the matches for this query in an index. Used internally to search for spans.
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 bool	Equals (System.Object o)
override int	GetHashCode ()
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	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 SpanQuery	Match [get]
	Return the SpanQuery whose matches are filtered.
virtual int	End [get]
	Return the maximum end position permitted in a match.
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 near the beginning of a field.

Definition at line 31 of file SpanFirstQuery.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.Spans.SpanFirstQuery.SpanFirstQuery	(	SpanQuery	match,
		int	end
	)

Construct a SpanFirstQuery matching spans in match whose end position is less than or equal to end.

Definition at line 119 of file SpanFirstQuery.cs.

Member Function Documentation

override System.Object Lucene.Net.Search.Spans.SpanFirstQuery.Clone ( )

virtual

Returns a clone of this query.

Reimplemented from Lucene.Net.Search.Query.

Definition at line 154 of file SpanFirstQuery.cs.

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

(

System.Object

o

)

Definition at line 192 of file SpanFirstQuery.cs.

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

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

(

)

Definition at line 203 of file SpanFirstQuery.cs.

override Spans Lucene.Net.Search.Spans.SpanFirstQuery.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 166 of file SpanFirstQuery.cs.

override Query Lucene.Net.Search.Spans.SpanFirstQuery.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 171 of file SpanFirstQuery.cs.

override System.String Lucene.Net.Search.Spans.SpanFirstQuery.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 142 of file SpanFirstQuery.cs.

Property Documentation

virtual int Lucene.Net.Search.Spans.SpanFirstQuery.End

get

Return the maximum end position permitted in a match.

Definition at line 133 of file SpanFirstQuery.cs.

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

get

Definition at line 138 of file SpanFirstQuery.cs.

virtual SpanQuery Lucene.Net.Search.Spans.SpanFirstQuery.Match

get

Return the SpanQuery whose matches are filtered.

Definition at line 127 of file SpanFirstQuery.cs.

---

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

• core/Search/Spans/SpanFirstQuery.cs