Module org.apache.lucene.core

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.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	description
private final List<Explanation>	details
private final boolean	match
private final Number	value

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Explanation(boolean match, Number value, String description, Collection<Explanation> details)	Create a new explanation

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDescription()	A description of this explanation node.
Explanation[]	getDetails()	The sub-nodes of this explanation node.
private String	getSummary()
Number	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.
String	toString()	Render an explanation as text.
private String	toString(int depth)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

match

private final boolean match

value

private final Number value

description

private final String description

details

private final List<Explanation> details

Constructor Details

Explanation

private Explanation(boolean match,
 Number value,
 String description,
 Collection<Explanation> details)

Create a new explanation

Method Details

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 document

description - how value was computed

details - 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 document

description - how value was computed

details - 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.

getSummary

private String getSummary()

getDetails

public Explanation[] getDetails()

The sub-nodes of this explanation node.

toString

public String toString()

Render an explanation as text.

Overrides:

toString in class Object

toString

private String toString(int depth)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object