Package org.apache.lucene.search
Class ComplexExplanation
java.lang.Object
org.apache.lucene.search.Explanation
org.apache.lucene.search.ComplexExplanation
Expert: Describes the score computation for document and query, and
can distinguish a match independent of a positive value.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetMatch()
The match status of this explanation node.protected String
A short one line summary which should contain all high level information about this Explanation, without the "Details"boolean
isMatch()
Indicates whether or not this Explanation models a good match.void
Sets the match status assigned to this explanation node.Methods inherited from class org.apache.lucene.search.Explanation
addDetail, getDescription, getDetails, getValue, setDescription, setValue, toHtml, toString, toString
-
Constructor Details
-
ComplexExplanation
public ComplexExplanation() -
ComplexExplanation
-
-
Method Details
-
getMatch
The match status of this explanation node.- Returns:
- May be null if match status is unknown
-
setMatch
Sets the match status assigned to this explanation node.- Parameters:
match
- May be null if match status is unknown
-
isMatch
public boolean isMatch()Indicates whether or not this Explanation models a good match.If the match status is explicitly set (i.e.: not null) this method uses it; otherwise it defers to the superclass.
- Overrides:
isMatch
in classExplanation
- See Also:
-
getSummary
Description copied from class:Explanation
A short one line summary which should contain all high level information about this Explanation, without the "Details"- Overrides:
getSummary
in classExplanation
-