Package org.apache.lucene.search
Class Explanation
java.lang.Object
org.apache.lucene.search.Explanation
Expert: Describes the score computation for document and query.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
A description of this explanation node.The sub-nodes of this explanation node.getValue()
The value assigned to this explanation node.int
hashCode()
boolean
isMatch()
Indicates whether or not this Explanation models a match.static Explanation
match
(Number value, String description, Collection<Explanation> details) Create a new explanation for a match.static Explanation
match
(Number 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.toString()
Render an explanation as text.
-
Method Details
-
match
Create a new explanation for a match.- Parameters:
value
- the contribution to the score of the documentdescription
- howvalue
was computeddetails
- sub explanations that contributed to this explanation
-
match
Create a new explanation for a match.- Parameters:
value
- the contribution to the score of the documentdescription
- howvalue
was computeddetails
- sub explanations that contributed to this explanation
-
noMatch
Create a new explanation for a document which does not match. -
noMatch
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
The value assigned to this explanation node. -
getDescription
A description of this explanation node. -
getDetails
The sub-nodes of this explanation node. -
toString
Render an explanation as text. -
equals
-
hashCode
public int hashCode()
-