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

Class SearchResponse

  • public class SearchResponse
extends java.lang.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 Summary

      Fields 
      Modifier and Type Field Description
      private Curator curator
      Curator: Curated result packet data data.
      private java.util.Map<java.lang.String,​java.lang.Object> customData
      Custom data placeholder allowing any arbitrary data to be stored by hook scripts.
      private FacetExtras facetExtras
      Information about facets that is not available from facets
      private java.util.List<Facet> facets
      Computed facets based on the PADRE result packet and collection configuration.
      private ContentOptimiserModel optimiserModel
      Content Optimiser: URL comparison data.
      private PadreSwCmd padreSwCmd
      The padre-sw command run to execute the query used to generate this search response.
      private org.springframework.util.StopWatch performanceMetrics
      Performance metrics of each phase of the transaction lifecycle
      private java.lang.String rawPacket
      Raw XML packet as return by PADRE, for debugging purposes.
      private ResultPacket resultPacket
      The result packet coming from PADRE
      private int returnCode
      PADRE return code (0 = success)
      private java.util.Map<java.lang.String,​java.lang.String> translations
      Contains translation messages for the UI, for the locale given in the SearchQuestion.
      private java.lang.Integer untruncatedPadreOutputSize
      Amount of output produced by PADRE responding to the query, in bytes.

    • Constructor Summary

      Constructors 
      Constructor Description
      SearchResponse()  

    • Field Detail

      • resultPacket

        private ResultPacket resultPacket
        The result packet coming from PADRE

      • rawPacket

        private java.lang.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 java.lang.Integer untruncatedPadreOutputSize
        Amount of output produced by PADRE responding to the query, in bytes.
        Since:
        15.12

      • facets

        private final java.util.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 java.util.Map<java.lang.String,​java.lang.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 java.util.Map<java.lang.String,​java.lang.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 org.springframework.util.StopWatch performanceMetrics
        Performance metrics of each phase of the transaction lifecycle
        Since:
        12.4

    • Constructor Detail

      • SearchResponse

        public SearchResponse()

    • Method Detail

      • getFacetByName

        public Facet getFacetByName​(java.lang.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.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getResultPacket

        public ResultPacket getResultPacket()
        The result packet coming from PADRE

      • setResultPacket

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

      • getRawPacket

        public java.lang.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​(java.lang.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 java.lang.Integer getUntruncatedPadreOutputSize()
        Amount of output produced by PADRE responding to the query, in bytes.
        Since:
        15.12

      • setUntruncatedPadreOutputSize

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

      • getFacets

        public java.util.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 java.util.Map<java.lang.String,​java.lang.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 java.util.Map<java.lang.String,​java.lang.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 org.springframework.util.StopWatch getPerformanceMetrics()
        Performance metrics of each phase of the transaction lifecycle
        Since:
        12.4

      • setPerformanceMetrics

        public void setPerformanceMetrics​(org.springframework.util.StopWatch performanceMetrics)
        Performance metrics of each phase of the transaction lifecycle
        Since:
        12.4