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>
,Cloneable
,Comparable<Hit>
,Iterable<Hit>
- Direct Known Subclasses:
RootGroup
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
-
Method Summary
Modifier and TypeMethodDescriptionReturns the id of this group.getGroupList
(String label) Returns theGroupList
with the given label.getHitList
(String label) Returns theHitList
with the given label.Methods inherited from class com.yahoo.search.result.HitGroup
add, add, addAll, addDataListener, addError, addErrorsFrom, analyze, asList, asUnorderedHits, clone, close, 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
-
Group
Creates a new instance of this class.- Parameters:
groupId
- the id to assign to this grouprel
- the relevance of this group
-
-
Method Details
-
getGroupId
Returns the id of this group. This is a model of the otherwise flattenedhit id
. -
getHitList
Returns theHitList
with the given label. The label is the one given to theEachOperation
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
Returns theGroupList
with the given label. The label is the one given to theEachOperation
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
-