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

Class AbstractSearchProvider

java.lang.Object

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

de.hybris.platform.cockpit.services.PropertyBasedService

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

All Implemented Interfaces:

SearchProvider

Direct Known Subclasses:

GenericQuerySearchProvider

public abstract class AbstractSearchProvider
extends PropertyBasedService
implements SearchProvider

Base search provider class. Ensures that root types may only be instances of SearchType.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Operator	SIMPLE_OPERATOR

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

modelService, typeService

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

SELECTED_OBJECT_TEMPLATE

Constructor Summary

Constructors

Constructor and Description
AbstractSearchProvider()

Method Summary

Modifier and Type	Method and Description
java.util.Set<Facet>	getAllSupportedFacets() Returns all supported facets.
java.util.Set<Facet>	getAllSupportedFacets(java.util.Collection<SearchType> rootTypes) Returns all supported facets for a given set of root types.
ConditionTranslatorRegistry	getConditionTranslatorRegistry()
abstract FacetsResult	queryFacets(ExtendedSearchResult result, java.util.Set<Facet> facets) Performs a facet query upon a existing search result.
abstract ExtendedSearchResult	search(Query query) Performs a query.
void	setConditionTranslatorRegistry(ConditionTranslatorRegistry conditionTranslatorRegistry)

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, getTypeService, setCockpitTypeService, setLabelResolver, setModelService

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.cockpit.services.search.SearchProvider

getDefaultRootType, setDefaultRootType

Field Detail

SIMPLE_OPERATOR

protected static final Operator SIMPLE_OPERATOR

Constructor Detail

AbstractSearchProvider

public AbstractSearchProvider()

Method Detail

getAllSupportedFacets

public java.util.Set<Facet> getAllSupportedFacets()

Returns all supported facets. This includes facets of root types and of any sub type.

getAllSupportedFacets

public java.util.Set<Facet> getAllSupportedFacets(java.util.Collection<SearchType> rootTypes)

Returns all supported facets for a given set of root types. It returns facets for each root type and their sub types.

search

public abstract ExtendedSearchResult search(Query query)

Performs a query.

Specified by:

search in interface SearchProvider

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.

queryFacets

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

Performs a facet query upon a existing search result.

Parameters:

result - the existing search result

facets - the facets to be queried

setConditionTranslatorRegistry

public void setConditionTranslatorRegistry(ConditionTranslatorRegistry conditionTranslatorRegistry)

getConditionTranslatorRegistry

public ConditionTranslatorRegistry getConditionTranslatorRegistry()