Package com.funnelback.publicui.search.model.transaction

Class SearchResponse

  • public class SearchResponse
extends Object

    This class contains all the output data related to a search.

    Most of this data is coming from PADRE, but there is also data computed from the PADRE result set, such as facets.

    Since:
    11.0

    • Field Detail

      • resultPacket

        private ResultPacket resultPacket
        The result packet coming from PADRE

      • rawPacket

        private String rawPacket

        Raw XML packet as return by PADRE, for debugging purposes.

        Note: This is not included in the JSON / XML output for performance reasons

      • padreSwCmd

        private PadreSwCmd padreSwCmd
        The padre-sw command run to execute the query used to generate this search response.
        Since:
        15.24

      • returnCode

        private int returnCode
        PADRE return code (0 = success)

      • untruncatedPadreOutputSize

        private Integer untruncatedPadreOutputSize
        Amount of output produced by PADRE responding to the query, in bytes.
        Since:
        15.12

      • facets

        private final List<Facet> facets
        Computed facets based on the PADRE result packet and collection configuration.

      • facetExtras

        private final FacetExtras facetExtras
        Information about facets that is not available from facets
        Since:
        15.12

      • customData

        private final Map<String,​Object> customData
        Custom data placeholder allowing any arbitrary data to be stored by hook scripts.

      • curator

        private Curator curator
        Curator: Curated result packet data data.
        Since:
        13.0

      • translations

        private final Map<String,​String> translations

        Contains translation messages for the UI, for the locale given in the SearchQuestion.

        Note: This is not included in the JSON / XML output for performance reasons

        Since:
        12.0

      • performanceMetrics

        private Object performanceMetrics
        Performance metrics of each phase of the transaction lifecycle
        Since:
        12.4

    • Constructor Detail

      • SearchResponse

        public SearchResponse()

    • Method Detail

      • getFacetByName

        public Facet getFacetByName​(String name)
        Returns the first facet with the given name
        Parameters:
        name - The name of the facet that is wanted.
        Returns:
        the facet with the given name if not found null is returned.
        Since:
        15.14

      • hasResultPacket

        public boolean hasResultPacket()
        Returns:
        true if the resultPacket is not null.

      • getResultPacket

        public ResultPacket getResultPacket()
        The result packet coming from PADRE

      • setResultPacket

        public void setResultPacket​(ResultPacket resultPacket)
        The result packet coming from PADRE

      • getRawPacket

        public String getRawPacket()

        Raw XML packet as return by PADRE, for debugging purposes.

        Note: This is not included in the JSON / XML output for performance reasons

      • setRawPacket

        public void setRawPacket​(String rawPacket)

        Raw XML packet as return by PADRE, for debugging purposes.

        Note: This is not included in the JSON / XML output for performance reasons

      • getPadreSwCmd

        public PadreSwCmd getPadreSwCmd()
        The padre-sw command run to execute the query used to generate this search response.
        Since:
        15.24

      • setPadreSwCmd

        public void setPadreSwCmd​(PadreSwCmd padreSwCmd)
        The padre-sw command run to execute the query used to generate this search response.
        Since:
        15.24

      • getReturnCode

        public int getReturnCode()
        PADRE return code (0 = success)

      • setReturnCode

        public void setReturnCode​(int returnCode)
        PADRE return code (0 = success)

      • getUntruncatedPadreOutputSize

        public Integer getUntruncatedPadreOutputSize()
        Amount of output produced by PADRE responding to the query, in bytes.
        Since:
        15.12

      • setUntruncatedPadreOutputSize

        public void setUntruncatedPadreOutputSize​(Integer untruncatedPadreOutputSize)
        Amount of output produced by PADRE responding to the query, in bytes.
        Since:
        15.12

      • getFacets

        public List<Facet> getFacets()
        Computed facets based on the PADRE result packet and collection configuration.

      • getFacetExtras

        public FacetExtras getFacetExtras()
        Information about facets that is not available from facets
        Since:
        15.12

      • getCustomData

        public Map<String,​Object> getCustomData()
        Custom data placeholder allowing any arbitrary data to be stored by hook scripts.

      • getOptimiserModel

        public ContentOptimiserModel getOptimiserModel()
        Content Optimiser: URL comparison data.

      • setOptimiserModel

        public void setOptimiserModel​(ContentOptimiserModel optimiserModel)
        Content Optimiser: URL comparison data.

      • getCurator

        public Curator getCurator()
        Curator: Curated result packet data data.
        Since:
        13.0

      • setCurator

        public void setCurator​(Curator curator)
        Curator: Curated result packet data data.
        Since:
        13.0

      • getTranslations

        public Map<String,​String> getTranslations()

        Contains translation messages for the UI, for the locale given in the SearchQuestion.

        Note: This is not included in the JSON / XML output for performance reasons

        Since:
        12.0

      • getPerformanceMetrics

        public Object getPerformanceMetrics()
        Performance metrics of each phase of the transaction lifecycle
        Since:
        12.4

      • setPerformanceMetrics

        public void setPerformanceMetrics​(Object performanceMetrics)
        Performance metrics of each phase of the transaction lifecycle
        Since:
        12.4