SectionHitGroup (container-search 7.482.13 API)

java.lang.Object
- com.yahoo.component.provider.FreezableClass
- - com.yahoo.component.provider.ListenableFreezableClass
  - - com.yahoo.search.result.Hit
    - - com.yahoo.search.result.HitGroup
      - com.yahoo.search.pagetemplates.result.SectionHitGroup

All Implemented Interfaces:

com.yahoo.component.provider.Freezable, com.yahoo.component.provider.ListenableFreezable, com.yahoo.processing.response.Data, com.yahoo.processing.response.DataList<Hit>, java.lang.Cloneable, java.lang.Comparable<Hit>, java.lang.Iterable<Hit>
```
public class SectionHitGroup
extends HitGroup
```
A hit group corresponding to a section - contains some additional information in proper getters and setters which is used during rendering.

Author:

bratseth

Nested Class Summary
- Nested classes/interfaces inherited from class com.yahoo.search.result.Hit
  Hit.RawUtf8Consumer

Field Summary
- Fields inherited from class com.yahoo.search.result.Hit
  RANKFEATURES_FIELD, SDDOCNAME_FIELD

Constructor Summary

Constructors
Constructor Description

SectionHitGroup(java.lang.String id)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`	Releases the resources held by this, making it irreversibly unusable
`java.lang.String`	`getDisplayId()`	Returns the id to display, or null to not display (render) the id.
`boolean`	`isLeaf()`	Returns whether this is a leaf section containing no subsections
`java.util.List<Renderer>`	`renderers()`	Returns the live, modifiable list of renderers in this section
`void`	`setLeaf(boolean leaf)`
`java.util.List<Source>`	`sources()`	Returns the live, modifiable list of sources which are not fetched by the framework but should instead be included in the result

Methods inherited from class com.yahoo.search.result.HitGroup
add, add, addAll, addDataListener, addError, addErrorsFrom, analyze, asList, asUnorderedHits, clone, complete, copyOrdering, createAsync, deepIterator, ensureCapacity, get, get, get, get, getConcreteSize, getConcreteSizeShallow, getDeletionBreaksOrdering, getError, getErrorHit, getFilled, getOrderer, getSubgroupCount, incoming, isCached, isFillable, isFilled, iterator, remove, remove, remove, removeErrorHit, set, setDeletionBreaksOrdering, setFillable, setFilled, setId, setId, setOrdered, setOrderer, setSorted, size, sort, trim, unorderedDeepIterator, unorderedIterator

Methods inherited from class com.yahoo.search.result.Hit
assignId, buildHitField, clearFields, compareTo, equals, features, fieldIterator, fieldKeys, fields, forEachField, forEachFieldAsRaw, getField, getId, getQuery, getRelevance, getSearcherSpecificMetaData, getSource, hasField, hasFields, hashCode, isAuxiliary, isMeta, removeField, request, reserve, setAuxiliary, setCached, setField, setMeta, setQuery, setRelevance, setRelevance, setSearcherSpecificMetaData, setSource, toString, types

Methods inherited from class com.yahoo.component.provider.ListenableFreezableClass
addFreezeListener, freeze

Methods inherited from class com.yahoo.component.provider.FreezableClass
ensureNotFrozen, isFrozen

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

Methods inherited from interface com.yahoo.processing.response.Data
request

Methods inherited from interface com.yahoo.component.provider.Freezable
freeze, isFrozen

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface com.yahoo.component.provider.ListenableFreezable
addFreezeListener

- Constructor Detail
  - SectionHitGroup
```
public SectionHitGroup(java.lang.String id)
```
- Method Detail
  - getDisplayId
```
public java.lang.String getDisplayId()
```
    Description copied from class: Hit
    
    Returns the id to display, or null to not display (render) the id. This is useful to avoid displaying ids when they are not assigned explicitly but are just generated values for internal use. This default implementation returns Hit.getId().toString()
    
    Overrides:
    
    getDisplayId in class Hit
  - sources
```
public java.util.List<Source> sources()
```
    Returns the live, modifiable list of sources which are not fetched by the framework but should instead be included in the result
  - renderers
```
public java.util.List<Renderer> renderers()
```
    Returns the live, modifiable list of renderers in this section
  - isLeaf
```
public boolean isLeaf()
```
    Returns whether this is a leaf section containing no subsections
  - setLeaf
```
public void setLeaf(boolean leaf)
```
  - close
```
public void close()
```
    Description copied from class: Hit
    
    Releases the resources held by this, making it irreversibly unusable
    
    Specified by:
    
    close in interface com.yahoo.processing.response.DataList<Hit>
    
    Overrides:
    
    close in class HitGroup