atg.commerce.locations

Class CoordinateManager

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.locations.CoordinateManager

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class CoordinateManager
extends GenericService

This class manages searching for repository items based on proximity to a coordinate. Coordinates are defined by the latitude/longitude properties (specified by coordinateLatitudePropertyName and coordinateLongitudePropertyName) of either the passed item or the same properties on a child specified by coordinatePropertyName.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CoordinateManager.DistanceComparator Compares two repository items to see which one is closer to the provided distance.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected static double	EARTH_RADIUS_METERS

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
CoordinateManager()

Method Summary

Methods

Modifier and Type	Method and Description
double	addMetersToLatitude(Coordinate pCoordinate, double pMeters) Finds a latitude that is pMeters away from the given latitude.
double	addMetersToLongitude(Coordinate pCoordinate, double pMeters) Finds a longitude that is pMeters away from the given longitude.
void	doStartService() Verify the default configuration a bit to ensure we aren't screwing anything up
protected RepositoryItem[]	filterByDistance(RepositoryItem[] pItems, Coordinate pCoordinate, double pDistance) Filter a set of items by distance to a given coordinate.
protected RepositoryItem[]	filterByDistance(RepositoryItem[] pItems, RepositoryItem pItem, double pDistance) Filter a set of items by distance to a given coordinate.
java.lang.String	getCoordinateLatitudePropertyName()
java.lang.String	getCoordinateLongitudePropertyName()
java.lang.String	getCoordinatePropertyName()
protected Query	getCoordinateRadiusQuery(Coordinate pCoordinate, double pRadius, RepositoryView pView, java.lang.String pItemCoordinatePropertyName, java.util.Collection<java.lang.String> pSiteIds) Gets a query for items specified by the provided view that are within a certain radius of a given coordinate.
java.lang.String	getDefaultItemType()
static double	getDistanceBetween(double lat1, double lng1, double lat2, double lng2) Gets the distance (in meters) between two points
double	getDistanceBetweenCoordinates(Coordinate pCoordinate, RepositoryItem pItem) Gets the distance in meters between two coordinates
double	getDistanceBetweenCoordinates(RepositoryItem pItem1, RepositoryItem pItem2) Gets the distance in meters between two coordinates.
java.lang.String	getDistancePropertyName() Name of a distance property where the results of distance calculation should be set for any results of a getNearest call.
Coordinate	getItemCoordinates(RepositoryItem pItem) Creates a coordinate object from a given repository item
double	getLatitude(RepositoryItem pItem) Gets the latitude of the item either from the item itself or from the child specified by coordinatePropertyName
double	getLongitude(RepositoryItem pItem) Gets the longitude of the item either from the item itself or from the child specified by coordinatePropertyName
RepositoryItem[]	getNearest(Coordinate pCoordinate, double pRadius, java.util.Collection<java.lang.String> pSiteIds) Returns all items within a given distance from a coordinate, ordered by proximity
RepositoryItem[]	getNearest(Coordinate pCoordinate, double pRadius, java.util.Collection<java.lang.String> pSiteIds, java.lang.String pItemType) Returns all items within a given distance from a coordinate, ordered by proximity
RepositoryItem[]	getNearest(RepositoryItem pItem, double pRadius, java.util.Collection<java.lang.String> pSiteIds) Returns all items within the given distance from a coordinate, ordered by proximity
RepositoryItem[]	getNearest(RepositoryItem pItem, double pRadius, java.util.Collection<java.lang.String> pSiteIds, java.lang.String pItemType) Returns all items within a given distance from a coordinate, ordered by proximity
Repository	getRepository()
SiteGroupManager	getSiteGroupManager()
java.lang.String	getSiteGroupsPropertyName()
java.lang.String	getSiteIdPropertyName()
java.lang.String	getSiteIdsPropertyName()
protected Query	getSiteQuery(RepositoryView pView, java.util.Collection<java.lang.String> pSiteIds) Constructs the site constraint portion of the query.
void	setCoordinateLatitudePropertyName(java.lang.String pCoordinateLatitudePropertyName)
void	setCoordinateLongitudePropertyName(java.lang.String pCoordinateLongitudePropertyName)
void	setCoordinatePropertyName(java.lang.String pCoordinatePropertyName)
void	setDefaultItemType(java.lang.String pDefaultItemType)
void	setDistancePropertyName(java.lang.String pDistancePropertyName)
void	setRepository(Repository pRepository)
void	setSiteGroupManager(SiteGroupManager pSiteGroupManager)
void	setSiteGroupsPropertyName(java.lang.String pSiteGroupsPropertyName)
void	setSiteIdPropertyName(java.lang.String pSiteIdPropertyName)
void	setSiteIdsPropertyName(java.lang.String pSiteIdsPropertyName)

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

EARTH_RADIUS_METERS

protected static final double EARTH_RADIUS_METERS

See Also:

Constant Field Values

Constructor Detail

CoordinateManager

public CoordinateManager()

Method Detail

getSiteGroupManager

public SiteGroupManager getSiteGroupManager()

Returns:

the site group manager

setSiteGroupManager

public void setSiteGroupManager(SiteGroupManager pSiteGroupManager)

Parameters:

pSiteGroupManager - the SiteGroupManager to set

getSiteIdPropertyName

public java.lang.String getSiteIdPropertyName()

Returns:

the siteId property name

setSiteIdPropertyName

public void setSiteIdPropertyName(java.lang.String pSiteIdPropertyName)

Parameters:

pSiteIdPropertyName - the siteIdPropertyName to set

getSiteIdsPropertyName

public java.lang.String getSiteIdsPropertyName()

Returns:

the siteIds property name

setSiteIdsPropertyName

public void setSiteIdsPropertyName(java.lang.String pSiteIdsPropertyName)

Parameters:

pSiteIdsPropertyName - the siteIdsPropertyName to set

getSiteGroupsPropertyName

public java.lang.String getSiteGroupsPropertyName()

Returns:

the siteGroups property name

setSiteGroupsPropertyName

public void setSiteGroupsPropertyName(java.lang.String pSiteGroupsPropertyName)

Parameters:

pSiteGroupsPropertyName - the siteGroupsPropertyName to set

getCoordinatePropertyName

public java.lang.String getCoordinatePropertyName()

Returns:

the coordinatePropertyName

setCoordinatePropertyName

public void setCoordinatePropertyName(java.lang.String pCoordinatePropertyName)

Parameters:

pCoordinatePropertyName - the coordinatePropertyName to set

getDistancePropertyName

public java.lang.String getDistancePropertyName()

Name of a distance property where the results of distance calculation should be set for any results of a getNearest call. This is expected to be a scoped property

Returns:

the distance property name.

setDistancePropertyName

public void setDistancePropertyName(java.lang.String pDistancePropertyName)

Parameters:

pDistancePropertyName - The name of the distance property to set

getDefaultItemType

public java.lang.String getDefaultItemType()

Returns:

the defaultItemType that will be located based on coordinate

setDefaultItemType

public void setDefaultItemType(java.lang.String pDefaultItemType)

Parameters:

pItemType - the defaultItemType to set

getRepository

public Repository getRepository()

Returns:

the repository

setRepository

public void setRepository(Repository pRepository)

Parameters:

pRepository - the repository to set

getCoordinateLatitudePropertyName

public java.lang.String getCoordinateLatitudePropertyName()

Returns:

the name of the latitude property

setCoordinateLatitudePropertyName

public void setCoordinateLatitudePropertyName(java.lang.String pCoordinateLatitudePropertyName)

Parameters:

pCoordinateLatitudePropertyName - the name of the latitude property to set

getCoordinateLongitudePropertyName

public java.lang.String getCoordinateLongitudePropertyName()

Returns:

the longitude property name

setCoordinateLongitudePropertyName

public void setCoordinateLongitudePropertyName(java.lang.String pCoordinateLongitudePropertyName)

Parameters:

pCoordinateLongitudePropertyName - the longitude property name to set

doStartService

public void doStartService()
                    throws ServiceException

Verify the default configuration a bit to ensure we aren't screwing anything up

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up

getLatitude

public double getLatitude(RepositoryItem pItem)

Gets the latitude of the item either from the item itself or from the child specified by coordinatePropertyName

Parameters:

pItem: - The item to get the latitude for

Returns:

the latitude of that item

getLongitude

public double getLongitude(RepositoryItem pItem)

Gets the longitude of the item either from the item itself or from the child specified by coordinatePropertyName

Parameters:

pItem: - The item to get the longitude for

Returns:

the longitude of that item

getItemCoordinates

public Coordinate getItemCoordinates(RepositoryItem pItem)

Creates a coordinate object from a given repository item

Parameters:

pItem - the item to create a coordinate for

Returns:

the coordinate that this item refers to.

getNearest

public RepositoryItem[] getNearest(RepositoryItem pItem,
                          double pRadius,
                          java.util.Collection<java.lang.String> pSiteIds)
                            throws RepositoryException

Returns all items within the given distance from a coordinate, ordered by proximity

Parameters:

pItem - The coordinate to search from as a repository item

pRadius - The radius to search within (in meters)

pSiteIds - Only return items belong to these site ids.

Returns:

All items within the given distance.

Throws:

RepositoryException

getNearest

public RepositoryItem[] getNearest(RepositoryItem pItem,
                          double pRadius,
                          java.util.Collection<java.lang.String> pSiteIds,
                          java.lang.String pItemType)
                            throws RepositoryException

Returns all items within a given distance from a coordinate, ordered by proximity

Parameters:

pItem - The coordinate to search from as a repository item

pRadius - the distance to search for items in meters

Returns:

All items within the given distance ordered by proximity to the coordinate

Throws:

RepositoryException

getNearest

public RepositoryItem[] getNearest(Coordinate pCoordinate,
                          double pRadius,
                          java.util.Collection<java.lang.String> pSiteIds)
                            throws RepositoryException

Returns all items within a given distance from a coordinate, ordered by proximity

Parameters:

pCoordinate - the coordinate to search from

pRadius - the distance to search within in meters

pSiteIds - Only return items for the given site ids.

Returns:

All items within the given distance ordered by proximity to the coordinate

Throws:

RepositoryException

getNearest

public RepositoryItem[] getNearest(Coordinate pCoordinate,
                          double pRadius,
                          java.util.Collection<java.lang.String> pSiteIds,
                          java.lang.String pItemType)
                            throws RepositoryException

Returns all items within a given distance from a coordinate, ordered by proximity

Parameters:

pCoordinate - the coordinate to search from

pRadius - The distance to search within (in meters)

pSiteIds - Only return items that belong to one of the given site ids

pItemType - The item descriptor to return results for

Returns:

All items of the given item type within the given distance from the provided latitude and longitude.

Throws:

RepositoryException

filterByDistance

protected RepositoryItem[] filterByDistance(RepositoryItem[] pItems,
                                RepositoryItem pItem,
                                double pDistance)

Filter a set of items by distance to a given coordinate. All items that are further than pDistance from the provided pCoordinate will be filtered out.

Parameters:

pItems - items to filter

pItem - the center coordinate as a repository item

pDistance - the distance to search for items (in meters)

Returns:

All items within pDistance of coordinate.

filterByDistance

protected RepositoryItem[] filterByDistance(RepositoryItem[] pItems,
                                Coordinate pCoordinate,
                                double pDistance)

Filter a set of items by distance to a given coordinate. All items that are further than pDistance from the provided (latitude, longitude) point will be filtered out.

Parameters:

pItems - items to filter

pCoordinate - the center coordinate

pDistance - the distance to search for items (in meters)

Returns:

All items within pDistance of coordinate

getCoordinateRadiusQuery

protected Query getCoordinateRadiusQuery(Coordinate pCoordinate,
                             double pRadius,
                             RepositoryView pView,
                             java.lang.String pItemCoordinatePropertyName,
                             java.util.Collection<java.lang.String> pSiteIds)
                                  throws RepositoryException

Gets a query for items specified by the provided view that are within a certain radius of a given coordinate. Only items within pRadius meters will be returned.

Parameters:

pCoordinate - The coordinate to search from

pRadius - The distance to search for

pView - The view specifying what item/repository this query will run against

pItemCoordinatePropertyName - The name of the coordinate property for the item type being searched

Returns:

A query that will find all items within the specified distance of the coordinate

Throws:

RepositoryException

getSiteQuery

protected Query getSiteQuery(RepositoryView pView,
                 java.util.Collection<java.lang.String> pSiteIds)
                      throws RepositoryException

Constructs the site constraint portion of the query. This query will build in site restrictions based on the item descriptor's available site constraint properties. If the item-descriptor has a siteGroups property (defined by getSiteGroupPropertyName) then any item with a site group that contain at least one of the provided siteIds will be returned.

Parameters:

pView - the view to use

pSiteIds - the siteIds to constrain by.

Returns:

a query representing the site constraints to be used.

Throws:

RepositoryException

getDistanceBetweenCoordinates

public double getDistanceBetweenCoordinates(RepositoryItem pItem1,
                                   RepositoryItem pItem2)

Gets the distance in meters between two coordinates.

Parameters:

pItem1 - first item that contains a coordinate

pItem2 - second item that contains a coordinate

Returns:

The distance between the two coordinates

getDistanceBetweenCoordinates

public double getDistanceBetweenCoordinates(Coordinate pCoordinate,
                                   RepositoryItem pItem)

Gets the distance in meters between two coordinates

Parameters:

pLatitude - latitude of the 1st coordinate

pLongitude - longitude of the 1st coordinate

pItem - item that contains a coordinate

Returns:

The distance between the two coordinates

addMetersToLatitude

public double addMetersToLatitude(Coordinate pCoordinate,
                         double pMeters)

Finds a latitude that is pMeters away from the given latitude. A positive meters value indicates north, negative south.

Parameters:

pCoordinate - the starting coordinate

pMeters - The distance to move

Returns:

The latitude pMeters away in the given direction

addMetersToLongitude

public double addMetersToLongitude(Coordinate pCoordinate,
                          double pMeters)

Finds a longitude that is pMeters away from the given longitude. A positive meters value indicates east, negative west.

Parameters:

pCoordinate - the starting coordinate

pMeters - The distance to move

Returns:

The longitude pMeters away in the given direction

getDistanceBetween

public static double getDistanceBetween(double lat1,
                        double lng1,
                        double lat2,
                        double lng2)

Gets the distance (in meters) between two points

Parameters:

lat1 - latitude of point 1

lng1 - longitude of point 1

lat2 - latitude of point 2

lng2 - longitude of point 2

Returns:

the distance in meters between the two points