Package com.yahoo.search.grouping.result

Class GroupList

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.grouping.result.AbstractList

com.yahoo.search.grouping.result.GroupList

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 GroupList
extends AbstractList

This class represents a labeled group list in the grouping result model. It is contained in Group, and contains one or more groups itself, allowing for a hierarchy of grouping results. Use the GroupingRequest.getResultGroup(Result) to retrieve grouping results.

Author:

Simon Thoresen Hult

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
GroupList(String label)	Constructs a new instance of this class.

Method Summary

Methods inherited from class com.yahoo.search.grouping.result.AbstractList

close, continuations, getLabel

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

add, add, addAll, addDataListener, addError, addErrorsFrom, analyze, asList, asUnorderedHits, clone, complete, completeFuture, 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, getDisplayId, 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 Details

GroupList

public GroupList(String label)

Constructs a new instance of this class.

Parameters:

label - the label to assign to this