org.apache.lucene.search
public class Explanation extends Object implements Serializable
Constructor Summary | |
---|---|
Explanation() | |
Explanation(float value, String description) |
Method Summary | |
---|---|
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. |
protected String | getSummary()
A short one line summary which should contain all high level
information about this Explanation, without the "Details" |
float | getValue() The value assigned to this explanation node. |
boolean | isMatch()
Indicates wether 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 String | toString(int depth) |
By default, an Explanation represents a "match" if the value is positive.
See Also: Explanation