de.hybris.platform.cms2.cmsitems.service.impl

Class DefaultFlexibleCMSItemSearchService

java.lang.Object

de.hybris.platform.cms2.cmsitems.service.impl.DefaultFlexibleCMSItemSearchService

All Implemented Interfaces:

CMSItemSearchService

public class DefaultFlexibleCMSItemSearchService
extends java.lang.Object
implements CMSItemSearchService

The DefaultFlexibleCMSItemSearchService is a CMSItemSearchService implementation that performs partial matching of the mask param on both UID and NAME fields, and exact matching on type and additional parameter fields

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CATALOG_VERSION_QUERY_PARAM
static java.lang.String	COLON
static java.lang.String	COMMA
static java.lang.String	EXCLUDED_TYPES_QUERY_PARAM
static java.lang.String	ITEM_SEARCH_PARAM_CHECK
static java.lang.String	MASK_CHECK
static java.lang.String	MASK_QUERY_PARAM
static java.lang.String	ORDER_BY
static java.lang.String	QUERY

Constructor Summary

Constructors

Constructor and Description
DefaultFlexibleCMSItemSearchService()

Method Summary

Modifier and Type	Method and Description
protected void	appendItemSearchParams(CMSItemSearchData cmsItemSearchData, java.lang.StringBuilder queryBuilder, java.util.Map<java.lang.String,java.lang.Object> queryParameters) Append the item search data to the query builder
protected void	appendSort(java.lang.String sortNameAndDirection, java.lang.StringBuilder queryBuilder, java.lang.String typeCode) Append the ORDER BY clause to the query builder
protected void	appendTypeExclusions(java.lang.String typeCode, java.lang.StringBuilder queryBuilder, java.util.Map<java.lang.String,java.lang.Object> queryParameters) Append the type codes to be excluded from the query to the query builder
protected java.lang.String	buildSortStatement(java.lang.String typeCode, Sort sort) Create the String representation of the sort parameter and direction by formatting the sort parameter by applying the syntax required by the Flexible Search query.
protected java.util.List<Sort>	convertSort(java.lang.String sort) Converts the String sort param into a list of Sort objects.
protected Sort	convertSortBlock(java.lang.String sortBlock) Convert a sort block, i.e.
SearchResult<CMSItemModel>	findCMSItems(CMSItemSearchData cmsItemSearchData, PageableData pageableData) Paged Search for CMSItems
protected CatalogVersionService	getCatalogVersionService()
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getCmsItemSearchTypeBlacklistMap()
protected SortStatementFormatter	getDefaultSortStatementFormatter()
protected FlexibleSearchAttributeValueConverter	getFlexibleSearchAttributeValueConverter()
protected FlexibleSearchService	getFlexibleSearchService()
protected java.util.List<SortStatementFormatter>	getSortStatementFormatters()
protected TypeService	getTypeService()
void	setCatalogVersionService(CatalogVersionService catalogVersionService)
void	setCmsItemSearchTypeBlacklistMap(java.util.Map<java.lang.String,java.util.List<java.lang.String>> cmsItemSearchTypeBlacklistMap)
void	setDefaultSortStatementFormatter(SortStatementFormatter defaultSortStatementFormatter)
void	setFlexibleSearchAttributeValueConverter(FlexibleSearchAttributeValueConverter flexibleSearchAttributeValueConverter)
void	setFlexibleSearchService(FlexibleSearchService flexibleSearchService)
void	setSortStatementFormatters(java.util.List<SortStatementFormatter> sortStatementFormatters)
void	setTypeService(TypeService typeService)

Methods inherited from class java.lang.Object

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

Field Detail

QUERY

public static final java.lang.String QUERY

See Also:

Constant Field Values

MASK_CHECK

public static final java.lang.String MASK_CHECK

See Also:

Constant Field Values

ITEM_SEARCH_PARAM_CHECK

public static final java.lang.String ITEM_SEARCH_PARAM_CHECK

See Also:

Constant Field Values

CATALOG_VERSION_QUERY_PARAM

public static final java.lang.String CATALOG_VERSION_QUERY_PARAM

See Also:

Constant Field Values

MASK_QUERY_PARAM

public static final java.lang.String MASK_QUERY_PARAM

See Also:

Constant Field Values

EXCLUDED_TYPES_QUERY_PARAM

public static final java.lang.String EXCLUDED_TYPES_QUERY_PARAM

See Also:

Constant Field Values

ORDER_BY

public static final java.lang.String ORDER_BY

See Also:

Constant Field Values

COLON

public static final java.lang.String COLON

See Also:

Constant Field Values

COMMA

public static final java.lang.String COMMA

See Also:

Constant Field Values

Constructor Detail

DefaultFlexibleCMSItemSearchService

public DefaultFlexibleCMSItemSearchService()

Method Detail

findCMSItems

public SearchResult<CMSItemModel> findCMSItems(CMSItemSearchData cmsItemSearchData,
                                               PageableData pageableData)

Description copied from interface: CMSItemSearchService

Paged Search for CMSItems

Specified by:

findCMSItems in interface CMSItemSearchService

Parameters:

cmsItemSearchData - All the required and optional search params, excluding paging

pageableData - Paging search params

Returns:

The search results and paging information

appendTypeExclusions

protected void appendTypeExclusions(java.lang.String typeCode,
                                    java.lang.StringBuilder queryBuilder,
                                    java.util.Map<java.lang.String,java.lang.Object> queryParameters)

Append the type codes to be excluded from the query to the query builder

Parameters:

typeCode - the typeCode which may have a list of blacklisted types defined

queryBuilder - the query builder for the query statement

queryParameters - map of key-value pairs of query parameter fields and Object values

appendItemSearchParams

protected void appendItemSearchParams(CMSItemSearchData cmsItemSearchData,
                                      java.lang.StringBuilder queryBuilder,
                                      java.util.Map<java.lang.String,java.lang.Object> queryParameters)

Append the item search data to the query builder

Parameters:

cmsItemSearchData - all the required and optional search params, excluding paging information

queryBuilder - the query builder for the query statement

queryParameters - map of key-value pairs of query parameter fields and Object values

appendSort

protected void appendSort(java.lang.String sortNameAndDirection,
                          java.lang.StringBuilder queryBuilder,
                          java.lang.String typeCode)

Append the ORDER BY clause to the query builder

Parameters:

sortNameAndDirection - string containing the field name to be sorted and the sort order

queryBuilder - the query builder for the query statement

buildSortStatement

protected java.lang.String buildSortStatement(java.lang.String typeCode,
                                              Sort sort)

Create the String representation of the sort parameter and direction by formatting the sort parameter by applying the syntax required by the Flexible Search query. This uses a custom SortStatementFormatter to format the sort parameter value if applicable, otherwise the default formatter is used instead.

Parameters:

typeCode - the typecode/itemtype value of the cms items to be retrieved

sort - the Sort object containing the parameter to be sorted and the sort direction

Returns:

the String representation of the formatted sort parameter and direction

convertSort

protected java.util.List<Sort> convertSort(java.lang.String sort)

Converts the String sort param into a list of Sort objects. The input, if not empty, should be already validated with the following format: {param}:{direction} Multiple sort parameters are allowed if the blocks are separated by comma.

Parameters:

sort - - the sort parameter received from the request

Returns:

a list of Sort objects

convertSortBlock

protected Sort convertSortBlock(java.lang.String sortBlock)

Convert a sort block, i.e. {param}:{direction} into a Sort object. When a sort direction is invalid or is not provided, the sort direction is defaulted to SortDirection.ASC.

Parameters:

sortBlock - a colon delimited String containing the sort field name and sorting direction

Returns:

a Sort object

getCatalogVersionService

protected CatalogVersionService getCatalogVersionService()

setCatalogVersionService

public void setCatalogVersionService(CatalogVersionService catalogVersionService)

getFlexibleSearchService

protected FlexibleSearchService getFlexibleSearchService()

setFlexibleSearchService

public void setFlexibleSearchService(FlexibleSearchService flexibleSearchService)

getFlexibleSearchAttributeValueConverter

protected FlexibleSearchAttributeValueConverter getFlexibleSearchAttributeValueConverter()

setFlexibleSearchAttributeValueConverter

public void setFlexibleSearchAttributeValueConverter(FlexibleSearchAttributeValueConverter flexibleSearchAttributeValueConverter)

getTypeService

protected TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

getSortStatementFormatters

protected java.util.List<SortStatementFormatter> getSortStatementFormatters()

setSortStatementFormatters

public void setSortStatementFormatters(java.util.List<SortStatementFormatter> sortStatementFormatters)

getDefaultSortStatementFormatter

protected SortStatementFormatter getDefaultSortStatementFormatter()

setDefaultSortStatementFormatter

public void setDefaultSortStatementFormatter(SortStatementFormatter defaultSortStatementFormatter)

getCmsItemSearchTypeBlacklistMap

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> getCmsItemSearchTypeBlacklistMap()

setCmsItemSearchTypeBlacklistMap

public void setCmsItemSearchTypeBlacklistMap(java.util.Map<java.lang.String,java.util.List<java.lang.String>> cmsItemSearchTypeBlacklistMap)