Package com.broadleafcommerce.search.core.service

Interface TypeAheadPostProcessor<T>

  • Type Parameters:
    T - The query object to be sent to the search engine. This should likely be the proprietary implementation supplied by a library. For SolrJ, for example, this is org.apache.solr.client.solrj.SolrQuery
    All Superinterfaces:
    org.springframework.core.Ordered
    public interface TypeAheadPostProcessor<T>
extends org.springframework.core.Ordered
    Interface allowing modification of TypeAhead query results after returning from the search engine.

    This processor should be consumed in a concrete implementation of TypeAheadService.

    • Field Summary

      • Fields inherited from interface org.springframework.core.Ordered

        HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void postProcess​(T queryResponse, com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse response, com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest request, com.broadleafcommerce.search.api.domain.TypeAheadConfiguration typeAheadConfiguration, SearchRequestProperties properties, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Modify the TypeAhead response received from the search engine.

      • Methods inherited from interface org.springframework.core.Ordered

        getOrder

    • Method Detail

      • postProcess

        void postProcess​(T queryResponse,
                 com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse response,
                 com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest request,
                 com.broadleafcommerce.search.api.domain.TypeAheadConfiguration typeAheadConfiguration,
                 SearchRequestProperties properties,
                 @Nullable
                 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
        Modify the TypeAhead response received from the search engine.
        Parameters:
        queryResponse - the search engine response
        response - TypeAhead response to process
        request -
        typeAheadConfiguration - TypeAhead configuration for the query
        properties -
        contextInfo - The context information surrounding sandboxing/multitenant state