de.hybris.platform.solrfacetsearch.provider

Interface FacetDisplayNameProvider

All Known Implementing Classes:

AbstractFacetValueDisplayNameProvider, CategoryFacetDisplayNameProvider, ColorFacetDisplayNameProvider, CommerceCategoryFacetDisplayNameProvider, CustomerCouponFacetDisplayNameProvider, GenderFacetDisplayNameProvider, PointOfServiceFacetDisplayNameProvider, PointOfServiceFacetDisplayNameProvider, ProductVendorFacetDisplayNameProvider, PromotionFacetDisplayNameProvider

public interface FacetDisplayNameProvider

Interface used to lookup a display name for a specific facet value. Facet values retrieved from Solr are simple strings which cannot encode localised display values, therefore this interface can be used to provide additional displayable data for the facet value. A spring bean that implements this interface can be associated with an IndexedProperty and is then used to resolve a display name for a specific facet value.

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	LOG

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayName(SearchQuery query, java.lang.String name) Deprecated. Since 5.5, implement the FacetValueDisplayNameProvider.getDisplayName(de.hybris.platform.solrfacetsearch.search.SearchQuery, de.hybris.platform.solrfacetsearch.config.IndexedProperty, String) method instead.

Field Detail

LOG

static final Logger LOG

Method Detail

getDisplayName

@Deprecated
java.lang.String getDisplayName(SearchQuery query,
                                            java.lang.String name)

Deprecated. Since 5.5, implement the FacetValueDisplayNameProvider.getDisplayName(de.hybris.platform.solrfacetsearch.search.SearchQuery, de.hybris.platform.solrfacetsearch.config.IndexedProperty, String) method instead.

Get the display name for a facet value. This method is deprecated as is does not pass the facet which contains the facet value. Implementers should implement the FacetValueDisplayNameProvider.getDisplayName(de.hybris.platform.solrfacetsearch.search.SearchQuery, de.hybris.platform.solrfacetsearch.config.IndexedProperty, String) method instead.

Parameters:

query - The search query

name - The facet value

Returns:

The display name for the specified facet value.