org.apache.lucene.search

Class ComplexExplanation

java.lang.Object

org.apache.lucene.search.Explanation

org.apache.lucene.search.ComplexExplanation

All Implemented Interfaces:

Serializable

public class ComplexExplanation
extends Explanation

Expert: Describes the score computation for document and query, and can distinguish a match independent of a positive value.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.Explanation

Explanation.IDFExplanation

Constructor Summary

Constructors

Constructor and Description
ComplexExplanation()
ComplexExplanation(boolean match, float value, String description)

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getMatch() The match status of this explanation node.
protected String	getSummary() 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	setMatch(Boolean match) 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

Methods inherited from class java.lang.Object

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

Constructor Detail

ComplexExplanation

public ComplexExplanation()

ComplexExplanation

public ComplexExplanation(boolean match,
                  float value,
                  String description)

Method Detail

getMatch

public Boolean getMatch()

The match status of this explanation node.

Returns:

May be null if match status is unknown

setMatch

public void setMatch(Boolean match)

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 class Explanation

See Also:

getMatch()

getSummary

protected String 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 class Explanation