Package com.yahoo.search.grouping.request

Class SummaryValue

java.lang.Object
com.yahoo.search.grouping.request.GroupingNode
com.yahoo.search.grouping.request.GroupingExpression
com.yahoo.search.grouping.request.DocumentValue
com.yahoo.search.grouping.request.SummaryValue
public class SummaryValue extends DocumentValue
This class represents a document summary in a GroupingExpression. It evaluates to the summary of the input Hit that corresponds to the named summary class.
Author:
Simon Thoresen Hult

  • Constructor Details

    • SummaryValue

      public SummaryValue()
      Constructs a new instance of this class, using the default summary class.

    • SummaryValue

      public SummaryValue(String summaryName)
      Constructs a new instance of this class.
      Parameters:
      summaryName - The name of the summary class to assign to this.

  • Method Details

    • copy

      public SummaryValue copy()
      Description copied from class: GroupingExpression
      Returns a deep copy of this
      Specified by:
      copy in class GroupingExpression

    • getSummaryName

      public String getSummaryName()
      Returns the name of the summary class used to retrieve the hit from the search node.
      Returns:
      The summary name.