org.apache.lucene.search

Class Explanation

Implemented Interfaces:
java.io.Serializable

public class Explanation
extends java.lang.Object
implements java.io.Serializable

Expert: Describes the score computation for document and query.

See Also:
Serialized Form

Constructor Summary

Explanation()
Explanation(float value, String description)

Method Summary

void
addDetail(Explanation detail)
Adds a sub-node to this explanation node.
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.
void
setDescription(String description)
Sets the description of this explanation node.
void
setValue(float value)
Sets the value assigned to this explanation node.
String
toHtml()
Render an explanation as HTML.
String
toString()
Render an explanation as text.

Constructor Details

Explanation

public Explanation()


Explanation

public Explanation(float value,
                   String description)

Method Details

addDetail

public void addDetail(Explanation detail)
Adds a sub-node to this explanation node.


getDescription

public String getDescription()
A description of this explanation node.


getDetails

public Explanation[] getDetails()
The sub-nodes of this explanation node.


getValue

public float getValue()
The value assigned to this explanation node.


setDescription

public void setDescription(String description)
Sets the description of this explanation node.


setValue

public void setValue(float value)
Sets the value assigned to this explanation node.


toHtml

public String toHtml()
Render an explanation as HTML.


toString

public String toString()
Render an explanation as text.


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