Package com.yahoo.search.grouping.result

Class Group

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.Group

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>

Direct Known Subclasses:

RootGroup

public class Group
extends HitGroup

This class represents a single group in the grouping result model. A group may contain any number of results (stored as fields, use Hit.getField(String) to access), GroupList and HitList. Use the GroupingRequest.getResultGroup(com.yahoo.search.Result) to retrieve an instance of this.

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
Group(GroupId groupId, Relevance rel)	Creates a new instance of this class.

Method Summary

Modifier and Type	Method	Description
GroupId	getGroupId()	Returns the id of this group.
GroupList	getGroupList(java.lang.String label)	Returns the GroupList with the given label.
HitList	getHitList(java.lang.String label)	Returns the HitList with the given label.

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

add, add, addAll, addDataListener, addError, analyze, asList, asUnorderedHits, clone, close, 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, 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 Detail

Group

public Group(GroupId groupId,
             Relevance rel)

Creates a new instance of this class.

Parameters:

groupId - The id to assign to this group.

rel - The relevance of this group.

Method Detail

getGroupId

public GroupId getGroupId()

Returns the id of this group. This is a model of the otherwise flattened hit id.

Returns:

The group id.

getHitList

public HitList getHitList(java.lang.String label)

Returns the HitList with the given label. The label is the one given to the EachOperation that generated the list. This method returns null if no such list was found.

Parameters:

label - The label of the list to return.

Returns:

The requested list, or null.

getGroupList

public GroupList getGroupList(java.lang.String label)

Returns the GroupList with the given label. The label is the one given to the EachOperation that generated the list. This method returns null if no such list was found.

Parameters:

label - The label of the list to return.

Returns:

The requested list, or null.