Class Explanation


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

      • match

        public static Explanation match​(Number value,
                                        String description,
                                        Collection<Explanation> details)
        Create a new explanation for a match.
        Parameters:
        value - the contribution to the score of the document
        description - how value was computed
        details - sub explanations that contributed to this explanation
      • match

        public static Explanation match​(Number value,
                                        String description,
                                        Explanation... details)
        Create a new explanation for a match.
        Parameters:
        value - the contribution to the score of the document
        description - how value was computed
        details - sub explanations that contributed to this explanation
      • noMatch

        public static Explanation noMatch​(String description,
                                          Explanation... details)
        Create a new explanation for a document which does not match.
      • isMatch

        public boolean isMatch()
        Indicates whether or not this Explanation models a match.
      • getValue

        public Number getValue()
        The value assigned 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.
      • toString

        public String toString()
        Render an explanation as text.
        Overrides:
        toString in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object