Package com.broadleafcommerce.search.provider.solr

Interface SolrQueryContributor

All Superinterfaces:
org.springframework.core.Ordered
All Known Subinterfaces:
IndexableTypeSolrQueryContributor
All Known Implementing Classes:
AbstractSolrQueryContributor, ApplicationTrackableSolrQueryContributor, CatalogTrackableSolrQueryContributor, CustomerContextTrackableSolrQueryContributor, DefaultSearchableSolrQueryContributor, DefaultSolrActiveDateContributor, DefaultSolrFacetContributor, DefaultSolrFilterContributor, DefaultSolrSearchFieldContributor, DefaultSolrSortContributor, DefaultSolrSpellCheckContributor, QueryTypeSolrQueryContributor, RelevancyRulesSolrQueryContributor, RSQLSolrQueryContributor, SandboxTrackableSolrQueryContributor, SolrScoreSolrQueryContributor, TenantTrackableSolrQueryContributor, VendorDiscriminationSolrQueryContributor
public interface SolrQueryContributor extends org.springframework.core.Ordered
Adds more specific behavior to customize a Solr Query for search.

  • Field Summary

    Fields inherited from interface org.springframework.core.Ordered

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    contribute(org.apache.solr.client.solrj.SolrQuery solrQuery, com.broadleafcommerce.search.api.domain.SearchRequest searchRequest, List<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitions, org.springframework.data.domain.Pageable page, com.broadleafcommerce.search.core.service.SearchRequestProperties properties, String locale, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Customize the provided solrQuery with some additional behavior.
    default boolean
    contributeOnTypeAhead()
     
    default int
    getOrder()
    Default Spring Bean ordering.
    default boolean
    isTypeAheadRequest(com.broadleafcommerce.search.core.service.SearchRequestProperties properties)
     

  • Method Details

    • contribute

      void contribute(org.apache.solr.client.solrj.SolrQuery solrQuery, com.broadleafcommerce.search.api.domain.SearchRequest searchRequest, List<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitions, org.springframework.data.domain.Pageable page, com.broadleafcommerce.search.core.service.SearchRequestProperties properties, @Nullable String locale, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Customize the provided solrQuery with some additional behavior.
      Parameters:
      solrQuery - The query to customize
      searchRequest - The search query request
      fieldDefinitions - The fields to perform the search on
      page - Page information for page to retrieve for query
      properties - Additional properties for this search
      locale - (optional) the locale of the query
      context - The context information surrounding sandboxing/multitenant state

    • contributeOnTypeAhead

      default boolean contributeOnTypeAhead()
      Returns:
      Should this contributor be executed on TypeAhead requests?

    • isTypeAheadRequest

      default boolean isTypeAheadRequest(com.broadleafcommerce.search.core.service.SearchRequestProperties properties)
      Parameters:
      properties - Additional properties for this search.
      Returns:
      true if this is a typeahead request, else false.

    • getOrder

      default int getOrder()
      Default Spring Bean ordering.
      Specified by:
      getOrder in interface org.springframework.core.Ordered
      Returns: