Explanation (The Adobe Experience Manager SDK 2022.2.6433.20220223T194056Z-220100)

java.lang.Object
- org.apache.lucene.search.Explanation

Direct Known Subclasses:

ComplexExplanation
```
public class Explanation
extends Object
```
Expert: Describes the score computation for document and query.

Constructor Summary

Constructors
Constructor Description

Explanation()

Explanation(float value, String description)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addDetail(Explanation detail)`	Adds a sub-node to this explanation node.
`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.
`boolean`	`isMatch()`	Indicates whether or not this Explanation models a good match.
`void`	`setDescription(String description)`	Sets the description of this explanation node.
`void`	`setValue(float value)`	Sets the value assigned to this explanation node.
`String`	`toHtml()`	Render an explanation as HTML.
`String`	`toString()`	Render an explanation as text.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Explanation
```
public Explanation()
```
  - Explanation
```
public Explanation(float value,
                   String description)
```
- Method Detail
  - isMatch
```
public boolean isMatch()
```
    Indicates whether or not this Explanation models a good match.
    By default, an Explanation represents a "match" if the value is positive.
    
    See Also:
    
    getValue()
  - getValue
```
public float getValue()
```
    The value assigned to this explanation node.
  - setValue
```
public void setValue(float value)
```
    Sets the value assigned to this explanation node.
  - getDescription
```
public String getDescription()
```
    A description of this explanation node.
  - setDescription
```
public void setDescription(String description)
```
    Sets the description of this explanation node.
  - getDetails
```
public Explanation[] getDetails()
```
    The sub-nodes of this explanation node.
  - addDetail
```
public void addDetail(Explanation detail)
```
    Adds a sub-node to this explanation node.
  - toString
```
public String toString()
```
    Render an explanation as text.
    
    Overrides:
    
    toString in class Object
  - toHtml
```
public String toHtml()
```
    Render an explanation as HTML.