SummaryValue (container-search 7.359.24 API)

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 Summary

Constructors
Constructor	Description
`SummaryValue()`	Constructs a new instance of this class, using the default summary class.
`SummaryValue(java.lang.String summaryName)`	Constructs a new instance of this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SummaryValue`	`copy()`	Returns a deep copy of this
`java.lang.String`	`getSummaryName()`	Returns the name of the summary class used to retrieve the hit from the search node.

Methods inherited from class com.yahoo.search.grouping.request.DocumentValue
resolveLevel

Methods inherited from class com.yahoo.search.grouping.request.GroupingExpression
asImage, asString, getLevel, getLevelOrNull, setLabel, visit

Methods inherited from class com.yahoo.search.grouping.request.GroupingNode
getImage, getLabel, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SummaryValue
```
public SummaryValue()
```
    Constructs a new instance of this class, using the default summary class.
  - SummaryValue
```
public SummaryValue(java.lang.String summaryName)
```
    Constructs a new instance of this class.
    
    Parameters:
    
    summaryName - The name of the summary class to assign to this.
- Method Detail
  - copy
```
public SummaryValue copy()
```
    Description copied from class: GroupingExpression
    
    Returns a deep copy of this
    
    Specified by:
    
    copy in class GroupingExpression
  - getSummaryName
```
public java.lang.String getSummaryName()
```
    Returns the name of the summary class used to retrieve the hit from the search node.
    
    Returns:
    
    The summary name.