com.adobe.cq.address.api.location

Interface LocationManager

public interface LocationManager

The LocationManager provides methods to retrieve, update, create and update locations.

Method Summary

Methods

Modifier and Type	Method and Description
Location	addLocation(String groupPath, Map<String,Object> properties, boolean autoSave) Adds a location to the location group.
Location	getLocation(String path) Returns the location based on its path.
List<Location>	getLocations(String groupPath) Returns the locations belonging to a location group.
List<Location>	rankLocations(String groupPath, Coordinates origin, boolean geocode) Returns a sorted list of locations ranked by closest distance to origin coordinates.
void	removeLocation(Location location, boolean autoSave) Removes the location.
Location	updateLocation(Location location, Map<String,Object> properties, boolean autoSave) Updates the location.

Method Detail

getLocations

List<Location> getLocations(String groupPath)

Returns the locations belonging to a location group.

Parameters:

groupPath - The location group path

Returns:

The addresses or null if there are none

rankLocations

List<Location> rankLocations(String groupPath,
                           Coordinates origin,
                           boolean geocode)

Returns a sorted list of locations ranked by closest distance to origin coordinates.

Parameters:

groupPath - The location group path

origin - Latitude and longitude coordinates to rank locations against

geocode - Flag that indicates if each location should be geocoded if it does not have stored coordinates

Returns:

ranked list of locations

getLocation

Location getLocation(String path)

Returns the location based on its path.

Parameters:

path - The location path

Returns:

The location or null if it does not exist

removeLocation

void removeLocation(Location location,
                  boolean autoSave)
                    throws AddressException

Removes the location.

Parameters:

location - The location address

autoSave - If true the operation is persisted

Throws:

AddressException - when the operation fails.

IllegalArgumentException - when the location is null

addLocation

Location addLocation(String groupPath,
                   Map<String,Object> properties,
                   boolean autoSave)
                     throws AddressException

Adds a location to the location group.

Parameters:

groupPath - The location group path

properties - The location properties

autoSave - If true the operation is persisted

Returns:

The new location

Throws:

AddressException - when the operation fails.

updateLocation

Location updateLocation(Location location,
                      Map<String,Object> properties,
                      boolean autoSave)
                        throws AddressException

Updates the location.

Parameters:

location - The location address

properties - The location properties

autoSave - If true the operation is persisted

Returns:

The updated location

Throws:

AddressException - when the operation fails.

IllegalArgumentException - when the location is null