Home » lucene-3.0.1-src » org.apache » lucene » search » [javadoc | source]
org.apache.lucene.search
public class: Explanation [javadoc | source]
java.lang.Object
   org.apache.lucene.search.Explanation

All Implemented Interfaces:
    java$io$Serializable

Direct Known Subclasses:
    ComplexExplanation

Expert: Describes the score computation for document and query.
Nested Class Summary:
abstract public static class  Explanation.IDFExplanation  Small Util class used to pass both an idf factor as well as an explanation for that factor. This class will likely be held on a {@link Weight}, so be aware before storing any large or un-serializable fields. 
Constructor:
 public Explanation() 
 public Explanation(float value,
    String description) 
Method from org.apache.lucene.search.Explanation Summary:
addDetail,   getDescription,   getDetails,   getSummary,   getValue,   isMatch,   setDescription,   setValue,   toHtml,   toString,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.search.Explanation Detail:
 public  void addDetail(Explanation detail) 
    Adds a sub-node to this explanation node.
 public String getDescription() 
    A description of this explanation node.
 public Explanation[] getDetails() 
    The sub-nodes 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"
 public float getValue() 
    The value assigned to this explanation node.
 public boolean isMatch() 
    Indicates whether or not this Explanation models a good match.

    By default, an Explanation represents a "match" if the value is positive.

 public  void setDescription(String description) 
    Sets the description of this explanation node.
 public  void setValue(float value) 
    Sets the value assigned to this explanation node.
 public String toHtml() 
    Render an explanation as HTML.
 public String toString() 
    Render an explanation as text.
 protected String toString(int depth)