Package com.broadleafcommerce.search.core.service

Interface TypeAheadPreProcessor<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 TypeAheadPreProcessor<T>
extends org.springframework.core.Ordered
    Interface allowing the modification of TypeAhead queries before the query is sent to the search engine.

    This processor is most likely to 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 preProcess​(T query, com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest typeAheadRequest, com.broadleafcommerce.search.api.domain.TypeAheadConfiguration typeAheadConfiguration, SearchRequestProperties properties, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Modify the TypeAhead query prior to sending to the search engine.

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

        getOrder

    • Method Detail

      • preProcess

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