de.hybris.platform.solrfacetsearch.provider.impl

Class AbstractFacetValueDisplayNameProvider

java.lang.Object

de.hybris.platform.solrfacetsearch.provider.impl.AbstractFacetValueDisplayNameProvider

All Implemented Interfaces:

FacetDisplayNameProvider, FacetValueDisplayNameProvider

Direct Known Subclasses:

ColorFacetDisplayNameProvider, CustomerCouponFacetDisplayNameProvider, GenderFacetDisplayNameProvider, PointOfServiceFacetDisplayNameProvider, PointOfServiceFacetDisplayNameProvider, ProductVendorFacetDisplayNameProvider, PromotionFacetDisplayNameProvider

public abstract class AbstractFacetValueDisplayNameProvider
extends java.lang.Object
implements FacetValueDisplayNameProvider, FacetDisplayNameProvider

Abstract implementation of the FacetValueDisplayNameProvider interface. Implementers of the FacetValueDisplayNameProvider interface should typically extend this class. This class also implements the deprecated FacetDisplayNameProvider simply as a marker interface as this is the interface that is bound to the IndexedProperty.

Field Summary

Fields inherited from interface de.hybris.platform.solrfacetsearch.provider.FacetDisplayNameProvider

LOG

Constructor Summary

Constructors

Constructor and Description
AbstractFacetValueDisplayNameProvider()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getDisplayName(SearchQuery query, IndexedProperty property, java.lang.String facetValue) Get the display name for a facet value.
java.lang.String	getDisplayName(SearchQuery query, java.lang.String name) Get the display name for a facet value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractFacetValueDisplayNameProvider

public AbstractFacetValueDisplayNameProvider()

Method Detail

getDisplayName

public final java.lang.String getDisplayName(SearchQuery query,
                                             java.lang.String name)

Description copied from interface: FacetDisplayNameProvider

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.

Specified by:

getDisplayName in interface FacetDisplayNameProvider

Parameters:

query - The search query

name - The facet value

Returns:

The display name for the specified facet value.

getDisplayName

public abstract java.lang.String getDisplayName(SearchQuery query,
                                                IndexedProperty property,
                                                java.lang.String facetValue)

Get the display name for a facet value.

Specified by:

getDisplayName in interface FacetValueDisplayNameProvider

Parameters:

query - The search query

property - The indexed property (i.e. the facet)

facetValue - The facet value

Returns:

The display name for the specified facet value.