Class LanguageQualifierProvider

  • All Implemented Interfaces:
    QualifierProvider

    public class LanguageQualifierProvider
    extends java.lang.Object
    implements QualifierProvider
    Qualifier provider for languages.

    The available qualifiers will be created based on the configured languages for the index configuration (see IndexConfig.getLanguages()).

    It supports the following types:

    • Constructor Detail

      • LanguageQualifierProvider

        public LanguageQualifierProvider()
    • Method Detail

      • setCommonI18NService

        public void setCommonI18NService​(CommonI18NService commonI18NService)
      • getSupportedTypes

        public java.util.Set<java.lang.Class<?>> getSupportedTypes()
        Description copied from interface: QualifierProvider
        Returns all the supported types by this provider.
        Specified by:
        getSupportedTypes in interface QualifierProvider
        Returns:
        the supported types
      • getAvailableQualifiers

        public java.util.Collection<Qualifier> getAvailableQualifiers​(FacetSearchConfig facetSearchConfig,
                                                                      IndexedType indexedType)
        Description copied from interface: QualifierProvider
        Returns all the possible qualifiers for a given index configuration and indexed type.
        Specified by:
        getAvailableQualifiers in interface QualifierProvider
        Parameters:
        facetSearchConfig - - the facet search configuration
        indexedType - - the indexed type
        Returns:
        the available qualifiers
      • canApply

        public boolean canApply​(IndexedProperty indexedProperty)
        Description copied from interface: QualifierProvider
        Checks if qualifiers can be applied/used with the indexed property passed as parameter.
        Specified by:
        canApply in interface QualifierProvider
        Parameters:
        indexedProperty - - the indexed property
        Returns:
        true if qualifiers can be used, false otherwise
      • applyQualifier

        public void applyQualifier​(Qualifier qualifier)
        Description copied from interface: QualifierProvider
        Applies the qualifier passed as parameter. This normally consists in setting some attributes on the session, e.g. by calling a service to set the current session language, currency, etc.
        Specified by:
        applyQualifier in interface QualifierProvider
        Parameters:
        qualifier - - the Qualifier to be applied
      • getCurrentQualifier

        public Qualifier getCurrentQualifier()
        Description copied from interface: QualifierProvider
        Returns the current qualifier. This normally consists in getting some attributes from the session and creating the corresponding qualifier.
        Specified by:
        getCurrentQualifier in interface QualifierProvider
        Returns:
        the current qualifier