public class

Explanation

extends Object
implements Serializable
java.lang.Object
   ↳ org.apache.lucene.search.Explanation
Known Direct Subclasses

Class Overview

Expert: Describes the score computation for document and query.

Summary

Nested Classes
class Explanation.IDFExplanation Small Util class used to pass both an idf factor as well as an explanation for that factor. 
Public Constructors
Explanation()
Explanation(float value, String description)
Public Methods
void addDetail(Explanation detail)
Adds a sub-node to this explanation node.
String getDescription()
A description of this explanation node.
Explanation[] getDetails()
The sub-nodes of this explanation node.
float getValue()
The value assigned to this explanation node.
boolean isMatch()
Indicates whether or not this Explanation models a good match.
void setDescription(String description)
Sets the description of this explanation node.
void setValue(float value)
Sets the value assigned to this explanation node.
String toHtml()
Render an explanation as HTML.
String toString()
Render an explanation as text.
Protected Methods
String getSummary()
A short one line summary which should contain all high level information about this Explanation, without the "Details"
String toString(int depth)
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Explanation ()

public Explanation (float value, String description)

Public Methods

public void addDetail (Explanation detail)

Adds a sub-node to this explanation node.

public String getDescription ()

A description of this explanation node.

public Explanation[] getDetails ()

The sub-nodes of this explanation node.

public float getValue ()

The value assigned to this explanation node.

public boolean isMatch ()

Indicates whether or not this Explanation models a good match.

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

See Also

public void setDescription (String description)

Sets the description of this explanation node.

public void setValue (float value)

Sets the value assigned to this explanation node.

public String toHtml ()

Render an explanation as HTML.

public String toString ()

Render an explanation as text.

Protected Methods

protected String getSummary ()

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

protected String toString (int depth)