de.hybris.platform.storelocator.location.impl

Class DefaultLocationService

java.lang.Object

de.hybris.platform.storelocator.location.impl.DefaultLocationService

All Implemented Interfaces:

LocationService

public class DefaultLocationService
extends java.lang.Object
implements LocationService

Default implementation for LocationService.

Constructor Summary

Constructors

Constructor and Description
DefaultLocationService()

Method Summary

Modifier and Type	Method and Description
protected double	calculateDistance(GPS referenceGps, PointOfServiceModel posModel)
boolean	deleteLocation(Location location) Delete the given IAddress from the collection of stored addresses
protected CommonI18NService	getCommonI18NService()
protected GeoWebServiceWrapper	getGeoServiceWrapper()
Location	getLocation(java.lang.String streetName, java.lang.String streetNumber, java.lang.String postalCode, java.lang.String town, java.lang.String countryCode, boolean geocode) Get temporary, non-persisted location
Location	getLocationByName(java.lang.String name) Returns persisted Location by name
protected LocationMapService	getLocationMapService()
java.util.List<Location>	getLocationsForPoint(GPS gps, int limitLocationsCount, BaseStoreModel baseStore) Method returns the nearest locations (points of interest) to the given coordinates, in the number adequate to user definition.
java.util.List<Location>	getLocationsForPostcode(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.
java.util.List<Location>	getLocationsForSearch(java.lang.String searchTerm, java.lang.String countryCode, int limitLocationsCount, BaseStoreModel baseStore) Method looks for nearby locations (points of interest) in the place defined by search term (that can be postal code or town name) and country.
java.util.List<Location>	getLocationsForTown(java.lang.String town, int limitLocationsCount, BaseStoreModel baseStore) Method looks for nearest locations (points of interest) to the place defined by city name.
java.util.List<Location>	getLocationsNearby(GPS gps, double distance) Get all known addresses which are located in the circle centered in the given gps location and a given radius
java.util.List<Location>	getLocationsNearby(GPS gps, double distance, BaseStoreModel baseStore) Get all known addresses which are located in the circle centered in the given gps location and a given radius, which belong to a given store
protected MapService	getMapService()
protected ModelService	getModelService()
protected PointOfServiceDao	getPointOfServiceDao()
java.util.List<DistanceAwareLocation>	getSortedLocationsNearby(GPS gps, double distance, BaseStoreModel baseStore) Returns list of sorted DistanceAwareLocations.
boolean	saveOrUpdateLocation(Location location) Adds a new address or update existing one
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setGeoServiceWrapper(GeoWebServiceWrapper geoServiceWrapper)
void	setLocationMapService(LocationMapService locationMapService)
void	setMapService(MapService mapService)
void	setModelService(ModelService modelService)
void	setPointOfServiceDao(PointOfServiceDao pointOfServiceDao)
protected void	validateInputData(java.lang.Object input, java.lang.String message) Validation for input parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultLocationService

public DefaultLocationService()

Method Detail

deleteLocation

public boolean deleteLocation(Location location)

Description copied from interface: LocationService

Delete the given IAddress from the collection of stored addresses

Specified by:

deleteLocation in interface LocationService

Parameters:

location - GPS coordinates

Returns:

true if address was deleted

getLocationsNearby

public java.util.List<Location> getLocationsNearby(GPS gps,
                                                   double distance)

Description copied from interface: LocationService

Get all known addresses which are located in the circle centered in the given gps location and a given radius

Specified by:

getLocationsNearby in interface LocationService

Parameters:

gps - GPS coordinates

distance - in kilometers

Returns:

List of addresses

getLocationsNearby

public java.util.List<Location> getLocationsNearby(GPS gps,
                                                   double distance,
                                                   BaseStoreModel baseStore)

Description copied from interface: LocationService

Get all known addresses which are located in the circle centered in the given gps location and a given radius, which belong to a given store

Specified by:

getLocationsNearby in interface LocationService

Parameters:

gps - GPS coordinates

distance - in kilometers

baseStore - base store

Returns:

List of addresses

getSortedLocationsNearby

public java.util.List<DistanceAwareLocation> getSortedLocationsNearby(GPS gps,
                                                                      double distance,
                                                                      BaseStoreModel baseStore)

Description copied from interface: LocationService

Returns list of sorted DistanceAwareLocations. Sorting order is ascending - the closest locations come first.

Specified by:

getSortedLocationsNearby in interface LocationService

Parameters:

gps - - reference location. Center.

distance - - radius in [km]. The returned locations are contained in the square that the circle describes.

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

Returns:

a sorted list of nearby locations

calculateDistance

protected double calculateDistance(GPS referenceGps,
                                   PointOfServiceModel posModel)

saveOrUpdateLocation

public boolean saveOrUpdateLocation(Location location)

Description copied from interface: LocationService

Adds a new address or update existing one

Specified by:

saveOrUpdateLocation in interface LocationService

Parameters:

location - GPS coordinates

Returns:

true if operation was successful

getLocationByName

public Location getLocationByName(java.lang.String name)

Description copied from interface: LocationService

Returns persisted Location by name

Specified by:

getLocationByName in interface LocationService

Parameters:

name - name of location

Returns:

Location matched by unique name

getLocation

public Location getLocation(java.lang.String streetName,
                            java.lang.String streetNumber,
                            java.lang.String postalCode,
                            java.lang.String town,
                            java.lang.String countryCode,
                            boolean geocode)

Description copied from interface: LocationService

Get temporary, non-persisted location

Specified by:

getLocation in interface LocationService

Parameters:

streetName - street name

streetNumber - street number

postalCode - postal code

town - name of town

countryCode - country code

geocode - - set to true if return Location should have GPS data populated

Returns:

Location

getLocationsForPostcode

public java.util.List<Location> getLocationsForPostcode(java.lang.String postalCode,
                                                        java.lang.String countryCode,
                                                        int limitLocationsCount,
                                                        BaseStoreModel baseStore)

Description copied from interface: LocationService

Method looks for nearest locations (points of interest) to the place defined by postal code and country. Number of returned locations is adequate to user definition. Use when you don't need any map, only list of sorted locations is enough.

Specified by:

getLocationsForPostcode in interface LocationService

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:

list of found locations

getLocationsForTown

public java.util.List<Location> getLocationsForTown(java.lang.String town,
                                                    int limitLocationsCount,
                                                    BaseStoreModel baseStore)

Description copied from interface: LocationService

Method looks for nearest locations (points of interest) to the place defined by city name. Number of returned locations is adequate to user definition. Use when you don't need any map, only list of sorted locations is enough.

Specified by:

getLocationsForTown in interface LocationService

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:

list of found locations

getLocationsForSearch

public java.util.List<Location> getLocationsForSearch(java.lang.String searchTerm,
                                                      java.lang.String countryCode,
                                                      int limitLocationsCount,
                                                      BaseStoreModel baseStore)

Description copied from interface: LocationService

Method looks for nearby locations (points of interest) in the place defined by search term (that can be postal code or town name) and country. Basically it combines two other methods that retrieves locations for town name and postal code.

Specified by:

getLocationsForSearch in interface LocationService

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:

list of found locations

getLocationsForPoint

public java.util.List<Location> getLocationsForPoint(GPS gps,
                                                     int limitLocationsCount,
                                                     BaseStoreModel baseStore)

Description copied from interface: LocationService

Method returns the nearest locations (points of interest) to the given coordinates, in the number adequate to user definition. Use when you have got defined coordinates and need only sorted locations nearby, without any map.

Specified by:

getLocationsForPoint in interface LocationService

Parameters:

gps - coordinates of center point

limitLocationsCount - number of POIs chosen by user

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

Returns:

list of proper Locations

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

getMapService

protected MapService getMapService()

setMapService

public void setMapService(MapService mapService)

getLocationMapService

protected LocationMapService getLocationMapService()

setLocationMapService

public void setLocationMapService(LocationMapService locationMapService)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getGeoServiceWrapper

protected GeoWebServiceWrapper getGeoServiceWrapper()

setGeoServiceWrapper

public void setGeoServiceWrapper(GeoWebServiceWrapper geoServiceWrapper)

getCommonI18NService

protected CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getPointOfServiceDao

protected PointOfServiceDao getPointOfServiceDao()

setPointOfServiceDao

public void setPointOfServiceDao(PointOfServiceDao pointOfServiceDao)