atg.commerce.locations

Class GeoLocatorService

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.locations.GeoLocatorService

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 GeoLocatorService
extends GenericService

This class is a wrapper around a geolocator provider that can be used to get the coordinates for a given address or postal code.

Field Summary

Fields

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

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

Method Summary

Modifier and Type	Method and Description
java.util.Locale	getDefaultLocale() Returns property DefaultLocale.
Coordinate	getGeoLocation(java.lang.String pPostalOrAddress) Get a geolocation from the configured provider based on either a free form address input or a postal code.
Coordinate	getGeoLocation(java.lang.String pPostalOrAddress, java.util.Locale pLocale) Get a geolocation based on either a free form address input or a postal code.
Coordinate	getGeoLocation(java.lang.String pCity, java.lang.String pArea) Find a geolocation based on a city and a state or province.
Coordinate	getGeoLocation(java.lang.String pCity, java.lang.String pArea, java.util.Locale pLocale) Find a geolocation based on a city and a state or province.
GeoLocatorProvider	getProvider() Gets the provider
boolean	isAllowCityAndState() Whether or not the configured provider only supports postal code or free form address geo-location.
boolean	isAllowFreeFormEntry() Whether or not the configured provider uses an entry method that can take in an address of arbitrary format (e.g '02139', 'Cambridge Ma', or '1 Main Street Cambridge Ma') If this flag is false then getGeoLocation(String, String) is expected to be provided with only a postal code input.
void	setDefaultLocale(java.util.Locale pDefaultLocale) Sets property DefaultLocale
void	setProvider(GeoLocatorProvider pProvider) Sets the provider

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

Class version string

Constructor Detail

GeoLocatorService

public GeoLocatorService()

Method Detail

setProvider

public void setProvider(GeoLocatorProvider pProvider)

Sets the provider

Parameters:

pProvider - A GeoLocatorProvider that will determine a coordinate based on an address

getProvider

public GeoLocatorProvider getProvider()

Gets the provider

Returns:

get the GeoLocatorProvider

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.

isAllowFreeFormEntry

public boolean isAllowFreeFormEntry()

Whether or not the configured provider uses an entry method that can take in an address of arbitrary format (e.g '02139', 'Cambridge Ma', or '1 Main Street Cambridge Ma') If this flag is false then getGeoLocation(String, String) is expected to be provided with only a postal code input.

Returns:

Whether or not this type of entry is allowed.

isAllowCityAndState

public boolean isAllowCityAndState()

Whether or not the configured provider only supports postal code or free form address geo-location. If false then providing city and state/province is not a valid method of geolocation.

Returns:

True if this provider supports a city and state input method

getGeoLocation

public Coordinate getGeoLocation(java.lang.String pPostalOrAddress)

Get a geolocation from the configured provider based on either a free form address input or a postal code. A free form address input may consist of a postal code, address, city, or other identifying information. This method will use the default locale to determine which country is being searched from.

Parameters:

pPostalOrAddress - An address String if isFreeFormEntry is true, otherwise a postal/zip code.

Returns:

A coordinate representing the provided address or postal code.

getGeoLocation

public Coordinate getGeoLocation(java.lang.String pCity,
                                 java.lang.String pArea)

Find a geolocation based on a city and a state or province.

Parameters:

pCity - The city to find a coordinate for.

pArea - An input for the general area where the city is located. Typically a state, county, or province.

pLocale - The locale of the input. Can be used to determine country and language of input.

Returns:

A coordinate representing the provided address or postal code.

getGeoLocation

public Coordinate getGeoLocation(java.lang.String pPostalOrAddress,
                                 java.util.Locale pLocale)

Get a geolocation based on either a free form address input or a postal code. A free form address input may consist of a postal code, address, city, or other identifying information.

Parameters:

pPostalOrAddress - An address String if isFreeFormEntry is true, otherwise a postal/zip code.

pLocale - The locale of the input. Can be used to determine country and language of input.

Returns:

A coordinate representing the provided address or postal code.

getGeoLocation

public Coordinate getGeoLocation(java.lang.String pCity,
                                 java.lang.String pArea,
                                 java.util.Locale pLocale)

Find a geolocation based on a city and a state or province.

Parameters:

pCity - The city to find a coordinate for.

pArea - An input for the general area where the city is located. Typically a state, county, or province.

pLocale - The locale of the input. Can be used to determine country and language of input.

Returns:

A coordinate representing the provided address or postal code.