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>
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Releases the resources held by this, making it irreversibly unusableReturns the id to display, or null to not display (render) the id.boolean
isLeaf()
Returns whether this is a leaf section containing no subsectionsReturns the live, modifiable list of renderers in this sectionvoid
setLeaf
(boolean leaf) sources()
Returns the live, modifiable list of sources which are not fetched by the framework but should instead be included in the resultMethods inherited from class com.yahoo.search.result.HitGroup
add, add, addAll, addDataListener, addError, addErrorsFrom, analyze, asList, asUnorderedHits, clone, 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, 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
-
SectionHitGroup
-
-
Method Details
-
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 the field DOCUMENT_ID if set, andHit.getId()
.toString() otherwise.- Overrides:
getDisplayId
in classHit
-
sources
Returns the live, modifiable list of sources which are not fetched by the framework but should instead be included in the result -
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
-