de.hybris.platform.commercesearch.searchandizing.facet.reconfiguration

Interface FacetReconfigurationService

All Known Implementing Classes:

DefaultFacetReconfigurationService

public interface FacetReconfigurationService

This interface should be implemented by a service that is responsible for Solr facet reconfigurations. A Solr facet reconfiguration overrides facet attributes such as the 'visible' flag or the facet 'priority'. The SolrFacetReconfigurationModel attribute values could be copied from SolrIndexedPropertyModel or from other SolrFacetReconfigurationModel. Each Solr facet reconfiguration has assigned one facet that will be overridden. The Solr facet reconfiguration is assigned to a search profile that defines for which search the reconfiguration should be applied.

Method Summary

Modifier and Type	Method and Description
void	applyFacetReconfigurations(IndexedType indexedType, FacetSearchConfig facetSearchConfig, List<CategoryModel> selectedCategoryBackpath) Iterates through all categories identified in the category back path and applies the facet reconfiguration rules to the appropriate indexed properties.
void	applyFacetReconfigurations(SearchQuery searchQuery, List<CategoryModel> selectedCategoryBackpath) Iterates through all categories identified in the category back path and applies the facet reconfiguration rules to the appropriate indexed properties.
SolrFacetReconfigurationModel	createReconfiguration(SolrFacetReconfigurationModel facetReconfigurationModel, AbstractSolrSearchProfileModel searchProfile) This method creates a new SolrFacetReconfigurationModel based on the given SolrFacetReconfigurationModel.
SolrFacetReconfigurationModel	createReconfiguration(SolrIndexedPropertyModel indexedPropertyModel, AbstractSolrSearchProfileModel searchProfile) This method creates a new SolrFacetReconfigurationModel based on the given SolrIndexedPropertyModel.

Method Detail

createReconfiguration

SolrFacetReconfigurationModel createReconfiguration(SolrIndexedPropertyModel indexedPropertyModel,
                                                    AbstractSolrSearchProfileModel searchProfile)

This method creates a new SolrFacetReconfigurationModel based on the given SolrIndexedPropertyModel. The SolrIndexedPropertyModel attribute values will be populated to the new SolrFacetReconfigurationModel and the reconfiguration will be assigned to the given search profile.

Parameters:

indexedPropertyModel - Source indexed property model

searchProfile - Search profile to which the new Solr facet reconfiguration should be assigned.

Returns:

New facet reconfiguration.

createReconfiguration

SolrFacetReconfigurationModel createReconfiguration(SolrFacetReconfigurationModel facetReconfigurationModel,
                                                    AbstractSolrSearchProfileModel searchProfile)

This method creates a new SolrFacetReconfigurationModel based on the given SolrFacetReconfigurationModel. The SolrFacetReconfigurationModel attribute values will be populated to the new SolrFacetReconfigurationModel and the reconfiguration will be assigned to the given search profile.

Parameters:

facetReconfigurationModel - Source facet reconfiguration.

searchProfile - Search profile to which the new Solr facet reconfiguration should be assigned.

Returns:

New facet reconfiguration.

applyFacetReconfigurations

void applyFacetReconfigurations(SearchQuery searchQuery,
                                List<CategoryModel> selectedCategoryBackpath)

Iterates through all categories identified in the category back path and applies the facet reconfiguration rules to the appropriate indexed properties. Facets can be reconfigured according to priority, visibility, facet type and sort provider.

Parameters:

searchQuery - Search query

selectedCategoryBackpath - The list of all categories from the selected back to root

applyFacetReconfigurations

void applyFacetReconfigurations(IndexedType indexedType,
                                FacetSearchConfig facetSearchConfig,
                                List<CategoryModel> selectedCategoryBackpath)

Iterates through all categories identified in the category back path and applies the facet reconfiguration rules to the appropriate indexed properties. Facets can be reconfigured according to priority, visibility, facet type and sort provider.

Parameters:

indexedType - The given IndexedType

facetSearchConfig - The given FacetSearchConfig

selectedCategoryBackpath - The list of all categories from the selected back to root