Class Explanation

Expert: Describes the score computation for document and query.

Inheritance
object
Explanation
ComplexExplanation
Inherited Members
Namespace: Lucene.Net.Search
Assembly: Lucene.Net.dll
Syntax
public class Explanation

Constructors

Explanation()

Expert: Describes the score computation for document and query.

Declaration
public Explanation()

Explanation(float, string)

Expert: Describes the score computation for document and query.

Declaration
public Explanation(float value, string description)
Parameters
Type Name Description
float value
string description

Properties

Description

Gets or Sets the description of this explanation node.

Declaration
public virtual string Description { get; set; }
Property Value
Type Description
string

IsMatch

Indicates whether or not this Explanation models a good match.

By default, an Explanation represents a "match" if the value is positive.

Declaration
public virtual bool IsMatch { get; }
Property Value
Type Description
bool
See Also

Value

Gets or Sets the value assigned to this explanation node.

Declaration
public virtual float Value { get; set; }
Property Value
Type Description
float

Methods

AddDetail(Explanation)

Adds a sub-node to this explanation node.

Declaration
public virtual void AddDetail(Explanation detail)
Parameters
Type Name Description
Explanation detail

GetDetails()

The sub-nodes of this explanation node.

Declaration
public virtual Explanation[] GetDetails()
Returns
Type Description
Explanation[]

GetSummary()

A short one line summary which should contain all high level information about this Explanation, without the "Details"

Declaration
protected virtual string GetSummary()
Returns
Type Description
string

ToHtml()

Render an explanation as HTML.

Declaration
public virtual string ToHtml()
Returns
Type Description
string

ToString()

Render an explanation as text.

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

ToString(int)

Expert: Describes the score computation for document and query.

Declaration
protected virtual string ToString(int depth)
Parameters
Type Name Description
int depth
Returns
Type Description
string