atg.commerce.locations

Class GeoLocatorDroplet

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.nucleus.TimedOperationService

atg.nucleus.servlet.ServletService

atg.nucleus.servlet.HttpServletService

atg.servlet.DynamoServlet

atg.commerce.locations.GeoLocatorDroplet

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, ParameterServlet, java.util.EventListener, javax.servlet.Servlet

public class GeoLocatorDroplet
extends DynamoServlet

This droplet is used to find all items within a certain distance of a provided location. The configured coordinateManager is responsible for determining what items are searched for as well as performing the actual location searching logic. This droplet is responsible for providing a central location and a distance to search for. If configured, a geoLocatorService will provide the ability to lookup a location based on postal code, city, or an arbitrary address. Otherwise only lookup by latitude & longitude is supported. If multiple location methods are provided the order of priority is as follows (highest to lowest): coordinateItem, address, postalCode, city & state, latitude & longitude The invocation of the droplet can be invoked with the following parameters:

coordinateItem (optional)

An item to search from. It is assumed that this type has the same property name structure as the coordinate manager being used by this droplet.

address (optional)

A free form address input to pass on to the configured geoLocatorService

postalCode (optional)

A postal code to used as the central location to search from.

city (optional)

The city to search from.

state (optional)

The state or province to search from, used only when city is also provided.

latitude (optional)

The latitude of the central location to search from. Must be provided along with longitude

longitude (optional)

The longitude of the central location to search from. Must be provided along with latitude.

distance (optional)

The distance radius (in meters) to search from. All items within this distance from the central location will be returned. If not provided the distance configured for this component will be used.

itemType (optional)

The item type to search from. This must be a valid item type for the underlying coordinateManager's repository This can be used to search for different item descriptors within the same repository, such as location vs store.

siteIds (optional)

The site ids to filter all results by. If passed this is used over any siteScope value

siteScope (optional)

site scope to search within. This can either be all, current, or a shareable id. If not passed then the default site scope will be used.

country (optional)

The country to use as part of the locale

language (optional)

The language to use as part of the locale

elementName (optional)

The name of the results element

This droplet renders the following oparams:

output

Rendered when items within range of the central location are found.

error

Rendered when there was an error executing this droplet.

Example:

 
 <DROPLET bean="/atg/commerce/locations/GeoLocatorDroplet">
  <PARAM NAME="latitude" VALUE="param:latitude">
  <PARAM NAME="longitude" VALUE="param:longitde">
  <PARAM NAME="distance" VALUE="param:distance"/>
  <param name="elementName" value="items">
  <OPARAM NAME="output">
    <valueof param="items"/>
  </OPARAM>
  <OPARAM NAME="error"/>
    Error
  </OPARAM>
 </DROPLET>
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Fields inherited from class atg.servlet.DynamoServlet

mAllowCleanupRequest, mParameters

Fields inherited from class atg.nucleus.servlet.ServletService

SERVLET_INFO_KEY

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
GeoLocatorDroplet()

Method Summary

Modifier and Type	Method and Description
protected java.util.Collection<java.lang.String>	filterSiteList(java.util.Collection<java.lang.String> pSites) Filters the site array used in generateSiteFilter().
protected java.util.Collection<java.lang.String>	generateSiteFilter(java.lang.String pScope) Generates the ContextFilteringRules to filter the query based on the sites.
CoordinateManager	getCoordinateManager()
java.lang.String	getDefaultItemType()
java.util.Locale	getDefaultLocale() Returns property DefaultLocale.
double	getDistance()
GeoLocatorService	getGeoLocatorService()
protected RepositoryItem[]	getItems(DynamoHttpServletRequest pRequest, Coordinate pCoordinate, double pDistance, java.util.Collection<java.lang.String> pSiteIds) Gets the items for this droplet to return based on input location.
protected RepositoryItem[]	getItems(DynamoHttpServletRequest pRequest, RepositoryItem pItem, double pDistance, java.util.Collection<java.lang.String> pSiteIds) Gets the items for this droplet to return based on input location.
protected java.lang.String	getItemType(DynamoHttpServletRequest pRequest) Gets the item type to search for.
protected java.util.Locale	getLocale(DynamoHttpServletRequest pRequest) Gets the locale to use.
protected Coordinate	getLocation(DynamoHttpServletRequest pRequest) Gets the location to search from.
double	getMaximumDistance()
SiteGroupManager	getSiteGroupManager() Returns the SiteGroupManager component
SiteManager	getSiteManager() Gets the SiteManager
java.lang.String	getSiteScope() gets the property siteScope
atg.commerce.units.UnitOfMeasureTools	getUnitOfMeasureTools() Gets the unit of measure tools used for UOM conversions
boolean	isIncludeDisabledSites() Returns theiIncludeDisabledSites property.
boolean	isIncludeInactiveSites() Whether or not the site filter should include inactive sites.
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method provides the default implementation of service, by dispatching to conventionally named methods which begin with "do".
void	setCoordinateManager(CoordinateManager pCoordinateManager)
void	setDefaultItemType(java.lang.String pDefaultItemType)
void	setDefaultLocale(java.util.Locale pDefaultLocale) Sets property DefaultLocale
void	setDistance(double pDistance)
void	setGeoLocatorService(GeoLocatorService pGeoLocatorService)
void	setIncludeDisabledSites(boolean pIncludeDisabledSites) Sets the includeDisabledSites property.
void	setIncludeInactiveSites(boolean pIncludeInactiveSites) Sets whether or not the site filter should include inactive sites.
void	setMaximumDistance(double pMaximumDistance)
void	setSiteGroupManager(SiteGroupManager pSiteGroupManager) Sets the SiteGroupManager component
void	setSiteManager(SiteManager pSiteManager)
void	setSiteScope(java.lang.String pSiteScope) sets the property siteScope.
void	setUnitOfMeasureTools(atg.commerce.units.UnitOfMeasureTools pUnitOfMeasureTools) Sets the unit of measure tools used for UOM conversions

Methods inherited from class atg.servlet.DynamoServlet

doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter

Methods inherited from class atg.nucleus.servlet.ServletService

destroy, getServletConfig, getServletInfo, setServletInfo

Methods inherited from class atg.nucleus.TimedOperationService

getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, 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, toString

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, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

GeoLocatorDroplet

public GeoLocatorDroplet()

Method Detail

setDefaultLocale

public void setDefaultLocale(java.util.Locale pDefaultLocale)

Sets property DefaultLocale

getDefaultLocale

public java.util.Locale getDefaultLocale()

Returns property DefaultLocale. If the property value is null, then JVM's default locale is returned.

setGeoLocatorService

public void setGeoLocatorService(GeoLocatorService pGeoLocatorService)

Parameters:

pGeoLocatorService - the geoLocatorService to set

getGeoLocatorService

public GeoLocatorService getGeoLocatorService()

Returns:

get the geoLocatorService

getMaximumDistance

public double getMaximumDistance()

Returns:

the maximumDistance

setMaximumDistance

public void setMaximumDistance(double pMaximumDistance)

Parameters:

pMaximumDistance - sets the maximum distance

getDistance

public double getDistance()

Returns:

the distance

setDistance

public void setDistance(double pDistance)

Parameters:

distance - the mDistance to set

getCoordinateManager

public CoordinateManager getCoordinateManager()

Returns:

the coordinateManager

setCoordinateManager

public void setCoordinateManager(CoordinateManager pCoordinateManager)

Parameters:

pCoordinateManager - the coordinateManager to set

setUnitOfMeasureTools

public void setUnitOfMeasureTools(atg.commerce.units.UnitOfMeasureTools pUnitOfMeasureTools)

Sets the unit of measure tools used for UOM conversions

Parameters:

pUnitOfMeasureTools -

getUnitOfMeasureTools

public atg.commerce.units.UnitOfMeasureTools getUnitOfMeasureTools()

Gets the unit of measure tools used for UOM conversions

Returns:

the unit of measure tools

getDefaultItemType

public java.lang.String getDefaultItemType()

Returns:

The default item type to look for

setDefaultItemType

public void setDefaultItemType(java.lang.String pDefaultItemType)

Parameters:

pDefaultItemType - the item type to set

setSiteScope

public void setSiteScope(java.lang.String pSiteScope)

sets the property siteScope. This property specifies the default for the siteScope input parameter.

getSiteScope

public java.lang.String getSiteScope()

gets the property siteScope

setSiteGroupManager

public void setSiteGroupManager(SiteGroupManager pSiteGroupManager)

Sets the SiteGroupManager component

Parameters:

pSiteGroupManager - the SiteGroupManager component. Usually /atg/multisite/SiteGroupManager

getSiteGroupManager

public SiteGroupManager getSiteGroupManager()

Returns the SiteGroupManager component

Returns:

returns property siteGroupManager

getSiteManager

public SiteManager getSiteManager()

Gets the SiteManager

Returns:

the siteManager

setSiteManager

public void setSiteManager(SiteManager pSiteManager)

Parameters:

pSiteManager - the siteManager to set

isIncludeInactiveSites

public boolean isIncludeInactiveSites()

Whether or not the site filter should include inactive sites.

Returns:

if includeInactiveSites is false, only active sites should be used, true otherwise.

setIncludeInactiveSites

public void setIncludeInactiveSites(boolean pIncludeInactiveSites)

Sets whether or not the site filter should include inactive sites.

Parameters:

pIncludeInactiveSites - the includeInactiveSites to set

isIncludeDisabledSites

public boolean isIncludeDisabledSites()

Returns theiIncludeDisabledSites property.

Returns:

if includeDisabledSites is false, only enabled sites should be used, true otherwise.

setIncludeDisabledSites

public void setIncludeDisabledSites(boolean pIncludeDisabledSites)

Sets the includeDisabledSites property.

Parameters:

pIncludeDisabledSites - whether or not to include disabled sites in the matching process

service

public void service(DynamoHttpServletRequest pRequest,
                    DynamoHttpServletResponse pResponse)
             throws javax.servlet.ServletException,
                    java.io.IOException

Description copied from class: DynamoServlet

This method provides the default implementation of service, by dispatching to conventionally named methods which begin with "do".

Overrides:

service in class DynamoServlet

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

getLocation

protected Coordinate getLocation(DynamoHttpServletRequest pRequest)

Gets the location to search from. In the default implementation this merely returns the latitude/longitude parameters provided to the droplet

Parameters:

pRequest - the request

Returns:

the coordinates to search for in the form of [latitude, longitude]

getItems

protected RepositoryItem[] getItems(DynamoHttpServletRequest pRequest,
                                    Coordinate pCoordinate,
                                    double pDistance,
                                    java.util.Collection<java.lang.String> pSiteIds)
                             throws RepositoryException

Gets the items for this droplet to return based on input location. This method can be extended to further manipulate the results

Parameters:

pRequest - The request

pLatitude - the latitude of the central location

pLongitude - the longitude of the central location

pDistance - the distance radius (in meters) to search

Returns:

All items that are within the specified distance from the central location

Throws:

RepositoryException

getItems

protected RepositoryItem[] getItems(DynamoHttpServletRequest pRequest,
                                    RepositoryItem pItem,
                                    double pDistance,
                                    java.util.Collection<java.lang.String> pSiteIds)
                             throws RepositoryException

Gets the items for this droplet to return based on input location. This method can be extended to further manipulate the results

Parameters:

pRequest - The request

pItem - The coordinate item to search from

pDistance - the distance radius (in meters) to search

Returns:

All items that are within the specified distance from the central location

Throws:

RepositoryException

getItemType

protected java.lang.String getItemType(DynamoHttpServletRequest pRequest)

Gets the item type to search for.

Parameters:

pRequest - The request

Returns:

The type of item to search for, null if the CoordinateManager's itemType will be used

getLocale

protected java.util.Locale getLocale(DynamoHttpServletRequest pRequest)

Gets the locale to use.

Parameters:

pRequest - The request

Returns:

A Locale to be used by this droplet

generateSiteFilter

protected java.util.Collection<java.lang.String> generateSiteFilter(java.lang.String pScope)

Generates the ContextFilteringRules to filter the query based on the sites. Uses the siteIds property as a list of sites. If siteIds is null, siteScope is used. If siteScope is null, null will be returned. If siteScope is "current", null is returned so the current SiteContext will filter the query. If siteScope is "all", the filter will be set to use ALL sites. If siteScope is any, the filter will be set to ANY. If siteScope is "none", the filter will be set to NONE. All other values of siteScope will be used as a ShareableType id. The list of sites sharing that id will be used to filter the query. If no sites are found sharing that ShareableType id with the current site, the query will be filtered to use ANY site. If includeInactiveSites is false, the site list will be filtered to only contain active sites. This filtering will occur if the sites property is used or if the siteScope is "any" or a shareable id.

Returns:

The site filter

filterSiteList

protected java.util.Collection<java.lang.String> filterSiteList(java.util.Collection<java.lang.String> pSites)

Filters the site array used in generateSiteFilter(). This method is called when the sites property is set or a ShareableType id is used to get a list of sites. If includeInactiveSites is false, all inactive sites will be removed from the list. Also, if includeInactiveSites is false, this method will be called for a scope of ANY.

Parameters:

pSites - The array of site ids

Returns:

The filtered site id array