Class Explanation

  • Direct Known Subclasses:

    public class Explanation
    extends Object
    Expert: Describes the score computation for document and query.
    • Constructor Detail

      • Explanation

        public Explanation()
      • Explanation

        public Explanation​(float value,
                           String description)
    • Method Detail

      • isMatch

        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.

        See Also:
      • getValue

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

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

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

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

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

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

        public String toString()
        Render an explanation as text.
        toString in class Object
      • toHtml

        public String toHtml()
        Render an explanation as HTML.