Class Explanation

Expert: Describes the score computation for document and query.

Inheritance
System.Object
Explanation
ComplexExplanation
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Search
Assembly: Lucene.Net.dll
Syntax
public class Explanation

Constructors

| Improve this Doc View Source

Explanation()

Declaration
public Explanation()
| Improve this Doc View Source

Explanation(Single, String)

Declaration
public Explanation(float value, string description)
Parameters
Type Name Description
System.Single value
System.String description

Properties

| Improve this Doc View Source

Description

Gets or Sets the description of this explanation node.

Declaration
public virtual string Description { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

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
System.Boolean
See Also
| Improve this Doc View Source

Value

Gets or Sets the value assigned to this explanation node.

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

Methods

| Improve this Doc View Source

AddDetail(Explanation)

Adds a sub-node to this explanation node.

Declaration
public virtual void AddDetail(Explanation detail)
Parameters
Type Name Description
Explanation detail
| Improve this Doc View Source

GetDetails()

The sub-nodes of this explanation node.

Declaration
public virtual Explanation[] GetDetails()
Returns
Type Description
Explanation[]
| Improve this Doc View Source

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
System.String
| Improve this Doc View Source

ToHtml()

Render an explanation as HTML.

Declaration
public virtual string ToHtml()
Returns
Type Description
System.String
| Improve this Doc View Source

ToString()

Render an explanation as text.

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()
| Improve this Doc View Source

ToString(Int32)

Declaration
protected virtual string ToString(int depth)
Parameters
Type Name Description
System.Int32 depth
Returns
Type Description
System.String