| java.lang.Object | ||
| ↳ | org.apache.lucene.search.Explanation | |
| ↳ | org.apache.lucene.search.ComplexExplanation | |
Class Overview
Expert: Describes the score computation for document and query, and can distinguish a match independent of a positive value.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
The match status of this explanation node.
| |||||||||||
Indicates whether or not this Explanation models a good match.
| |||||||||||
Sets the match status assigned to this explanation node.
| |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
A short one line summary which should contain all high level
information about this Explanation, without the "Details"
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.lucene.search.Explanation
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public ComplexExplanation ()
Public Methods
public Boolean getMatch ()
The match status of this explanation node.
Returns
- May be null if match status is unknown
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.
See Also
public void setMatch (Boolean match)
Sets the match status assigned to this explanation node.
Parameters
| match | May be null if match status is unknown |
|---|
Protected Methods
protected String getSummary ()
A short one line summary which should contain all high level information about this Explanation, without the "Details"