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

Class DefaultPaginatedGenericDao<M extends ItemModel>

java.lang.Object

de.hybris.platform.servicelayer.search.paginated.dao.impl.DefaultPaginatedGenericDao<M>

All Implemented Interfaces:

PaginatedGenericDao<M>

public class DefaultPaginatedGenericDao<M extends ItemModel>
extends java.lang.Object
implements PaginatedGenericDao<M>

Default implementation of PaginatedGenericDao

Constructor Summary

Constructors

Constructor	Description
DefaultPaginatedGenericDao(java.lang.String typeCode)	Sets typeCode where this DefaultPaginatedGenericDao will search from.

Method Summary

Modifier and Type	Method	Description
protected void	appendWhereClausesToBuilder(java.lang.StringBuilder builder, java.util.Map<java.lang.String,?> params)	Appends "WHERE" clause to the given builder with given params if it is not empty, otherwise do nothing
protected FlexibleSearchQuery	createFlexibleSearchQuery(java.util.Map<java.lang.String,?> params)	Creates FlexibleSearchQuery for the typeCode and append "WHERE" clause with params, if given params is not empty.
protected java.lang.StringBuilder	createQueryString()	Creates a search query for the typeCode which is set from constructor
SearchPageData<M>	find(SearchPageData<M> searchPageData)	Search for all instances of model given as a generic type using given sorts in SearchPageData to sort the results and return paginated results by specified pagination in SearchPageData.
SearchPageData<M>	find(java.util.Map<java.lang.String,?> params, SearchPageData searchPageData)	Search for all instances of model given as a generic type matching given FlexibleSearchQuery parameters.
protected PaginatedFlexibleSearchService	getPaginatedFlexibleSearchService()
protected java.util.Map<java.lang.String,java.lang.String>	getSortCodeToQueryAlias(SearchPageData searchPageData)	Creates a map between sortCode to query alias which is required from PaginatedFlexibleSearchService to append "ORDER BY" clause.
void	setPaginatedFlexibleSearchService(PaginatedFlexibleSearchService paginatedFlexibleSearchService)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPaginatedGenericDao

public DefaultPaginatedGenericDao(java.lang.String typeCode)

Sets typeCode where this DefaultPaginatedGenericDao will search from. This constructor is an essential part of this Dao because it creates a query string based on the typeCode.

Parameters:

typeCode - the typeCode where this Dao will search from.

Method Detail

find

public SearchPageData<M> find(SearchPageData<M> searchPageData)

Description copied from interface: PaginatedGenericDao

Search for all instances of model given as a generic type using given sorts in SearchPageData to sort the results and return paginated results by specified pagination in SearchPageData.

Specified by:

find in interface PaginatedGenericDao<M extends ItemModel>

Parameters:

searchPageData - the searchPageData including sorts and pagination information to be applied in the results

Returns:

SearchPageData containing paginated and sorted search results

find

public SearchPageData<M> find(java.util.Map<java.lang.String,?> params,
                              SearchPageData searchPageData)

Description copied from interface: PaginatedGenericDao

Search for all instances of model given as a generic type matching given FlexibleSearchQuery parameters.

Specified by:

find in interface PaginatedGenericDao<M extends ItemModel>

Parameters:

params - parameters to be added in search query's "WHERE" clause as Map with parameter name as a key and parameter value as a value.

searchPageData - the searchPageData including sorts and pagination information to be applied in the results

Returns:

SearchPageData containing paginated and sorted search results

createFlexibleSearchQuery

protected FlexibleSearchQuery createFlexibleSearchQuery(java.util.Map<java.lang.String,?> params)

Creates FlexibleSearchQuery for the typeCode and append "WHERE" clause with params, if given params is not empty.

Parameters:

params - the map containing FlexibleSearchQuery parameters

Returns:

FlexibleSearchQuery with query and queryParameters added if given params is not empty

createQueryString

protected java.lang.StringBuilder createQueryString()

Creates a search query for the typeCode which is set from constructor

Returns:

StringBuilder with basic search query for the typeCode

appendWhereClausesToBuilder

protected void appendWhereClausesToBuilder(java.lang.StringBuilder builder,
                                           java.util.Map<java.lang.String,?> params)

Appends "WHERE" clause to the given builder with given params if it is not empty, otherwise do nothing

Parameters:

builder - the query builder containing "SELECT ... FROM ..." portion of query

params - the map containing FlexibleSearchQuery parameters

getSortCodeToQueryAlias

protected java.util.Map<java.lang.String,java.lang.String> getSortCodeToQueryAlias(SearchPageData searchPageData)

Creates a map between sortCode to query alias which is required from PaginatedFlexibleSearchService to append "ORDER BY" clause. Because DefaultPaginatedGenericDao implementation will query from a single typeCode, all the sortCode will be mapped to the predefined QUERY_ALIAS

While creating sortCodeToQueryAlias map, it uses lower case of sortData's code to meet the expectation of SortDataParsingStrategy

Parameters:

searchPageData - the searchPageData containing requested pagination and sorting information

Returns:

Map<String,String> containing sortCodeToQueryAlias

See Also:

PaginatedFlexibleSearchParameter.sortCodeToQueryAlias, SortDataParsingStrategy

getPaginatedFlexibleSearchService

protected PaginatedFlexibleSearchService getPaginatedFlexibleSearchService()

setPaginatedFlexibleSearchService

public void setPaginatedFlexibleSearchService(PaginatedFlexibleSearchService paginatedFlexibleSearchService)