Class 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
    • 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