org.apache.lucene.search

Class ComplexExplanation

public class ComplexExplanation extends Explanation

Expert: Describes the score computation for document and query, andcan distinguish a match independent of a positive value.
Constructor Summary
ComplexExplanation()
ComplexExplanation(boolean match, float value, String description)
Method Summary
BooleangetMatch()
The match status of this explanation node.
protected StringgetSummary()
booleanisMatch()
Indicates wether or not this Explanation models a good match.
voidsetMatch(Boolean match)
Sets the match status assigned to this explanation node.

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

getSummary

protected String getSummary()

isMatch

public boolean isMatch()
Indicates wether or not this Explanation models a good match.

If the match statis is explicitly set (ie: not null) this method uses it; otherwise it defers to the superclass.

See Also: ComplexExplanation

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

Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.