Package de.hybris.platform.servicelayer.search.impl

Class DefaultFlexibleSearchService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.servicelayer.search.impl.DefaultFlexibleSearchService

All Implemented Interfaces:

FlexibleSearchService, java.io.Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class DefaultFlexibleSearchService
extends AbstractBusinessService
implements FlexibleSearchService

Default implementation of the flexible search service.

Since:

4.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor	Description
DefaultFlexibleSearchService()

Method Summary

Modifier and Type	Method	Description
protected <T> SearchResultImpl<T>	createEmptyResult(SearchResult<T> jaloResult)
ConverterRegistry	getConverterRegistry()
protected FlexibleSearch	getFlexibleSearchInstance()
<T> T	getModelByExample(T example)	Search for an existing object (in the database) by a given (not saved) example.
protected ModelConverter	getModelConverterByModel(java.lang.Object model)
<T> java.util.List<T>	getModelsByExample(T example)	Search for an existing objects (in the database) by a given (not saved) example.
ModelSearchStrategy	getModelSearchStrategy()
QueryPreprocessorRegistry	getQueryPreprocessorRegistry()
protected java.lang.String	getSourceTypeFromModel(java.lang.Object model)
ConverterRegistry	lookupConverterRegistry()	Must be overwritten! Use <lookup-method> in spring.
ModelSearchStrategy	lookupModelSearchStrategy()	Must be overwritten! Use <lookup-method> in spring.
QueryPreprocessorRegistry	lookupQueryPreprocessorRegistry()
<T> void	processSearchRows(FlexibleSearchQuery query, java.util.function.Consumer<T> rowConsumer)	Search.
<T> SearchResult<T>	search(FlexibleSearchQuery query)	Search.
<T> SearchResult<T>	search(java.lang.String query)	Simplest search available.
<T> SearchResult<T>	search(java.lang.String query, java.util.Map<java.lang.String,? extends java.lang.Object> queryParams)	Convenience method which internally delegates to FlexibleSearchService.search(FlexibleSearchQuery).
<T> SearchResult<T>	searchRelation(ItemModel model, java.lang.String attribute, int start, int count)	This method is not implemented.
<T> SearchResult<T>	searchRelation(RelationQuery query)	This method is not implemented.
<T> T	searchUnique(FlexibleSearchQuery searchQuery)	Searches for exactly one model fitting given FlexibleSearchQuery.
void	setModelResolver(ItemObjectResolver modelResolver)
void	setMultiModelResolver(ItemObjectResolver multiModelResolver)
<T> T	toPersistenceLayer(java.lang.Object modelValue)
TranslationResult	translate(FlexibleSearchQuery query)	Translates FlexibleSearchQuery into TranslationResult object which contains translated FlexibleSearchQuery to real SQL query and all parameters which will be used in SQL query.

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, writeReplace

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.servicelayer.search.FlexibleSearchService

processSearchRows

Constructor Detail

DefaultFlexibleSearchService

public DefaultFlexibleSearchService()

Method Detail

getConverterRegistry

public ConverterRegistry getConverterRegistry()

getModelByExample

public <T> T getModelByExample(T example)

Description copied from interface: FlexibleSearchService

Search for an existing object (in the database) by a given (not saved) example. Every modified attribute in this example is used as search parameter.

Specified by:

getModelByExample in interface FlexibleSearchService

Type Parameters:

T - the type of the example and the return type

Parameters:

example - the example

Returns:

the result if this was found by the example.

getModelsByExample

public <T> java.util.List<T> getModelsByExample(T example)

Description copied from interface: FlexibleSearchService

Search for an existing objects (in the database) by a given (not saved) example. Every modified attribute in this example is used as search parameter. Returns all matching results.

Specified by:

getModelsByExample in interface FlexibleSearchService

Type Parameters:

T - the type of the example and the return type

Parameters:

example - the example

Returns:

the list of models found by the example.

getModelSearchStrategy

public ModelSearchStrategy getModelSearchStrategy()

getQueryPreprocessorRegistry

public QueryPreprocessorRegistry getQueryPreprocessorRegistry()

lookupConverterRegistry

public ConverterRegistry lookupConverterRegistry()

Must be overwritten! Use <lookup-method> in spring.

lookupModelSearchStrategy

public ModelSearchStrategy lookupModelSearchStrategy()

Must be overwritten! Use <lookup-method> in spring.

lookupQueryPreprocessorRegistry

public QueryPreprocessorRegistry lookupQueryPreprocessorRegistry()

search

public <T> SearchResult<T> search(FlexibleSearchQuery query)

Search.

Specified by:

search in interface FlexibleSearchService

Parameters:

query - the search query

Returns:

the search result< t>

processSearchRows

public <T> void processSearchRows(FlexibleSearchQuery query,
                                  java.util.function.Consumer<T> rowConsumer)

Description copied from interface: FlexibleSearchService

Search.

Specified by:

processSearchRows in interface FlexibleSearchService

Parameters:

query - the search query

rowConsumer - consumer for rows fetched from DB

createEmptyResult

protected <T> SearchResultImpl<T> createEmptyResult(SearchResult<T> jaloResult)

search

public <T> SearchResult<T> search(java.lang.String query)

Simplest search available.

Specified by:

search in interface FlexibleSearchService

Parameters:

query - the query

Returns:

the search result< t>

search

public <T> SearchResult<T> search(java.lang.String query,
                                  java.util.Map<java.lang.String,? extends java.lang.Object> queryParams)

Convenience method which internally delegates to FlexibleSearchService.search(FlexibleSearchQuery).

Specified by:

search in interface FlexibleSearchService

Parameters:

query - query string in flexible search syntax

queryParams - additional query parameters; null permitted

Returns:

the search result< t>

searchRelation

public <T> SearchResult<T> searchRelation(ItemModel model,
                                          java.lang.String attribute,
                                          int start,
                                          int count)

This method is not implemented.

Specified by:

searchRelation in interface FlexibleSearchService

searchRelation

public <T> SearchResult<T> searchRelation(RelationQuery query)

This method is not implemented.

Specified by:

searchRelation in interface FlexibleSearchService

searchUnique

public <T> T searchUnique(FlexibleSearchQuery searchQuery)

Searches for exactly one model fitting given FlexibleSearchQuery. Throws an exception when more or none results found.

Specified by:

searchUnique in interface FlexibleSearchService

Parameters:

searchQuery - the search query

Returns:

the search result< t>

setModelResolver

public void setModelResolver(ItemObjectResolver modelResolver)

setMultiModelResolver

public void setMultiModelResolver(ItemObjectResolver multiModelResolver)

translate

public TranslationResult translate(FlexibleSearchQuery query)

Translates FlexibleSearchQuery into TranslationResult object which contains translated FlexibleSearchQuery to real SQL query and all parameters which will be used in SQL query.

Translation also respects SearchRestrictionModel based restrictions for types and users.

Specified by:

translate in interface FlexibleSearchService

Parameters:

query - FlexibleSearchQuery to be translated.

Returns:

TranslationResult object containing SQL query with parameters.

getModelConverterByModel

protected ModelConverter getModelConverterByModel(java.lang.Object model)

getSourceTypeFromModel

protected java.lang.String getSourceTypeFromModel(java.lang.Object model)

getFlexibleSearchInstance

protected FlexibleSearch getFlexibleSearchInstance()

toPersistenceLayer

public <T> T toPersistenceLayer(java.lang.Object modelValue)