de.hybris.platform.storelocator.location.impl

Class DefaultLocationMapService

java.lang.Object

de.hybris.platform.storelocator.location.impl.DefaultLocationMapService

All Implemented Interfaces:

LocationMapService

public class DefaultLocationMapService
extends java.lang.Object
implements LocationMapService

Default implementation of the LocationMapService.

Constructor Summary

Constructors

Constructor and Description
DefaultLocationMapService()

Method Summary

Modifier and Type	Method and Description
protected GPS	calculateGPS(java.lang.String town, java.lang.String postalCode, java.lang.String countryCode) Method for calculating GPS coordinates based on address.
protected GeoWebServiceWrapper	getGeoServiceWrapper()
LocationService	getLocationService()
Map	getMapOfLocations(GPS gps, int limitLocationsCount, BaseStoreModel baseStore) Calculating Map, basing on number of points of interest defined by user and proper radius.
Map	getMapOfLocations(java.lang.String searchTerm, java.lang.String countryCode, int limitLocationsCount, BaseStoreModel baseStore) Method looks for nearby locations for given postal code or town name and creates Map object with found data.
Map	getMapOfLocationsForPostcode(java.lang.String postalCode, java.lang.String countryCode, int limitLocationsCount, BaseStoreModel baseStore) Method looks for nearest locations (points of interest) to the place defined by postal code and country, and creates Map object with given data.
Map	getMapOfLocationsForTown(java.lang.String town, int limitLocationsCount, BaseStoreModel baseStore) Method looks for nearest locations (points of interest) to the place defined by city name, and creates Map object with given data.
MapService	getMapService()
double	getRadiusMax()
double	getRadiusStep()
void	setGeoServiceWrapper(GeoWebServiceWrapper geoServiceWrapper)
void	setLocationService(LocationService distanceAwareLocationService)
void	setMapService(MapService mapService)
void	setRadiusMax(double radiusMax)
void	setRadiusStep(double radiusStep)
protected void	validateInputData(java.lang.Object input, java.lang.String message) Validation for input parameters.
protected void	validateInputData(java.lang.String input, java.lang.String message)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultLocationMapService

public DefaultLocationMapService()

Method Detail

getMapOfLocationsForPostcode

public Map getMapOfLocationsForPostcode(java.lang.String postalCode,
                                        java.lang.String countryCode,
                                        int limitLocationsCount,
                                        BaseStoreModel baseStore)

Description copied from interface: LocationMapService

Method looks for nearest locations (points of interest) to the place defined by postal code and country, and creates Map object with given data. Number of returned locations is adequate to user definition. Use when map representation is required.

Specified by:

getMapOfLocationsForPostcode in interface LocationMapService

Parameters:

postalCode - searching condition for locations - postal code

countryCode - searching condition for locations - country code

limitLocationsCount - number of locations to return

baseStore - if set, method will return locations bound to the given BaseStoreModel

Returns:

map object with found locations

getMapOfLocationsForTown

public Map getMapOfLocationsForTown(java.lang.String town,
                                    int limitLocationsCount,
                                    BaseStoreModel baseStore)

Description copied from interface: LocationMapService

Method looks for nearest locations (points of interest) to the place defined by city name, and creates Map object with given data. Number of returned locations is adequate to user definition. Use when map representation is required.

Specified by:

getMapOfLocationsForTown in interface LocationMapService

Parameters:

town - searching condition for locations

limitLocationsCount - number of locations to return

baseStore - if set, method will return locations bound to the given BaseStoreModel

Returns:

map object with found locations

getMapOfLocations

public Map getMapOfLocations(java.lang.String searchTerm,
                             java.lang.String countryCode,
                             int limitLocationsCount,
                             BaseStoreModel baseStore)

Description copied from interface: LocationMapService

Method looks for nearby locations for given postal code or town name and creates Map object with found data.

Specified by:

getMapOfLocations in interface LocationMapService

Parameters:

searchTerm - the search term - can be postal code or town name

countryCode - the country code - country code to look for (valid if given value is postal code)

limitLocationsCount - number of locations to return

baseStore - if set, method will return locations bound to the given BaseStoreModel

Returns:

map object with found locations

getMapOfLocations

public Map getMapOfLocations(GPS gps,
                             int limitLocationsCount,
                             BaseStoreModel baseStore)

Calculating Map, basing on number of points of interest defined by user and proper radius.

Specified by:

getMapOfLocations in interface LocationMapService

Parameters:

gps - coordinates of center point

limitLocationsCount - number of places to find, defined by user

baseStore - if set, method will return locations bound to the given BaseStoreModel

Returns:

map from store locator map service

Throws:

LocationMapServiceException

MapServiceException

validateInputData

protected void validateInputData(java.lang.Object input,
                                 java.lang.String message)

Validation for input parameters.

Parameters:

input - parameter to validate

message - message to be thrown

validateInputData

protected void validateInputData(java.lang.String input,
                                 java.lang.String message)

calculateGPS

protected GPS calculateGPS(java.lang.String town,
                           java.lang.String postalCode,
                           java.lang.String countryCode)

Method for calculating GPS coordinates based on address.

Parameters:

town - searching condition for locations, name of the specified city

postalCode - searching condition for locations, postal code

countryCode - searching condition for locations, code for the country

Returns:

coordinates of location, based on given address

Throws:

GeoServiceWrapperException

getGeoServiceWrapper

protected GeoWebServiceWrapper getGeoServiceWrapper()

setGeoServiceWrapper

public void setGeoServiceWrapper(GeoWebServiceWrapper geoServiceWrapper)

getRadiusStep

public double getRadiusStep()

setRadiusStep

public void setRadiusStep(double radiusStep)

getRadiusMax

public double getRadiusMax()

setRadiusMax

public void setRadiusMax(double radiusMax)

getMapService

public MapService getMapService()

setMapService

public void setMapService(MapService mapService)

setLocationService

public void setLocationService(LocationService distanceAwareLocationService)

getLocationService

public LocationService getLocationService()