Class Query

The abstract base class for queries.

Instantiable subclasses are:

See also the family of Span Queries (Lucene.Net.Search.Spans) and additional queries available in the Queries module

Inheritance

System.Object

Query

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Lucene.Net.Search

Assembly: Lucene.Net.dll

Syntax

[Serializable]
public abstract class Query

Properties

| Improve this Doc View Source

Boost

Gets or Sets the boost for this query clause. Documents matching this clause will (in addition to the normal weightings) have their score multiplied by Boost. The boost is 1.0 by default.

Declaration

public virtual float Boost { get; set; }

Property Value

Type	Description
System.Single

Methods

| Improve this Doc View Source

Clone()

Returns a clone of this query.

Declaration

public virtual object Clone()

Returns

Type	Description
System.Object

| Improve this Doc View Source

CreateWeight(IndexSearcher)

Expert: Constructs an appropriate Weight implementation for this query.

Only implemented by primitive queries, which re-write to themselves.

Declaration

public virtual Weight CreateWeight(IndexSearcher searcher)

Parameters

Type	Name	Description
IndexSearcher	searcher

Returns

Type	Description
Weight

| Improve this Doc View Source

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

| Improve this Doc View Source

ExtractTerms(ISet<Term>)

Expert: adds all terms occurring in this query to the terms set. Only works if this query is in its rewritten (Rewrite(IndexReader)) form.

Declaration

public virtual void ExtractTerms(ISet<Term> terms)

Parameters

Type	Name	Description
System.Collections.Generic.ISet<Term>	terms

Exceptions

Type	Condition
System.InvalidOperationException	If this query is not yet rewritten

| Improve this Doc View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

| Improve this Doc View Source

Rewrite(IndexReader)

Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.

Declaration

public virtual Query Rewrite(IndexReader reader)

Parameters

Type	Name	Description
IndexReader	reader

Returns

Type	Description
Query

| Improve this Doc View Source

ToString()

Prints a query to a string.

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

| Improve this Doc View Source

ToString(String)

Prints a query to a string, with field assumed to be the default field and omitted.

Declaration

public abstract string ToString(string field)

Parameters

Type	Name	Description
System.String	field

Returns

Type	Description
System.String