Package org.apache.lucene.search
Class Explanation
- java.lang.Object
-
- org.apache.lucene.search.Explanation
-
public final class Explanation extends Object
Expert: Describes the score computation for document and query.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)StringgetDescription()A description of this explanation node.Explanation[]getDetails()The sub-nodes of this explanation node.NumbergetValue()The value assigned to this explanation node.inthashCode()booleanisMatch()Indicates whether or not this Explanation models a match.static Explanationmatch(Number value, String description, Collection<Explanation> details)Create a new explanation for a match.static Explanationmatch(Number value, String description, Explanation... details)Create a new explanation for a match.static ExplanationnoMatch(String description, Collection<Explanation> details)Create a new explanation for a document which does not match.static ExplanationnoMatch(String description, Explanation... details)Create a new explanation for a document which does not match.StringtoString()Render an explanation as text.
-
-
-
Method Detail
-
match
public static Explanation match(Number value, String description, Collection<Explanation> details)
Create a new explanation for a match.- Parameters:
value- the contribution to the score of the documentdescription- howvaluewas computeddetails- sub explanations that contributed to this explanation
-
match
public static Explanation match(Number value, String description, Explanation... details)
Create a new explanation for a match.- Parameters:
value- the contribution to the score of the documentdescription- howvaluewas computeddetails- sub explanations that contributed to this explanation
-
noMatch
public static Explanation noMatch(String description, Collection<Explanation> details)
Create a new explanation for a document which does not match.
-
noMatch
public static Explanation noMatch(String description, Explanation... details)
Create a new explanation for a document which does not match.
-
isMatch
public boolean isMatch()
Indicates whether or not this Explanation models a match.
-
getValue
public Number getValue()
The value assigned to this explanation node.
-
getDescription
public String getDescription()
A description of this explanation node.
-
getDetails
public Explanation[] getDetails()
The sub-nodes of this explanation node.
-
toString
public String toString()
Render an explanation as text.
-
-