de.hybris.platform.adaptivesearchsolr.strategies.impl

Class SolrAsSearchProvider

java.lang.Object

de.hybris.platform.adaptivesearchsolr.strategies.impl.SolrAsSearchProvider

All Implemented Interfaces:

AsSearchProvider

public class SolrAsSearchProvider
extends java.lang.Object
implements AsSearchProvider

Default implementation for AsSearchProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ADAPTIVE_SEARCH_CATALOG_VERSIONS
protected static java.lang.String	ADAPTIVE_SEARCH_CATEGORY_PATH
protected static java.lang.String	ADAPTIVE_SEARCH_KEEP_EXCLUDED_VALUES_KEY
protected static java.lang.String	ADAPTIVE_SEARCH_RESULT
protected static java.lang.String	CODE_PARAM
protected static java.lang.String	DEFAULT_QUERY_TEMPLATE
protected static java.lang.String	EXPRESSION_PARAM
protected static java.lang.String	INDEX_CONFIGURATION_PARAM
protected static java.lang.String	INDEX_TYPE_PARAM
protected static java.util.regex.Pattern	VALID_INDEX_PROPERTY_NAME_REGEX_PATTERN

Constructor Summary

Constructors

Constructor and Description
SolrAsSearchProvider()

Method Summary

Modifier and Type	Method and Description
protected int	compareIndexProperties(AsIndexPropertyData indexProperty1, AsIndexPropertyData indexProperty2)
protected int	compareSortExpressions(AsExpressionData expression1, AsExpressionData expression2)
protected <S,T> java.util.List<T>	convertAll(java.util.Collection<? extends S> source, java.util.function.Function<S,T> converter)
protected AsIndexConfigurationData	convertIndexConfiguration(SolrFacetSearchConfigModel solrIndexConfiguration)
protected AsIndexPropertyData	convertIndexProperty(SolrIndexedPropertyModel source)
protected AsIndexTypeData	convertIndexType(SolrIndexedTypeModel source)
protected SearchQuery	convertSearchQuery(AsSearchProfileContext context, AsSearchQueryData searchQuery)
protected AsSearchResultData	convertSearchResult(AsSearchProfileContext context, SearchResult result)
protected AsExpressionData	convertSortExpression(SolrIndexedPropertyModel source)
protected AsDocumentData	createDocumentData(Document document)
protected AsFacetData	createFacetData(Facet facet)
protected AsFacetValueData	createFacetValueData(FacetValue facetValue)
protected AsExpressionData	createScoreSortExpression()
protected AsSortData	createSortData(IndexedTypeSort sort)
protected AsSearchResultData	executeInLocalViewWithLocale(java.util.Locale localeForLanguage, java.util.function.Supplier<AsSearchResultData> action)
CommonI18NService	getCommonI18NService()
FacetSearchConfigService	getFacetSearchConfigService()
FacetSearchService	getFacetSearchService()
I18NService	getI18nService()
java.util.Optional<AsIndexConfigurationData>	getIndexConfigurationForCode(java.lang.String code) 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 indexType) Returns a list of index properties for a given index type.
java.util.Optional<AsIndexPropertyData>	getIndexPropertyForCode(java.lang.String indexType, java.lang.String code) Returns the index property for the provided code.
java.util.Optional<AsIndexTypeData>	getIndexTypeForCode(java.lang.String code) 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 indexConfiguration) Returns a list of index types for a given index configuration.
SessionService	getSessionService()
SolrAsTypeMappingRegistry	getSolrAsTypeMappingRegistry()
SolrFacetSearchConfigDao	getSolrFacetSearchConfigDao()
SolrIndexedPropertyDao	getSolrIndexedPropertyDao()
SolrIndexedPropertyTypeRegistry	getSolrIndexedPropertyTypeRegistry()
SolrIndexedTypeDao	getSolrIndexedTypeDao()
java.util.List<CatalogVersionModel>	getSupportedCatalogVersions(java.lang.String indexConfiguration, java.lang.String indexType) Returns a list of catalog versions for a given index configuration and type.
java.util.List<CurrencyModel>	getSupportedCurrencies(java.lang.String indexConfiguration, java.lang.String indexType) Returns a list of currencies for a given index configuration and type.
java.util.List<AsIndexPropertyData>	getSupportedFacetIndexProperties(java.lang.String indexType) Returns a list of index properties for a given index type that can be used for facets.
java.util.List<LanguageModel>	getSupportedLanguages(java.lang.String indexConfiguration, java.lang.String indexType) Returns a list of languages for a given index configuration and type.
java.util.List<AsExpressionData>	getSupportedSortExpressions(java.lang.String indexType) Returns a list of expressions for a given index type that can be used for sorts.
protected boolean	isValidFacetIndexProperty(SolrIndexedPropertyModel indexProperty)
boolean	isValidFacetIndexProperty(java.lang.String indexType, java.lang.String code) Checks is a given index property can be used for facets.
boolean	isValidSortExpression(java.lang.String indexType, java.lang.String expression) Checks is a given expression can be used for facets.
protected boolean	isValidSortIndexProperty(SolrIndexedPropertyModel indexProperty)
AsSearchResultData	performSearch(AsSearchProfileContext context, AsSearchQueryData searchQuery)
protected IndexedType	resolveIndexedType(FacetSearchConfig facetSearchConfig, java.lang.String identifier)
protected CategoryModel	resolveSelectedCategory(java.util.List<CategoryModel> categoryPath)
AsSearchResultData	search(AsSearchProfileContext context, AsSearchQueryData searchQuery) Performs a search query.
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setFacetSearchConfigService(FacetSearchConfigService facetSearchConfigService)
void	setFacetSearchService(FacetSearchService facetSearchService)
void	setI18nService(I18NService i18nService)
void	setSessionService(SessionService sessionService)
void	setSolrAsTypeMappingRegistry(SolrAsTypeMappingRegistry solrAsTypeMappingRegistry)
void	setSolrFacetSearchConfigDao(SolrFacetSearchConfigDao solrFacetSearchConfigDao)
void	setSolrIndexedPropertyDao(SolrIndexedPropertyDao solrIndexedPropertyDao)
void	setSolrIndexedPropertyTypeRegistry(SolrIndexedPropertyTypeRegistry solrIndexedPropertyTypeRegistry)
void	setSolrIndexedTypeDao(SolrIndexedTypeDao solrIndexedTypeDao)

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_CONFIGURATION_PARAM

protected static final java.lang.String INDEX_CONFIGURATION_PARAM

See Also:

Constant Field Values

INDEX_TYPE_PARAM

protected static final java.lang.String INDEX_TYPE_PARAM

See Also:

Constant Field Values

CODE_PARAM

protected static final java.lang.String CODE_PARAM

See Also:

Constant Field Values

EXPRESSION_PARAM

protected static final java.lang.String EXPRESSION_PARAM

See Also:

Constant Field Values

DEFAULT_QUERY_TEMPLATE

protected static final java.lang.String DEFAULT_QUERY_TEMPLATE

See Also:

Constant Field Values

ADAPTIVE_SEARCH_RESULT

protected static final java.lang.String ADAPTIVE_SEARCH_RESULT

See Also:

Constant Field Values

ADAPTIVE_SEARCH_CATALOG_VERSIONS

protected static final java.lang.String ADAPTIVE_SEARCH_CATALOG_VERSIONS

See Also:

Constant Field Values

ADAPTIVE_SEARCH_CATEGORY_PATH

protected static final java.lang.String ADAPTIVE_SEARCH_CATEGORY_PATH

See Also:

Constant Field Values

ADAPTIVE_SEARCH_KEEP_EXCLUDED_VALUES_KEY

protected static final java.lang.String ADAPTIVE_SEARCH_KEEP_EXCLUDED_VALUES_KEY

See Also:

Constant Field Values

VALID_INDEX_PROPERTY_NAME_REGEX_PATTERN

protected static final java.util.regex.Pattern VALID_INDEX_PROPERTY_NAME_REGEX_PATTERN

Constructor Detail

SolrAsSearchProvider

public SolrAsSearchProvider()

Method Detail

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 code)

Description copied from interface: AsSearchProvider

Returns the index configuration for the provided code.

Specified by:

getIndexConfigurationForCode in interface AsSearchProvider

Parameters:

code - - 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 indexConfiguration)

Description copied from interface: AsSearchProvider

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

Specified by:

getIndexTypes in interface AsSearchProvider

Parameters:

indexConfiguration - - the index configuration code

Returns:

the index types

getIndexTypeForCode

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

Description copied from interface: AsSearchProvider

Returns the index type for the provided code.

Specified by:

getIndexTypeForCode in interface AsSearchProvider

Parameters:

code - - the index type code

Returns:

the index type

getIndexProperties

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

Description copied from interface: AsSearchProvider

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

Specified by:

getIndexProperties in interface AsSearchProvider

Parameters:

indexType - - the index type code

Returns:

the index properties

getIndexPropertyForCode

public java.util.Optional<AsIndexPropertyData> getIndexPropertyForCode(java.lang.String indexType,
                                                                       java.lang.String code)

Description copied from interface: AsSearchProvider

Returns the index property for the provided code.

Specified by:

getIndexPropertyForCode in interface AsSearchProvider

code - - the index property code

Returns:

the index property

getSupportedCatalogVersions

public java.util.List<CatalogVersionModel> getSupportedCatalogVersions(java.lang.String indexConfiguration,
                                                                       java.lang.String indexType)

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:

indexConfiguration - - the index configuration

indexType - - the index type

Returns:

the catalog versions

getSupportedLanguages

public java.util.List<LanguageModel> getSupportedLanguages(java.lang.String indexConfiguration,
                                                           java.lang.String indexType)

Description copied from interface: AsSearchProvider

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

Specified by:

getSupportedLanguages in interface AsSearchProvider

Parameters:

indexConfiguration - - the index configuration

indexType - - the index type

Returns:

the languages

getSupportedCurrencies

public java.util.List<CurrencyModel> getSupportedCurrencies(java.lang.String indexConfiguration,
                                                            java.lang.String indexType)

Description copied from interface: AsSearchProvider

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

Specified by:

getSupportedCurrencies in interface AsSearchProvider

Parameters:

indexConfiguration - - the index configuration

indexType - - the index type

Returns:

the currencies

getSupportedFacetIndexProperties

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

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:

indexType - - the index type code

Returns:

the index properties

isValidFacetIndexProperty

public boolean isValidFacetIndexProperty(java.lang.String indexType,
                                         java.lang.String code)

Description copied from interface: AsSearchProvider

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

Specified by:

isValidFacetIndexProperty in interface AsSearchProvider

Parameters:

indexType - - the index type code

code - - the code of the index property

Returns:

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

isValidFacetIndexProperty

protected boolean isValidFacetIndexProperty(SolrIndexedPropertyModel indexProperty)

getSupportedSortExpressions

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

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:

indexType - - the index type code

Returns:

the expressions

isValidSortExpression

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

Description copied from interface: AsSearchProvider

Checks is a given expression can be used for facets.

Specified by:

isValidSortExpression in interface AsSearchProvider

Parameters:

indexType - - the index type code

expression - - the sort expression

Returns:

true if expression can be used for sorts, false otherwise

isValidSortIndexProperty

protected boolean isValidSortIndexProperty(SolrIndexedPropertyModel indexProperty)

convertIndexConfiguration

protected AsIndexConfigurationData convertIndexConfiguration(SolrFacetSearchConfigModel solrIndexConfiguration)

convertIndexType

protected AsIndexTypeData convertIndexType(SolrIndexedTypeModel source)

convertIndexProperty

protected AsIndexPropertyData convertIndexProperty(SolrIndexedPropertyModel source)

compareIndexProperties

protected int compareIndexProperties(AsIndexPropertyData indexProperty1,
                                     AsIndexPropertyData indexProperty2)

createScoreSortExpression

protected AsExpressionData createScoreSortExpression()

convertSortExpression

protected AsExpressionData convertSortExpression(SolrIndexedPropertyModel source)

compareSortExpressions

protected int compareSortExpressions(AsExpressionData expression1,
                                     AsExpressionData expression2)

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

executeInLocalViewWithLocale

protected AsSearchResultData executeInLocalViewWithLocale(java.util.Locale localeForLanguage,
                                                          java.util.function.Supplier<AsSearchResultData> action)
                                                   throws AsException

Throws:

AsException

performSearch

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

Throws:

AsException

resolveIndexedType

protected IndexedType resolveIndexedType(FacetSearchConfig facetSearchConfig,
                                         java.lang.String identifier)
                                  throws AsException

Throws:

AsException

resolveSelectedCategory

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

convertSearchQuery

protected SearchQuery convertSearchQuery(AsSearchProfileContext context,
                                         AsSearchQueryData searchQuery)
                                  throws FacetConfigServiceException,
                                         AsException

Throws:

FacetConfigServiceException

AsException

convertSearchResult

protected AsSearchResultData convertSearchResult(AsSearchProfileContext context,
                                                 SearchResult result)

createDocumentData

protected AsDocumentData createDocumentData(Document document)

createFacetData

protected AsFacetData createFacetData(Facet facet)

createFacetValueData

protected AsFacetValueData createFacetValueData(FacetValue facetValue)

convertAll

protected <S,T> java.util.List<T> convertAll(java.util.Collection<? extends S> source,
                                             java.util.function.Function<S,T> converter)

createSortData

protected AsSortData createSortData(IndexedTypeSort sort)

getSolrFacetSearchConfigDao

public SolrFacetSearchConfigDao getSolrFacetSearchConfigDao()

setSolrFacetSearchConfigDao

public void setSolrFacetSearchConfigDao(SolrFacetSearchConfigDao solrFacetSearchConfigDao)

getSolrIndexedTypeDao

public SolrIndexedTypeDao getSolrIndexedTypeDao()

setSolrIndexedTypeDao

public void setSolrIndexedTypeDao(SolrIndexedTypeDao solrIndexedTypeDao)

getSolrIndexedPropertyDao

public SolrIndexedPropertyDao getSolrIndexedPropertyDao()

setSolrIndexedPropertyDao

public void setSolrIndexedPropertyDao(SolrIndexedPropertyDao solrIndexedPropertyDao)

getSolrIndexedPropertyTypeRegistry

public SolrIndexedPropertyTypeRegistry getSolrIndexedPropertyTypeRegistry()

setSolrIndexedPropertyTypeRegistry

public void setSolrIndexedPropertyTypeRegistry(SolrIndexedPropertyTypeRegistry solrIndexedPropertyTypeRegistry)

getSolrAsTypeMappingRegistry

public SolrAsTypeMappingRegistry getSolrAsTypeMappingRegistry()

setSolrAsTypeMappingRegistry

public void setSolrAsTypeMappingRegistry(SolrAsTypeMappingRegistry solrAsTypeMappingRegistry)

getFacetSearchService

public FacetSearchService getFacetSearchService()

setFacetSearchService

public void setFacetSearchService(FacetSearchService facetSearchService)

getFacetSearchConfigService

public FacetSearchConfigService getFacetSearchConfigService()

setFacetSearchConfigService

public void setFacetSearchConfigService(FacetSearchConfigService facetSearchConfigService)

getSessionService

public SessionService getSessionService()

setSessionService

public void setSessionService(SessionService sessionService)

getI18nService

public I18NService getI18nService()

setI18nService

public void setI18nService(I18NService i18nService)

getCommonI18NService

public CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)