public final class Explanation extends Object
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o) |
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.
|
int |
hashCode() |
boolean |
isMatch()
Indicates whether or not this Explanation models a match.
|
static Explanation |
match(float value,
String description,
Collection<Explanation> details)
Create a new explanation for a match.
|
static Explanation |
match(float value,
String description,
Explanation... details)
Create a new explanation for a match.
|
static Explanation |
noMatch(String description,
Collection<Explanation> details)
Create a new explanation for a document which does not match.
|
static Explanation |
noMatch(String description,
Explanation... details)
Create a new explanation for a document which does not match.
|
String |
toHtml()
Deprecated.
|
String |
toString()
Render an explanation as text.
|
public static Explanation match(float value, String description, Collection<Explanation> details)
value
- the contribution to the score of the documentdescription
- how value
was computeddetails
- sub explanations that contributed to this explanationpublic static Explanation match(float value, String description, Explanation... details)
value
- the contribution to the score of the documentdescription
- how value
was computeddetails
- sub explanations that contributed to this explanationpublic static Explanation noMatch(String description, Collection<Explanation> details)
public static Explanation noMatch(String description, Explanation... details)
public boolean isMatch()
public float getValue()
public String getDescription()
public Explanation[] getDetails()
public String toString()
@Deprecated public String toHtml()
Copyright © 2000-2017 Apache Software Foundation. All Rights Reserved.