org.apache.lucene.search

Class Explanation

java.lang.Object

org.apache.lucene.search.Explanation

public final class Explanation
extends java.lang.Object

Expert: Describes the score computation for document and query.

Method Summary

Modifier and Type	Method and Description
java.lang.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 match.
static Explanation	match(float value, java.lang.String description, java.util.Collection<Explanation> details) Create a new explanation for a match.
static Explanation	match(float value, java.lang.String description, Explanation... details) Create a new explanation for a match.
static Explanation	noMatch(java.lang.String description, java.util.Collection<Explanation> details) Create a new explanation for a document which does not match.
static Explanation	noMatch(java.lang.String description, Explanation... details) Create a new explanation for a document which does not match.
java.lang.String	toHtml() Render an explanation as HTML.
java.lang.String	toString() Render an explanation as text.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

match

public static Explanation match(float value,
                                java.lang.String description,
                                java.util.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(float value,
                                java.lang.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(java.lang.String description,
                                  java.util.Collection<Explanation> details)

Create a new explanation for a document which does not match.

noMatch

public static Explanation noMatch(java.lang.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 float getValue()

The value assigned to this explanation node.

getDescription

public java.lang.String getDescription()

A description of this explanation node.

getDetails

public Explanation[] getDetails()

The sub-nodes of this explanation node.

toString

public java.lang.String toString()

Render an explanation as text.

Overrides:

toString in class java.lang.Object

toHtml

public java.lang.String toHtml()

Render an explanation as HTML.