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.Spans.SpanOrQuery Class Reference

Matches the union of its clauses. More...

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

Public Member Functions

 SpanOrQuery (params SpanQuery[] clauses)
 Construct a SpanOrQuery merging the provided clauses.
 
virtual SpanQuery[] GetClauses ()
 Return the clauses whose spans are matched.
 
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.Object Clone ()
 Returns a clone of this query.
 
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 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 bool Equals (System.Object o)
 
override int GetHashCode ()
 
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 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

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 the union of its clauses.

Definition at line 32 of file SpanOrQuery.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.Spans.SpanOrQuery.SpanOrQuery ( params SpanQuery[]  clauses)

Construct a SpanOrQuery merging the provided clauses.

Definition at line 169 of file SpanOrQuery.cs.

Member Function Documentation

override System.Object Lucene.Net.Search.Spans.SpanOrQuery.Clone ( )
virtual

Returns a clone of this query.

Reimplemented from Lucene.Net.Search.Query.

Definition at line 209 of file SpanOrQuery.cs.

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

Definition at line 269 of file SpanOrQuery.cs.

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

virtual SpanQuery [] Lucene.Net.Search.Spans.SpanOrQuery.GetClauses ( )
virtual

Return the clauses whose spans are matched.

Definition at line 191 of file SpanOrQuery.cs.

override int Lucene.Net.Search.Spans.SpanOrQuery.GetHashCode ( )

Definition at line 286 of file SpanOrQuery.cs.

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

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

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

Property Documentation

override string Lucene.Net.Search.Spans.SpanOrQuery.Field
get

Definition at line 197 of file SpanOrQuery.cs.


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