org.apache.lucene.search

Class ComplexExplanation

Implemented Interfaces:
Serializable

public class ComplexExplanation
extends Explanation

Expert: Describes the score computation for document and query, andcan distinguish a match independent of a positive value.
See Also:
Serialized Form

Constructor Summary

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

Method Summary

Boolean
getMatch()
The match status of this explanation node.
protected String
getSummary()
boolean
isMatch()
Indicates wether 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, getSummary, getValue, isMatch, setDescription, setValue, toHtml, toString, toString

Constructor Details

ComplexExplanation

public ComplexExplanation()

ComplexExplanation

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

Method Details

getMatch

public Boolean getMatch()
The match status of this explanation node.
Returns:
May be null if match status is unknown

getSummary

protected String getSummary()
Overrides:
getSummary in interface Explanation

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.

Overrides:
isMatch in interface Explanation
See Also:
getMatch()

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.