Package de.hybris.platform.adaptivesearch.searchservices.strategies.impl

Class SnAsSearchProvider

java.lang.Object

de.hybris.platform.adaptivesearch.searchservices.strategies.impl.SnAsSearchProvider

All Implemented Interfaces:

AsSearchProvider, org.springframework.beans.factory.InitializingBean

public class SnAsSearchProvider
extends java.lang.Object
implements AsSearchProvider, org.springframework.beans.factory.InitializingBean

Implementation of AsSearchProvider that uses the searchservices API.

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	FACET_SORT_KEY_PREFIX
protected static java.util.Set<AsFeatureFlag>	SUPPORTED_FEATURES

Constructor Summary

Constructors

Constructor	Description
SnAsSearchProvider()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected int	compareExpressions(AsExpressionData expression1, AsExpressionData expression2)
protected AsFacetValueData	convertBucketResponse(AbstractSnBucketResponse source, java.util.Set<java.lang.String> selectedBucketIds)
protected AsDocumentData	convertDocument(SnSearchHit source)
protected AsExpressionData	convertExpression(SnExpressionInfo source)
protected AsFacetData	convertFacetResponse(AbstractSnFacetResponse source)
protected AsIndexConfigurationData	convertIndexConfiguration(SnIndexConfiguration source)
protected AsIndexPropertyData	convertIndexProperty(SnField source)
protected AsIndexTypeData	convertIndexType(SnIndexType source)
protected AsSortData	convertNamedSort(SnNamedSort source)
protected AsFacetData	convertRangeBucketsFacetResponse(SnRangeBucketsFacetResponse source)
protected SnSearchQuery	convertSearchQuery(AsSearchProfileContext context, AsSearchQueryData source)
protected AsSearchResultData	convertSearchResult(SnSearchResult source)
protected AsFacetData	convertTermBucketsFacetResponse(SnTermBucketsFacetResponse source)
protected AsFacetSortData	createFacetSort(java.lang.String sortId)
protected PK	extractPkFromSearchHit(SnSearchHit searchHit)
java.util.List<java.lang.String>	getAvailableQualifiers(java.lang.String indexType, java.lang.String indexPropertyId)	Return list of qualifiers for index property.
protected java.util.Map<java.lang.String,AsBoostOperator>	getBoostOperatorMapping()
CatalogVersionService	getCatalogVersionService()
CommonI18NService	getCommonI18NService()
java.util.Optional<AsIndexConfigurationData>	getIndexConfigurationForCode(java.lang.String id)	Returns the index configuration for the provided code.
java.util.List<AsIndexConfigurationData>	getIndexConfigurations()	Returns a list of index configurations.
java.util.List<AsIndexPropertyData>	getIndexProperties(java.lang.String indexTypeId)	Returns a list of index properties for a given index type.
java.util.Optional<AsIndexPropertyData>	getIndexPropertyForCode(java.lang.String indexTypeId, java.lang.String id)	Returns the index property for the provided code.
java.util.Optional<AsIndexTypeData>	getIndexTypeForCode(java.lang.String id)	Returns the index type for the provided code.
java.util.List<AsIndexTypeData>	getIndexTypes()	Returns a list of index types.
java.util.List<AsIndexTypeData>	getIndexTypes(java.lang.String indexConfigurationId)	Returns a list of index types for a given index configuration.
L10NService	getL10nService()
SnCommonConfigurationService	getSnCommonConfigurationService()
SnContextFactory	getSnContextFactory()
SnFieldTypeRegistry	getSnFieldTypeRegistry()
SnIndexConfigurationService	getSnIndexConfigurationService()
SnIndexTypeService	getSnIndexTypeService()
SnQualifierTypeFactory	getSnQualifierTypeFactory()
SnSearchService	getSnSearchService()
SnSessionService	getSnSessionService()
java.util.List<AsBoostType>	getSupportedBoostTypes(java.lang.String indexType)	Returns a list of boost types for a given index type.
java.util.List<CatalogVersionModel>	getSupportedCatalogVersions(java.lang.String indexConfigurationId, java.lang.String indexTypeId)	Returns a list of catalog versions for a given index configuration and type.
java.util.List<CurrencyModel>	getSupportedCurrencies(java.lang.String indexConfigurationId, java.lang.String indexTypeId)	Returns a list of currencies for a given index configuration and type.
java.util.List<AsExpressionData>	getSupportedFacetExpressions(java.lang.String indexTypeId)	Returns a list of expressions for a given index type that can be used for facets.
java.util.List<AsIndexPropertyData>	getSupportedFacetIndexProperties(java.lang.String indexTypeId)	Returns a list of index properties for a given index type that can be used for facets.
java.util.List<AsFacetSortData>	getSupportedFacetSorts(java.lang.String indexType)	Returns a list of facet sorts for a given index type.
java.util.List<AsFacetType>	getSupportedFacetTypes(java.lang.String indexType)	Returns a list of facet types for a given index type.
java.util.Set<AsFeatureFlag>	getSupportedFeatures(java.lang.String indexType)	Returns a list of supported features.
java.util.List<AsExpressionData>	getSupportedGroupExpressions(java.lang.String indexTypeId)	Returns a list of expressions for a given index type that can be used for groups.
java.util.List<LanguageModel>	getSupportedLanguages(java.lang.String indexConfigurationId, java.lang.String indexTypeId)	Returns a list of languages for a given index configuration and type.
java.util.List<AsExpressionData>	getSupportedSortExpressions(java.lang.String indexTypeId)	Returns a list of expressions for a given index type that can be used for sorts.
TypeService	getTypeService()
boolean	isValidBoostType(java.lang.String indexType, AsBoostType boostType)	Checks if a given boost type can be used for a given index type.
boolean	isValidFacetExpression(java.lang.String indexTypeId, java.lang.String expression)	Checks if a given index property can be used for facets.
boolean	isValidFacetIndexProperty(java.lang.String indexTypeId, java.lang.String indexPropertyId)	Checks is a given index property can be used for facets.
boolean	isValidFacetSort(java.lang.String indexType, java.lang.String sort)	Checks if a given sort can be used for facets.
boolean	isValidFacetType(java.lang.String indexType, AsFacetType facetType)	Checks if a given facet type can be used for a given index type.
boolean	isValidGroupExpression(java.lang.String indexTypeId, java.lang.String expression)	Checks if a given expression can be used for groups.
boolean	isValidSortExpression(java.lang.String indexTypeId, java.lang.String expression)	Checks if a given expression can be used for sorts.
AsSearchResultData	performSearch(AsSearchProfileContext context, AsSearchQueryData query)
protected void	populateBoostOperatorMapping()
protected CategoryModel	resolveSelectedCategory(java.util.List<CategoryModel> categoryPath)
AsSearchResultData	search(AsSearchProfileContext context, AsSearchQueryData searchQuery)	Performs a search query.
void	setCatalogVersionService(CatalogVersionService catalogVersionService)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setL10nService(L10NService l10nService)
void	setSnCommonConfigurationService(SnCommonConfigurationService snCommonConfigurationService)
void	setSnContextFactory(SnContextFactory snContextFactory)
void	setSnFieldTypeRegistry(SnFieldTypeRegistry snFieldTypeRegistry)
void	setSnIndexConfigurationService(SnIndexConfigurationService snIndexConfigurationService)
void	setSnIndexTypeService(SnIndexTypeService snIndexTypeService)
void	setSnQualifierTypeFactory(SnQualifierTypeFactory snQualifierTypeFactory)
void	setSnSearchService(SnSearchService snSearchService)
void	setSnSessionService(SnSessionService snSessionService)
void	setTypeService(TypeService typeService)

Methods inherited from class java.lang.Object

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

Field Detail

SUPPORTED_FEATURES

protected static final java.util.Set<AsFeatureFlag> SUPPORTED_FEATURES

FACET_SORT_KEY_PREFIX

protected static final java.lang.String FACET_SORT_KEY_PREFIX

See Also:

Constant Field Values

Constructor Detail

SnAsSearchProvider

public SnAsSearchProvider()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

populateBoostOperatorMapping

protected void populateBoostOperatorMapping()

getBoostOperatorMapping

protected java.util.Map<java.lang.String,AsBoostOperator> getBoostOperatorMapping()

getSupportedFeatures

public java.util.Set<AsFeatureFlag> getSupportedFeatures(java.lang.String indexType)

Description copied from interface: AsSearchProvider

Returns a list of supported features.

Specified by:

getSupportedFeatures in interface AsSearchProvider

Parameters:

indexType - - the index type code

Returns:

the supported features

getIndexConfigurations

public java.util.List<AsIndexConfigurationData> getIndexConfigurations()

Description copied from interface: AsSearchProvider

Returns a list of index configurations.

Specified by:

getIndexConfigurations in interface AsSearchProvider

Returns:

the index configurations

getIndexConfigurationForCode

public java.util.Optional<AsIndexConfigurationData> getIndexConfigurationForCode(java.lang.String id)

Description copied from interface: AsSearchProvider

Returns the index configuration for the provided code.

Specified by:

getIndexConfigurationForCode in interface AsSearchProvider

Parameters:

id - - the index configuration code

Returns:

the index type

getIndexTypes

public java.util.List<AsIndexTypeData> getIndexTypes()

Description copied from interface: AsSearchProvider

Returns a list of index types.

Specified by:

getIndexTypes in interface AsSearchProvider

Returns:

the index types

getIndexTypes

public java.util.List<AsIndexTypeData> getIndexTypes(java.lang.String indexConfigurationId)

Description copied from interface: AsSearchProvider

Returns a list of index types for a given index configuration.

Specified by:

getIndexTypes in interface AsSearchProvider

Parameters:

indexConfigurationId - - the index configuration code

Returns:

the index types

getIndexTypeForCode

public java.util.Optional<AsIndexTypeData> getIndexTypeForCode(java.lang.String id)

Description copied from interface: AsSearchProvider

Returns the index type for the provided code.

Specified by:

getIndexTypeForCode in interface AsSearchProvider

Parameters:

id - - the index type code

Returns:

the index type

getIndexProperties

public java.util.List<AsIndexPropertyData> getIndexProperties(java.lang.String indexTypeId)

Description copied from interface: AsSearchProvider

Returns a list of index properties for a given index type.

Specified by:

getIndexProperties in interface AsSearchProvider

Parameters:

indexTypeId - - the index type code

Returns:

the index properties

getIndexPropertyForCode

public java.util.Optional<AsIndexPropertyData> getIndexPropertyForCode(java.lang.String indexTypeId,
                                                                       java.lang.String id)

Description copied from interface: AsSearchProvider

Returns the index property for the provided code.

Specified by:

getIndexPropertyForCode in interface AsSearchProvider

id - - the index property code

Returns:

the index property

getSupportedCatalogVersions

public java.util.List<CatalogVersionModel> getSupportedCatalogVersions(java.lang.String indexConfigurationId,
                                                                       java.lang.String indexTypeId)

Description copied from interface: AsSearchProvider

Returns a list of catalog versions for a given index configuration and type.

Specified by:

getSupportedCatalogVersions in interface AsSearchProvider

Parameters:

indexConfigurationId - - the index configuration

indexTypeId - - the index type

Returns:

the catalog versions

getSupportedLanguages

public java.util.List<LanguageModel> getSupportedLanguages(java.lang.String indexConfigurationId,
                                                           java.lang.String indexTypeId)

Description copied from interface: AsSearchProvider

Returns a list of languages for a given index configuration and type.

Specified by:

getSupportedLanguages in interface AsSearchProvider

Parameters:

indexConfigurationId - - the index configuration

indexTypeId - - the index type

Returns:

the languages

getSupportedCurrencies

public java.util.List<CurrencyModel> getSupportedCurrencies(java.lang.String indexConfigurationId,
                                                            java.lang.String indexTypeId)

Description copied from interface: AsSearchProvider

Returns a list of currencies for a given index configuration and type.

Specified by:

getSupportedCurrencies in interface AsSearchProvider

Parameters:

indexConfigurationId - - the index configuration

indexTypeId - - the index type

Returns:

the currencies

getSupportedFacetIndexProperties

public java.util.List<AsIndexPropertyData> getSupportedFacetIndexProperties(java.lang.String indexTypeId)

Description copied from interface: AsSearchProvider

Returns a list of index properties for a given index type that can be used for facets.

Specified by:

getSupportedFacetIndexProperties in interface AsSearchProvider

Parameters:

indexTypeId - - the index type code

Returns:

the index properties

isValidFacetIndexProperty

public boolean isValidFacetIndexProperty(java.lang.String indexTypeId,
                                         java.lang.String indexPropertyId)

Description copied from interface: AsSearchProvider

Checks is a given index property can be used for facets.

Specified by:

isValidFacetIndexProperty in interface AsSearchProvider

Parameters:

indexTypeId - - the index type code

indexPropertyId - - the code of the index property

Returns:

true if the index property can be used for facets, false otherwise

getSupportedFacetExpressions

public java.util.List<AsExpressionData> getSupportedFacetExpressions(java.lang.String indexTypeId)

Description copied from interface: AsSearchProvider

Returns a list of expressions for a given index type that can be used for facets.

Specified by:

getSupportedFacetExpressions in interface AsSearchProvider

Parameters:

indexTypeId - - the index type code

Returns:

the expressions

isValidFacetExpression

public boolean isValidFacetExpression(java.lang.String indexTypeId,
                                      java.lang.String expression)

Description copied from interface: AsSearchProvider

Checks if a given index property can be used for facets.

Specified by:

isValidFacetExpression in interface AsSearchProvider

Parameters:

indexTypeId - - the index type code

expression - - the facet expression

Returns:

true if expression can be used for facets, false otherwise

getSupportedFacetTypes

public java.util.List<AsFacetType> getSupportedFacetTypes(java.lang.String indexType)

Description copied from interface: AsSearchProvider

Returns a list of facet types for a given index type.

Specified by:

getSupportedFacetTypes in interface AsSearchProvider

Parameters:

indexType - - the index type code

Returns:

the facet types

isValidFacetType

public boolean isValidFacetType(java.lang.String indexType,
                                AsFacetType facetType)

Description copied from interface: AsSearchProvider

Checks if a given facet type can be used for a given index type.

Specified by:

isValidFacetType in interface AsSearchProvider

Parameters:

indexType - - the index type code

facetType - - the facet type

Returns:

true if facet type can be used, false otherwise

getSupportedFacetSorts

public java.util.List<AsFacetSortData> getSupportedFacetSorts(java.lang.String indexType)

Description copied from interface: AsSearchProvider

Returns a list of facet sorts for a given index type.

Specified by:

getSupportedFacetSorts in interface AsSearchProvider

Parameters:

indexType - - the index type code

Returns:

the facet sorts

createFacetSort

protected AsFacetSortData createFacetSort(java.lang.String sortId)

isValidFacetSort

public boolean isValidFacetSort(java.lang.String indexType,
                                java.lang.String sort)

Description copied from interface: AsSearchProvider

Checks if a given sort can be used for facets.

Specified by:

isValidFacetSort in interface AsSearchProvider

Parameters:

indexType - - the index type code

sort - - the sort

Returns:

true if sort can be used for facets, false otherwise

getSupportedBoostTypes

public java.util.List<AsBoostType> getSupportedBoostTypes(java.lang.String indexType)

Description copied from interface: AsSearchProvider

Returns a list of boost types for a given index type.

Specified by:

getSupportedBoostTypes in interface AsSearchProvider

Parameters:

indexType - - the index type code

Returns:

the boost types

isValidBoostType

public boolean isValidBoostType(java.lang.String indexType,
                                AsBoostType boostType)

Description copied from interface: AsSearchProvider

Checks if a given boost type can be used for a given index type.

Specified by:

isValidBoostType in interface AsSearchProvider

Parameters:

indexType - - the index type code

boostType - - the boost type

Returns:

true if boost type can be used, false otherwise

getSupportedSortExpressions

public java.util.List<AsExpressionData> getSupportedSortExpressions(java.lang.String indexTypeId)

Description copied from interface: AsSearchProvider

Returns a list of expressions for a given index type that can be used for sorts.

Specified by:

getSupportedSortExpressions in interface AsSearchProvider

Parameters:

indexTypeId - - the index type code

Returns:

the expressions

isValidSortExpression

public boolean isValidSortExpression(java.lang.String indexTypeId,
                                     java.lang.String expression)

Description copied from interface: AsSearchProvider

Checks if a given expression can be used for sorts.

Specified by:

isValidSortExpression in interface AsSearchProvider

Parameters:

indexTypeId - - the index type code

expression - - the sort expression

Returns:

true if expression can be used for sorts, false otherwise

getSupportedGroupExpressions

public java.util.List<AsExpressionData> getSupportedGroupExpressions(java.lang.String indexTypeId)

Description copied from interface: AsSearchProvider

Returns a list of expressions for a given index type that can be used for groups.

Specified by:

getSupportedGroupExpressions in interface AsSearchProvider

Parameters:

indexTypeId - - the index type code

Returns:

the expressions

isValidGroupExpression

public boolean isValidGroupExpression(java.lang.String indexTypeId,
                                      java.lang.String expression)

Description copied from interface: AsSearchProvider

Checks if a given expression can be used for groups.

Specified by:

isValidGroupExpression in interface AsSearchProvider

Parameters:

indexTypeId - - the index type code

expression - - the sort expression

Returns:

true if expression can be used for groups, false otherwise

getAvailableQualifiers

public java.util.List<java.lang.String> getAvailableQualifiers(java.lang.String indexType,
                                                               java.lang.String indexPropertyId)
                                                        throws AsException

Description copied from interface: AsSearchProvider

Return list of qualifiers for index property.

Specified by:

getAvailableQualifiers in interface AsSearchProvider

Parameters:

indexType - - the index type code

indexPropertyId - - the index property code

Returns:

the qualifiers

Throws:

AsException

search

public AsSearchResultData search(AsSearchProfileContext context,
                                 AsSearchQueryData searchQuery)
                          throws AsException

Description copied from interface: AsSearchProvider

Performs a search query.

Specified by:

search in interface AsSearchProvider

Parameters:

context - - the search profile context

searchQuery - - the search query

Throws:

AsException - if and exception occurs during the search

performSearch

public AsSearchResultData performSearch(AsSearchProfileContext context,
                                        AsSearchQueryData query)
                                 throws AsException

Throws:

AsException

convertSearchQuery

protected SnSearchQuery convertSearchQuery(AsSearchProfileContext context,
                                           AsSearchQueryData source)

resolveSelectedCategory

protected CategoryModel resolveSelectedCategory(java.util.List<CategoryModel> categoryPath)

convertSearchResult

protected AsSearchResultData convertSearchResult(SnSearchResult source)

convertIndexConfiguration

protected AsIndexConfigurationData convertIndexConfiguration(SnIndexConfiguration source)

convertIndexType

protected AsIndexTypeData convertIndexType(SnIndexType source)

convertIndexProperty

protected AsIndexPropertyData convertIndexProperty(SnField source)

convertExpression

protected AsExpressionData convertExpression(SnExpressionInfo source)

compareExpressions

protected int compareExpressions(AsExpressionData expression1,
                                 AsExpressionData expression2)

convertDocument

protected AsDocumentData convertDocument(SnSearchHit source)

convertFacetResponse

protected AsFacetData convertFacetResponse(AbstractSnFacetResponse source)

convertTermBucketsFacetResponse

protected AsFacetData convertTermBucketsFacetResponse(SnTermBucketsFacetResponse source)

convertRangeBucketsFacetResponse

protected AsFacetData convertRangeBucketsFacetResponse(SnRangeBucketsFacetResponse source)

convertBucketResponse

protected AsFacetValueData convertBucketResponse(AbstractSnBucketResponse source,
                                                 java.util.Set<java.lang.String> selectedBucketIds)

convertNamedSort

protected AsSortData convertNamedSort(SnNamedSort source)

extractPkFromSearchHit

protected PK extractPkFromSearchHit(SnSearchHit searchHit)

getTypeService

public TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

getL10nService

public L10NService getL10nService()

setL10nService

public void setL10nService(L10NService l10nService)

getCommonI18NService

public CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getCatalogVersionService

public CatalogVersionService getCatalogVersionService()

setCatalogVersionService

public void setCatalogVersionService(CatalogVersionService catalogVersionService)

getSnSessionService

public SnSessionService getSnSessionService()

setSnSessionService

public void setSnSessionService(SnSessionService snSessionService)

getSnFieldTypeRegistry

public SnFieldTypeRegistry getSnFieldTypeRegistry()

setSnFieldTypeRegistry

public void setSnFieldTypeRegistry(SnFieldTypeRegistry snFieldTypeRegistry)

getSnIndexConfigurationService

public SnIndexConfigurationService getSnIndexConfigurationService()

setSnIndexConfigurationService

public void setSnIndexConfigurationService(SnIndexConfigurationService snIndexConfigurationService)

getSnIndexTypeService

public SnIndexTypeService getSnIndexTypeService()

setSnIndexTypeService

public void setSnIndexTypeService(SnIndexTypeService snIndexTypeService)

getSnCommonConfigurationService

public SnCommonConfigurationService getSnCommonConfigurationService()

setSnCommonConfigurationService

public void setSnCommonConfigurationService(SnCommonConfigurationService snCommonConfigurationService)

getSnQualifierTypeFactory

public SnQualifierTypeFactory getSnQualifierTypeFactory()

setSnQualifierTypeFactory

public void setSnQualifierTypeFactory(SnQualifierTypeFactory snQualifierTypeFactory)

getSnContextFactory

public SnContextFactory getSnContextFactory()

setSnContextFactory

public void setSnContextFactory(SnContextFactory snContextFactory)

getSnSearchService

public SnSearchService getSnSearchService()

setSnSearchService

public void setSnSearchService(SnSearchService snSearchService)