de.hybris.platform.cockpit.services.search.impl

Class GenericQuerySearchProvider

java.lang.Object

de.hybris.platform.cockpit.services.impl.AbstractServiceImpl

de.hybris.platform.cockpit.services.PropertyBasedService

de.hybris.platform.cockpit.services.search.impl.AbstractSearchProvider

de.hybris.platform.cockpit.services.search.impl.GenericQuerySearchProvider

All Implemented Interfaces:

SearchProvider

Direct Known Subclasses:

ProductPerspectiveQueryProvider

public class GenericQuerySearchProvider
extends AbstractSearchProvider

Search provider based upon GenericSearchParameterDescriptor. It uses generic query when searching for item data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GenericQuerySearchProvider.GenericConditionTranslatorContext

Field Summary

Fields inherited from class de.hybris.platform.cockpit.services.search.impl.AbstractSearchProvider

SIMPLE_OPERATOR

Fields inherited from interface de.hybris.platform.cockpit.services.search.SearchProvider

SELECTED_OBJECT_TEMPLATE

Constructor Summary

Constructors

Constructor and Description
GenericQuerySearchProvider()

Method Summary

Modifier and Type	Method and Description
protected void	addCondition(GenericCondition condition, java.util.List<GenericCondition> conditions)
protected void	afterSearch()
protected void	beforeSearch()
protected GenericCondition	createAdvancedSearchCondition(Query query, GenericQuery genQuery)
protected void	createAndAddCondition(SearchParameterValue searchParameterValue, java.util.List<GenericCondition> searchConditions, GenericQuerySearchProvider.GenericConditionTranslatorContext context)
protected GenericCondition	createBlacklistCondition(Query query, GenericQuery genQuery)
java.util.List<GenericCondition>	createConditions(Query query, GenericQuery genQuery) Creates the search conditions to be used when searching.
protected GenericCondition	createExcludeItemsCondition(java.util.Collection<TypedObject> excludeItems)
protected GenericCondition	createObjectTemplateCondition(Query query)
protected GenericSearchOrderBy	createOrderBy(Query query)
protected GenericCondition	createSimpleSearchCondition(Query query, GenericQuery genericQuery)
protected ComposedType	extractRootType(java.util.Collection<GenericSearchParameterDescriptor> activeParameters) Deprecated. since 6.3, use extractRootTypeModel(Collection)
protected ComposedTypeModel	extractRootTypeModel(java.util.Collection<GenericSearchParameterDescriptor> activeParameters)
protected java.lang.String	getCollectionsPKList(java.util.List<ObjectCollection> collections)
protected CommonI18NService	getCommonI18NService()
SearchType	getDefaultRootType() Gets the default root type - search result will contain items of this type.
protected FlexibleSearchService	getFlexibleSearchService()
protected GenericSearchService	getGenericSearchService()
ObjectCollectionService	getObjectCollectionService()
protected java.util.Set<ComposedTypeModel>	getPermittedTypes(ComposedTypeModel rootType, java.util.Set<SearchType> types, boolean exludeSubTypes)
protected java.util.Set<ComposedType>	getPermittedTypes(ComposedType rootType, java.util.Set<SearchType> types, boolean exludeSubTypes) Deprecated. since 6.3, use getPermittedTypes(ComposedTypeModel, Set, boolean)
protected java.util.Set<ObjectTemplate>	getSelectedTemplates(Query query)
protected Operator	getSimpleOperator()
protected TypeService	getSlayerTypeService()
TypeService	getTypeService()
protected boolean	isEmpty_(GenericSearchParameterDescriptor descriptor, java.lang.Object value)
protected BaseType	matchObjectType(Item result) Deprecated. since 6.3, use matchObjectType(ItemModel)
protected BaseType	matchObjectType(ItemModel result)
protected java.util.Set<ItemTemplate>	matchTemplates(java.util.Set<ObjectTemplate> templates)
protected ExtendedSearchResult	performQuery(Query query, GenericQuery genQuery)
FacetsResult	queryFacets(ExtendedSearchResult result, java.util.Set<Facet> facets) Performs a facet query upon a existing search result.
ExtendedSearchResult	search(Query query) Performs a query.
void	setCockpitTypeService(TypeService typeService)
void	setDefaultRootType(SearchType defaultRootType) Sets the default root type.
void	setModelService(ModelService modelService)
protected java.util.List<ResultObject>	wrapModelResults(java.util.List<java.lang.Object> rawList)
protected java.util.List<ResultObject>	wrapResults(java.util.List<java.lang.Object> rawList) Deprecated. since 6.3, use wrapModelResults(List) instead

Methods inherited from class de.hybris.platform.cockpit.services.search.impl.AbstractSearchProvider

getAllSupportedFacets, getAllSupportedFacets, getConditionTranslatorRegistry, setConditionTranslatorRegistry

Methods inherited from class de.hybris.platform.cockpit.services.PropertyBasedService

getAllSupportedPropertyDescriptors

Methods inherited from class de.hybris.platform.cockpit.services.impl.AbstractServiceImpl

getEnum, getEnums, getLocalizedLabel, getLocalizedLabel, getModelService, setLabelResolver

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericQuerySearchProvider

public GenericQuerySearchProvider()

Method Detail

getDefaultRootType

public SearchType getDefaultRootType()

Description copied from interface: SearchProvider

Gets the default root type - search result will contain items of this type.

Returns:

the default root type of the provider

setDefaultRootType

public void setDefaultRootType(SearchType defaultRootType)

Description copied from interface: SearchProvider

Sets the default root type. We will expect items of this type in the search result.

Parameters:

defaultRootType - the new default root type

getTypeService

public TypeService getTypeService()

Overrides:

getTypeService in class AbstractServiceImpl

setCockpitTypeService

public void setCockpitTypeService(TypeService typeService)

Overrides:

setCockpitTypeService in class AbstractServiceImpl

getSlayerTypeService

protected TypeService getSlayerTypeService()

matchObjectType

@Deprecated
protected BaseType matchObjectType(Item result)

Deprecated. since 6.3, use matchObjectType(ItemModel)

matchObjectType

protected BaseType matchObjectType(ItemModel result)

getPermittedTypes

@Deprecated
protected java.util.Set<ComposedType> getPermittedTypes(ComposedType rootType,
                                                                    java.util.Set<SearchType> types,
                                                                    boolean exludeSubTypes)

Deprecated. since 6.3, use getPermittedTypes(ComposedTypeModel, Set, boolean)

getPermittedTypes

protected java.util.Set<ComposedTypeModel> getPermittedTypes(ComposedTypeModel rootType,
                                                             java.util.Set<SearchType> types,
                                                             boolean exludeSubTypes)

extractRootType

@Deprecated
protected ComposedType extractRootType(java.util.Collection<GenericSearchParameterDescriptor> activeParameters)

Deprecated. since 6.3, use extractRootTypeModel(Collection)

extractRootTypeModel

protected ComposedTypeModel extractRootTypeModel(java.util.Collection<GenericSearchParameterDescriptor> activeParameters)

performQuery

protected ExtendedSearchResult performQuery(Query query,
                                            GenericQuery genQuery)

wrapResults

@Deprecated
protected java.util.List<ResultObject> wrapResults(java.util.List<java.lang.Object> rawList)

Deprecated. since 6.3, use wrapModelResults(List) instead

wrapModelResults

protected java.util.List<ResultObject> wrapModelResults(java.util.List<java.lang.Object> rawList)

search

public ExtendedSearchResult search(Query query)

Description copied from class: AbstractSearchProvider

Performs a query.

Specified by:

search in interface SearchProvider

Specified by:

search in class AbstractSearchProvider

Parameters:

query - the query containing all values and settings

Returns:

the extended search result which is a simple POJO that contains result set and some additional information.

beforeSearch

protected void beforeSearch()

afterSearch

protected void afterSearch()

getCollectionsPKList

protected java.lang.String getCollectionsPKList(java.util.List<ObjectCollection> collections)

createConditions

public java.util.List<GenericCondition> createConditions(Query query,
                                                         GenericQuery genQuery)

Creates the search conditions to be used when searching.

The default implementation of this method calls the following methods in order to create the search conditions:

• createSimpleSearchCondition(Query, GenericQuery)
• createExcludeItemsCondition(Collection)
• createObjectTemplateCondition(Query)
• createAdvancedSearchCondition(Query, GenericQuery)

Note: This method might change the parameter genQuery

Parameters:

query - the query

genQuery - the generic query

Returns:

the search conditions to be used when searching

addCondition

protected void addCondition(GenericCondition condition,
                            java.util.List<GenericCondition> conditions)

createOrderBy

protected GenericSearchOrderBy createOrderBy(Query query)

createAndAddCondition

protected void createAndAddCondition(SearchParameterValue searchParameterValue,
                                     java.util.List<GenericCondition> searchConditions,
                                     GenericQuerySearchProvider.GenericConditionTranslatorContext context)

createAdvancedSearchCondition

protected GenericCondition createAdvancedSearchCondition(Query query,
                                                         GenericQuery genQuery)

createExcludeItemsCondition

protected GenericCondition createExcludeItemsCondition(java.util.Collection<TypedObject> excludeItems)

createSimpleSearchCondition

protected GenericCondition createSimpleSearchCondition(Query query,
                                                       GenericQuery genericQuery)

getSimpleOperator

protected Operator getSimpleOperator()

createObjectTemplateCondition

protected GenericCondition createObjectTemplateCondition(Query query)

createBlacklistCondition

protected GenericCondition createBlacklistCondition(Query query,
                                                    GenericQuery genQuery)

getSelectedTemplates

protected java.util.Set<ObjectTemplate> getSelectedTemplates(Query query)

matchTemplates

protected java.util.Set<ItemTemplate> matchTemplates(java.util.Set<ObjectTemplate> templates)

isEmpty_

protected boolean isEmpty_(GenericSearchParameterDescriptor descriptor,
                           java.lang.Object value)

queryFacets

public FacetsResult queryFacets(ExtendedSearchResult result,
                                java.util.Set<Facet> facets)

Description copied from class: AbstractSearchProvider

Performs a facet query upon a existing search result.

Specified by:

queryFacets in class AbstractSearchProvider

Parameters:

result - the existing search result

facets - the facets to be queried

getObjectCollectionService

public ObjectCollectionService getObjectCollectionService()

setModelService

public void setModelService(ModelService modelService)

Overrides:

setModelService in class AbstractServiceImpl

getFlexibleSearchService

protected FlexibleSearchService getFlexibleSearchService()

getGenericSearchService

protected GenericSearchService getGenericSearchService()

getCommonI18NService

protected CommonI18NService getCommonI18NService()