de.hybris.platform.storelocator.location.impl

Class DefaultLocationService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

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

All Implemented Interfaces:

LocationService, Serializable

public class DefaultLocationService
extends AbstractBusinessService
implements LocationService

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

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
Location	getLocation(String streetName, String streetNumber, String postalCode, String town, String countryCode, boolean geocode) Get temporary, non-persisted location
Location	getLocationByName(String name) Returns persisted Location by name
LocationMapService	getLocationMapService()
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.
List<Location>	getLocationsForPostcode(String postalCode, String countryCode, int limitLocationsCount, BaseStoreModel baseStore) Method looks for nearest locations (points of interest) to the place defined by postal code and country.
List<Location>	getLocationsForSearch(String searchTerm, 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.
List<Location>	getLocationsForTown(String town, int limitLocationsCount, BaseStoreModel baseStore) Method looks for nearest locations (points of interest) to the place defined by city name.
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
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()
List<DistanceAwareLocation>	getSortedLocationsNearby(GPS gps, double distance, BaseStoreModel baseStore) Returns list of sorted DistanceAwareLocations.
LocationMapService	lookupLocationMapService() Deprecated.
boolean	saveOrUpdateLocation(Location location) Adds a new address or update existing one
void	setGeoServiceWrapper(GeoWebServiceWrapper geoServiceWrapper)
void	setI18nService(I18NService i18nService)
void	setLocationMapService(LocationMapService locationMapService)
void	setMapService(MapService mapService)
void	setPointOfServiceDao(PointOfServiceDao pointOfServiceDao)
protected void	validateInputData(Object input, String message) Validation for input parameters.

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, setTenantScope, writeReplace

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)
                       throws LocationServiceException

Description copied from interface: LocationService

Delete the given IAddress from the collection of stored addresses

Specified by:

deleteLocation in interface LocationService

Returns:

true if address was deleted

Throws:

LocationServiceException

getLocationsNearby

public List<Location> getLocationsNearby(GPS gps,
                                         double distance)
                                  throws LocationServiceException

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

distance - in kilometers

Returns:

List of addresses

Throws:

LocationServiceException

getLocationsNearby

public List<Location> getLocationsNearby(GPS gps,
                                         double distance,
                                         BaseStoreModel baseStore)
                                  throws LocationServiceException

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

distance - in kilometers

Returns:

List of addresses

Throws:

LocationServiceException

getSortedLocationsNearby

public List<DistanceAwareLocation> getSortedLocationsNearby(GPS gps,
                                                            double distance,
                                                            BaseStoreModel baseStore)
                                                     throws LocationServiceException

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

Throws:

LocationServiceException

calculateDistance

protected double calculateDistance(GPS referenceGps,
                                   PointOfServiceModel posModel)
                            throws GeoLocatorException,
                                   LocationServiceException

Throws:

GeoLocatorException

LocationServiceException

saveOrUpdateLocation

public boolean saveOrUpdateLocation(Location location)
                             throws LocationServiceException

Description copied from interface: LocationService

Adds a new address or update existing one

Specified by:

saveOrUpdateLocation in interface LocationService

Returns:

true if operation was successful

Throws:

LocationServiceException

getLocationByName

public Location getLocationByName(String name)
                           throws LocationServiceException

Description copied from interface: LocationService

Returns persisted Location by name

Specified by:

getLocationByName in interface LocationService

Returns:

Location matched by unique name

Throws:

LocationServiceException

setPointOfServiceDao

public void setPointOfServiceDao(PointOfServiceDao pointOfServiceDao)

Parameters:

pointOfServiceDao - the pointOfServiceDao to set

setI18nService

public void setI18nService(I18NService i18nService)

Parameters:

i18nService - the i18nService to set

getLocation

public Location getLocation(String streetName,
                            String streetNumber,
                            String postalCode,
                            String town,
                            String countryCode,
                            boolean geocode)
                     throws LocationServiceException

Description copied from interface: LocationService

Get temporary, non-persisted location

Specified by:

getLocation in interface LocationService

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

Returns:

Location

Throws:

LocationServiceException

setGeoServiceWrapper

public void setGeoServiceWrapper(GeoWebServiceWrapper geoServiceWrapper)

Parameters:

geoServiceWrapper - the geoServiceWrapper to set

getLocationsForPostcode

public List<Location> getLocationsForPostcode(String postalCode,
                                              String countryCode,
                                              int limitLocationsCount,
                                              BaseStoreModel baseStore)
                                       throws LocationServiceException

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

Throws:

LocationServiceException

getLocationsForTown

public List<Location> getLocationsForTown(String town,
                                          int limitLocationsCount,
                                          BaseStoreModel baseStore)
                                   throws LocationServiceException

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

Throws:

LocationServiceException

getLocationsForSearch

public List<Location> getLocationsForSearch(String searchTerm,
                                            String countryCode,
                                            int limitLocationsCount,
                                            BaseStoreModel baseStore)
                                     throws LocationMapServiceException

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

Throws:

LocationMapServiceException

getLocationsForPoint

public List<Location> getLocationsForPoint(GPS gps,
                                           int limitLocationsCount,
                                           BaseStoreModel baseStore)
                                    throws LocationServiceException

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

Throws:

LocationServiceException

validateInputData

protected void validateInputData(Object input,
                                 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)

lookupLocationMapService

@Deprecated
public LocationMapService lookupLocationMapService()

Deprecated.

getLocationMapService

public LocationMapService getLocationMapService()

setLocationMapService

public void setLocationMapService(LocationMapService locationMapService)