Package de.hybris.platform.commerceservices.storefinder.impl

Class DefaultStoreFinderService<ITEM extends PointOfServiceDistanceData>

java.lang.Object

de.hybris.platform.commerceservices.storefinder.impl.DefaultStoreFinderService<ITEM>

Type Parameters:

ITEM - distance to point of service

All Implemented Interfaces:

StoreFinderService<ITEM,StoreFinderSearchPageData<ITEM>>

public class DefaultStoreFinderService<ITEM extends PointOfServiceDistanceData>
extends java.lang.Object
implements StoreFinderService<ITEM,StoreFinderSearchPageData<ITEM>>

Default implementation of StoreFinderService

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultStoreFinderService.Boundary<T>
static class	DefaultStoreFinderService.StoreFinderResultDataComparator

Constructor Summary

Constructors

Constructor	Description
DefaultStoreFinderService()

Method Summary

Modifier and Type	Method	Description
protected DefaultStoreFinderService.Boundary<GeoPoint>	calculateBounds(java.util.List<ITEM> results, GeoPoint centerPoint)
protected double	calculateDistance(GeoPoint centerPoint, PointOfServiceModel posModel)
protected java.util.List<ITEM>	calculateDistances(GeoPoint centerPoint, java.util.Collection<PointOfServiceModel> pointsOfService)
protected PaginationData	createPagination(PageableData pageableData, long totalNumberOfResults)
protected PaginationData	createPaginationData()
protected StoreFinderSearchPageData<ITEM>	createSearchResult(java.lang.String locationText, GeoPoint centerPoint, java.util.List<ITEM> results, PaginationData paginationData)
protected ITEM	createStoreFinderResultData()
protected StoreFinderSearchPageData<ITEM>	createStoreFinderSearchPageData()
protected StoreFinderSearchPageData<ITEM>	doSearch(BaseStoreModel baseStore, java.lang.String locationText, GeoPoint centerPoint, PageableData pageableData, java.lang.Double maxRadiusKm)
protected AddressData	generateGeoAddressForSearchQuery(BaseStoreModel baseStore, java.lang.String locationText)	This method generates an AddressData object based on a search location text.
StoreFinderSearchPageData<ITEM>	getAllPos(BaseStoreModel baseStore, PageableData pageableData)	Gets the locations retrieved basing on the given arguments.
java.util.List<PointOfServiceModel>	getAllPosForCountry(java.lang.String countryIsoCode, BaseStoreModel baseStore)	Gets a list of PointOfServiceModel for all points of service in a given country
java.util.List<PointOfServiceModel>	getAllPosForRegion(java.lang.String countryIsoCode, java.lang.String regionIsoCode, BaseStoreModel baseStore)	Gets a list of PointOfServiceModel for all points of service in a given country and region
protected GeoWebServiceWrapper	getGeoWebServiceWrapper()
protected PointOfServiceDao	getPointOfServiceDao()
ITEM	getPointOfServiceDistanceForName(BaseStoreModel baseStore, java.lang.String name, GeoPoint geoPoint)	Gets the location for the given name that should be unique.
PointOfServiceModel	getPointOfServiceForName(BaseStoreModel baseStore, java.lang.String name)	Gets the PointOfServiceModel for the given name that should be unique
protected GenericDao<PointOfServiceModel>	getPointOfServiceGenericDao()
protected PagedGenericDao<PointOfServiceModel>	getPointOfServicePagedGenericDao()
protected java.util.Collection<PointOfServiceModel>	getPointsOfServiceNear(GeoPoint centerPoint, double radiusKm, BaseStoreModel baseStore)
StoreFinderSearchPageData<ITEM>	locationSearch(BaseStoreModel baseStore, java.lang.String locationText, PageableData pageableData)	Gets the locations retrieved based on the given arguments.
StoreFinderSearchPageData<ITEM>	locationSearch(BaseStoreModel baseStore, java.lang.String locationText, PageableData pageableData, double maxRadiusKm)	Gets the locations retrieved based on the given arguments.
StoreFinderSearchPageData<ITEM>	positionSearch(BaseStoreModel baseStore, GeoPoint geoPoint, PageableData pageableData)	Gets the locations retrieved basing on the given arguments.
StoreFinderSearchPageData<ITEM>	positionSearch(BaseStoreModel baseStore, GeoPoint geoPoint, PageableData pageableData, double maxRadius)	Gets the locations retrieved basing on the given arguments.
protected DefaultStoreFinderService.Boundary<java.lang.Double>	recalculateSpanAgainstCenter(double leftBorder, double rightBorder, double centerPosition)
void	setGeoWebServiceWrapper(GeoWebServiceWrapper geoWebServiceWrapper)
void	setPointOfServiceDao(PointOfServiceDao pointOfServiceDao)
void	setPointOfServiceGenericDao(GenericDao<PointOfServiceModel> pointOfServiceGenericDao)
void	setPointOfServicePagedGenericDao(PagedGenericDao<PointOfServiceModel> pointOfServicePagedGenericDao)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultStoreFinderService

public DefaultStoreFinderService()

Method Detail

getPointOfServiceGenericDao

protected GenericDao<PointOfServiceModel> getPointOfServiceGenericDao()

setPointOfServiceGenericDao

public void setPointOfServiceGenericDao(GenericDao<PointOfServiceModel> pointOfServiceGenericDao)

getPointOfServiceDao

protected PointOfServiceDao getPointOfServiceDao()

setPointOfServiceDao

public void setPointOfServiceDao(PointOfServiceDao pointOfServiceDao)

getGeoWebServiceWrapper

protected GeoWebServiceWrapper getGeoWebServiceWrapper()

setGeoWebServiceWrapper

public void setGeoWebServiceWrapper(GeoWebServiceWrapper geoWebServiceWrapper)

getPointOfServicePagedGenericDao

protected PagedGenericDao<PointOfServiceModel> getPointOfServicePagedGenericDao()

setPointOfServicePagedGenericDao

public void setPointOfServicePagedGenericDao(PagedGenericDao<PointOfServiceModel> pointOfServicePagedGenericDao)

locationSearch

public StoreFinderSearchPageData<ITEM> locationSearch(BaseStoreModel baseStore,
                                                      java.lang.String locationText,
                                                      PageableData pageableData)

Description copied from interface: StoreFinderService

Gets the locations retrieved based on the given arguments.

Specified by:

locationSearch in interface StoreFinderService<ITEM extends PointOfServiceDistanceData,StoreFinderSearchPageData<ITEM extends PointOfServiceDistanceData>>

Parameters:

baseStore - BaseStoreModel instance that returned locations belongs to

locationText - text that will be used for locations search

pageableData - PageableData object that contains basing information for search result set

Returns:

locations found for the given parameters

locationSearch

public StoreFinderSearchPageData<ITEM> locationSearch(BaseStoreModel baseStore,
                                                      java.lang.String locationText,
                                                      PageableData pageableData,
                                                      double maxRadiusKm)

Description copied from interface: StoreFinderService

Gets the locations retrieved based on the given arguments.

Specified by:

locationSearch in interface StoreFinderService<ITEM extends PointOfServiceDistanceData,StoreFinderSearchPageData<ITEM extends PointOfServiceDistanceData>>

Parameters:

baseStore - BaseStoreModel instance that returned locations belongs to

locationText - text that will be used for locations search

pageableData - PageableData object that contains basing information for search result set

maxRadiusKm - the maximum radius from the location that results should be returned for.

Returns:

locations found for the given parameters

positionSearch

public StoreFinderSearchPageData<ITEM> positionSearch(BaseStoreModel baseStore,
                                                      GeoPoint geoPoint,
                                                      PageableData pageableData)

Description copied from interface: StoreFinderService

Gets the locations retrieved basing on the given arguments.

Specified by:

positionSearch in interface StoreFinderService<ITEM extends PointOfServiceDistanceData,StoreFinderSearchPageData<ITEM extends PointOfServiceDistanceData>>

Parameters:

baseStore - BaseStoreModel instance that returned locations belongs to

geoPoint - geographical point that search is performed for

pageableData - PageableData object that contains basing information for search result set

Returns:

locations found for the given parameters

positionSearch

public StoreFinderSearchPageData<ITEM> positionSearch(BaseStoreModel baseStore,
                                                      GeoPoint geoPoint,
                                                      PageableData pageableData,
                                                      double maxRadius)

Description copied from interface: StoreFinderService

Gets the locations retrieved basing on the given arguments.

Specified by:

positionSearch in interface StoreFinderService<ITEM extends PointOfServiceDistanceData,StoreFinderSearchPageData<ITEM extends PointOfServiceDistanceData>>

Parameters:

baseStore - BaseStoreModel instance that returned locations belongs to

geoPoint - geographical point that search is performed for

pageableData - PageableData object that contains basing information for search result set

maxRadius - the maximum radius from the location that results should be returned for.

Returns:

locations found for the given parameters

getPointOfServiceForName

public PointOfServiceModel getPointOfServiceForName(BaseStoreModel baseStore,
                                                    java.lang.String name)

Description copied from interface: StoreFinderService

Gets the PointOfServiceModel for the given name that should be unique

Specified by:

getPointOfServiceForName in interface StoreFinderService<ITEM extends PointOfServiceDistanceData,StoreFinderSearchPageData<ITEM extends PointOfServiceDistanceData>>

Parameters:

baseStore - BaseStoreModel instance that returned location belongs to

name - the requested point of service name

Returns:

PointOfServiceModel for the given parameter

getPointOfServiceDistanceForName

public ITEM getPointOfServiceDistanceForName(BaseStoreModel baseStore,
                                             java.lang.String name,
                                             GeoPoint geoPoint)

Description copied from interface: StoreFinderService

Gets the location for the given name that should be unique. Additionally the distance between the location and given coordinates is calculated.

Specified by:

getPointOfServiceDistanceForName in interface StoreFinderService<ITEM extends PointOfServiceDistanceData,StoreFinderSearchPageData<ITEM extends PointOfServiceDistanceData>>

Parameters:

baseStore - BaseStoreModel instance that returned location belongs to

name - name of the requested point of service

geoPoint - geographical point of the origin point

Returns:

location for the given parameter

getAllPos

public StoreFinderSearchPageData<ITEM> getAllPos(BaseStoreModel baseStore,
                                                 PageableData pageableData)

Description copied from interface: StoreFinderService

Gets the locations retrieved basing on the given arguments.

Specified by:

getAllPos in interface StoreFinderService<ITEM extends PointOfServiceDistanceData,StoreFinderSearchPageData<ITEM extends PointOfServiceDistanceData>>

Parameters:

baseStore - BaseStoreModel instance that returned locations belongs to

pageableData - PageableData object that contains basing information for search result set

Returns:

locations found for the given parameters

getAllPosForCountry

public java.util.List<PointOfServiceModel> getAllPosForCountry(java.lang.String countryIsoCode,
                                                               BaseStoreModel baseStore)

Description copied from interface: StoreFinderService

Gets a list of PointOfServiceModel for all points of service in a given country

Specified by:

getAllPosForCountry in interface StoreFinderService<ITEM extends PointOfServiceDistanceData,StoreFinderSearchPageData<ITEM extends PointOfServiceDistanceData>>

Parameters:

countryIsoCode - {@link CountryModel:ISOCODE}

baseStore - the active BaseStoreModel

Returns:

list of PointOfServiceModel

getAllPosForRegion

public java.util.List<PointOfServiceModel> getAllPosForRegion(java.lang.String countryIsoCode,
                                                              java.lang.String regionIsoCode,
                                                              BaseStoreModel baseStore)

Description copied from interface: StoreFinderService

Gets a list of PointOfServiceModel for all points of service in a given country and region

Specified by:

getAllPosForRegion in interface StoreFinderService<ITEM extends PointOfServiceDistanceData,StoreFinderSearchPageData<ITEM extends PointOfServiceDistanceData>>

Parameters:

countryIsoCode - {@link CountryModel:ISOCODE}

regionIsoCode - {@link RegionModel:ISOCODE}

baseStore - the active BaseStoreModel

Returns:

list of PointOfServiceModel

generateGeoAddressForSearchQuery

protected AddressData generateGeoAddressForSearchQuery(BaseStoreModel baseStore,
                                                       java.lang.String locationText)

This method generates an AddressData object based on a search location text. It sets country to the AddressData object from the first POS country in the list of base store POS. Adding the country to the AddressData object will help to narrow the search region. It must be noted however that the country is only set if the search text does not contains any comma separators whose presence indicates that the user is attempting to enter multiple fields, post code, country, etc in an attempt to narrow the search area.

Parameters:

baseStore - - the base store for the current site.

locationText - - the search location text to base the search upon.

Returns:

an AddressData object.

doSearch

protected StoreFinderSearchPageData<ITEM> doSearch(BaseStoreModel baseStore,
                                                   java.lang.String locationText,
                                                   GeoPoint centerPoint,
                                                   PageableData pageableData,
                                                   java.lang.Double maxRadiusKm)

createPagination

protected PaginationData createPagination(PageableData pageableData,
                                          long totalNumberOfResults)

createSearchResult

protected StoreFinderSearchPageData<ITEM> createSearchResult(java.lang.String locationText,
                                                             GeoPoint centerPoint,
                                                             java.util.List<ITEM> results,
                                                             PaginationData paginationData)

calculateBounds

protected DefaultStoreFinderService.Boundary<GeoPoint> calculateBounds(java.util.List<ITEM> results,
                                                                       GeoPoint centerPoint)

recalculateSpanAgainstCenter

protected DefaultStoreFinderService.Boundary<java.lang.Double> recalculateSpanAgainstCenter(double leftBorder,
                                                                                            double rightBorder,
                                                                                            double centerPosition)
                                                                                     throws GeoLocatorException

Throws:

GeoLocatorException

getPointsOfServiceNear

protected java.util.Collection<PointOfServiceModel> getPointsOfServiceNear(GeoPoint centerPoint,
                                                                           double radiusKm,
                                                                           BaseStoreModel baseStore)
                                                                    throws PointOfServiceDaoException

Throws:

PointOfServiceDaoException

calculateDistances

protected java.util.List<ITEM> calculateDistances(GeoPoint centerPoint,
                                                  java.util.Collection<PointOfServiceModel> pointsOfService)

calculateDistance

protected double calculateDistance(GeoPoint centerPoint,
                                   PointOfServiceModel posModel)
                            throws GeoLocatorException,
                                   LocationServiceException

Throws:

GeoLocatorException

LocationServiceException

createStoreFinderSearchPageData

protected StoreFinderSearchPageData<ITEM> createStoreFinderSearchPageData()

createStoreFinderResultData

protected ITEM createStoreFinderResultData()

createPaginationData

protected PaginationData createPaginationData()