Serializable
ComplexExplanation
public class Explanation extends Object implements Serializable
Modifier and Type | Class | Description |
---|---|---|
static class |
Explanation.IDFExplanation |
Small Util class used to pass both an idf factor as well as an
explanation for that factor.
|
Constructor | Description |
---|---|
Explanation() |
|
Explanation(float value,
String description) |
Modifier and Type | Method | Description |
---|---|---|
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 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 String |
toString(int depth) |
public Explanation()
public Explanation(float value, String description)
public boolean isMatch()
By default, an Explanation represents a "match" if the value is positive.
getValue()
public float getValue()
public void setValue(float value)
public String getDescription()
public void setDescription(String description)
protected String getSummary()
public Explanation[] getDetails()
public void addDetail(Explanation detail)
public String toString()
protected String toString(int depth)
public String toHtml()
Copyright © 2000-2018 Apache Software Foundation. All Rights Reserved.