com.yahoo.search.pagetemplates.result

Class SectionHitGroup

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>, Cloneable, Comparable<Hit>, 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

Modifier and Type	Field and Description
private String	displayId
private boolean	leaf
private List<Renderer>	renderers
private static long	serialVersionUID
private List<Source>	sources

Fields inherited from class com.yahoo.search.result.Hit

RANKFEATURES_FIELD, SDDOCNAME_FIELD

Constructor Summary

Constructors

Constructor and Description
SectionHitGroup(String id)

Method Summary

Modifier and Type	Method and Description
void	close() Releases the resources held by this, making it irreversibly unusable
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
List<Renderer>	renderers() Returns the live, modifiable list of renderers in this section
void	setLeaf(boolean leaf)
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, analyze, asList, asUnorderedHits, clone, complete, copyOrdering, createAsync, deepIterator, get, get, get, get, getConcreteSize, getConcreteSizeShallow, getDeletionBreaksOrdering, getError, getErrorHit, getFilled, getOrderer, getSubgroupCount, incoming, isCached, isFillable, isFilled, iterator, remove, remove, remove, removeErrorHit, set, setDeletionBreaksOrdering, setError, setFillable, setFilled, setId, setId, setOrdered, setOrderer, setSorted, size, sort, trim, unorderedDeepIterator, unorderedIterator

Methods inherited from class com.yahoo.search.result.Hit

assignId, buildHitField, buildHitField, buildHitField, changeFieldKey, clearFields, compareTo, equals, fieldIterator, fieldKeys, fields, forEachField, forEachFieldAsRaw, getAddNumber, getField, getFieldXML, getFilledInternal, getId, getQuery, getRelevance, getSearcherSpecificMetaData, getSource, getSourceNumber, getTypeString, getUnboldedField, hasField, hasFields, hashCode, isAuxiliary, isMeta, removeField, request, reserve, setAddNumber, setAuxiliary, setCached, setField, setFilledInternal, setMeta, setQuery, setRelevance, setRelevance, setSearcherSpecificMetaData, setSource, setSourceNumber, stripCharacter, 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.ListenableFreezable

addFreezeListener

Methods inherited from interface com.yahoo.component.provider.Freezable

freeze, isFrozen

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

sources

private List<Source> sources

renderers

private List<Renderer> renderers

displayId

private final String displayId

leaf

private boolean leaf

Constructor Detail

SectionHitGroup

public SectionHitGroup(String id)

Method Detail

getDisplayId

public 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 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 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