GeoLocatorFormHandler (ATG Java API)

java.lang.Object
- atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
- - atg.nucleus.GenericService
  - - atg.droplet.EmptyFormHandler
    - - atg.droplet.GenericFormHandler
      - atg.commerce.locations.GeoLocatorFormHandler

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, DropletFormHandler, 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 GeoLocatorFormHandler
extends GenericFormHandler
```
This form handler can be used to return items in a repository based on their geographical location.
Location Properties
To locate items one of the following property combinations need to be provided as a central location to search from:

address
A free form address entry. For example 'Kendall Square', '02135', or '1 Main Street Cambridge Ma' would all be potential inputs.
postalCode
A postal or zip code
city & state
A city and state combination
latitude & longitude
A latitude and longitude values
Note that address, postalCode, and city & state require a configured GeoLocatorProvider that supports those methods of input.
A distance must be provided to indicate the range of returned results. Only items within the provided distance will be in the result set. Distance is measured in meters by default. -1 indicates no location based restraint.

distance
the distance to use.
unitOfMeasureKey
the unit of measure of the provided distance.
maximumDistance
The maximum distance allowed. -1 indicates no restraint on the distance property.

Form Actions
In addition to the standard "cancel" action of all form handlers:

locateItems

execute the search and store the results.

Retrieving Results
Once the query has been performed, the results are available:

locationResults

A Collection of all items that satisfied the criteria. All items in this collection will be within the given distance from the central location.

searchResultsByItemType

Page Navigation
A set of properties and actions are provided to allow a page developer to create controls which navigate between pages of results. Use the the following properties to create "Next", "Previous" or "Go to Page #" buttons.

enableCountQuery
turns the page navigation functionality on
maxResultsPerPage
this property represents the maximum number of search results to present on a page. If there are more than maxResultsPerPage that fit the search criteria, the next set of results can be displayed when the user hits a "Next" button. Default value is -1 which indicates no maximum.

currentResultPageNum
the page of the result set is currently being viewed. Be aware that this is a 1 based number so that it is displayable to the user. Set this property to update the set of results for the current page. The default value is 1.

resultSetSize
represents the total number of items matching the query

resultPageCount
the number of pages of results. This is calculated as the resultSetSize / maxResultsPerPage + 1 if any remainder exists

startIndex
the index (0-based, inclusive) of the first record in the full result set which is displayed on the current page. This property is read-only.

endIndex
the index (0-based, exclusive) of the last record in the full result set which is displayed on the current page. This property is read-only.

startCount
the index (1-based, inclusive) of the first record in the full result set which is displayed on the current page. This property this can be used to display the current range of results displayed, i.e. "1-10 out of 100". This property is read-only.

endCount
the index (1-based, inclusive) of the last record in the full result set which is displayed on the current page. This property this can be used to display the current range of results displayed, i.e. "1-10 out of 100". This property is read-only.

Redirection
Properties are available for setting a URL for conditional redirection. If a URL parameter is not set, the redirection will not take place.

successURL
used if the query is successful and no form errors are encountered

errorURL
used if query fails or a form error occurs

clearQueryURL
used if the clearQuery action is called

Site Filter Properties
If the items being located have a site membership property, the returned items can be filtered to only include specific sites. The default behavior is to filter on the current site. Either a list of sites can be specified or a siteScope that specifies all, any, none, or a shareable id.

siteIds
an array of site ID's to filter items by

siteScope
can be current or null to filter on current site, any to filter items that have at least one site, all to not filter by site
, none to filter on items that don't have site membership, or any shareable id to filter on the sites that share a ShareableType
isIncludeInactiveSites
If filtering on sites, include active sites.

isIncludeDisabledSites
If filtering on sites, include disabled sites.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string
`static java.lang.String`	`INVALID_PROP_COMBINATION` droplet exception code: can't combine these properties
`protected int`	`mEndIndex`
`protected int`	`mStartIndex`

Fields inherited from class atg.droplet.GenericFormHandler
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS

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

GeoLocatorFormHandler()

Constructors
Constructor and Description
`GeoLocatorFormHandler()`

Method Summary

All Methods Instance Methods Concrete Methods
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()` Generates the ContextFilteringRules to filter the query based on the sites.
`java.lang.String`	`getAddress()` A free form address field that can indicate a central location
`java.lang.String`	`getCity()` Returns property city.
`CoordinateManager`	`getCoordinateManager()` The coordinate manager that is used to locate items for this form handler.
`java.lang.String`	`getCountryCode()` Get the country code
`int`	`getCurrentResultPageNum()` Returns property CurrentResultPageNum
`double`	`getDistance()` Returns property distance.
`int`	`getEndCount()` Returns the property EndCount.
`int`	`getEndIndex()` Returns the property EndIndex.
`java.lang.String`	`getErrorURL()` Returns property ErrorURL
`GeoLocatorService`	`getGeoLocatorService()` The GeoLocatorService that is used to take an input and find a corresponding latitude and longitude representing that location
`protected java.util.ArrayList`	`getItems(Coordinate pCoordinate, double pDistance, java.util.Collection<java.lang.String> pSiteIds)` Gets the items for this form handler to return based on input location.
`java.lang.String`	`getItemType()` Get the repository item type being located.
`java.lang.String`	`getLanguage()` Get the language.
`double`	`getLatitude()` The latitude to use as a central location.
`protected Coordinate`	`getLocation(DynamoHttpServletRequest pRequest)` Gets the location to search from.
`java.util.Collection`	`getLocationResults()` Returns property locationResults.
`double`	`getLongitude()` The longitude to use as a central location
`double`	`getMaximumDistance()` The maximum distance that can be used to locate items.
`int`	`getMaxResultsPerPage()` Returns property maxResultsPerPage
`java.lang.String`	`getPostalCode()` Returns property postalCode.
`int`	`getResultPageCount()` Returns the number of results pages which is calculated as the resultSetSize / maxResultsPerPage + 1 if any remainder exists.
`int`	`getResultSetSize()` Returns property ResultSetSize
`SiteGroupManager`	`getSiteGroupManager()` Returns the SiteGroupManager component
`java.util.Collection<java.lang.String>`	`getSiteIds()` Get the siteIds property.
`SiteManager`	`getSiteManager()` Gets the SiteManager
`java.lang.String`	`getSiteScope()` Gets the property siteScope
`int`	`getStartCount()` Returns the property startCount.
`int`	`getStartIndex()` Returns the property startIndex.
`java.lang.String`	`getState()` The state or region to use as a central location in combination with a provided city.
`java.lang.String`	`getSuccessURL()` Returns property SuccessURL
`java.lang.String`	`getUnitOfMeasureKey()`
`atg.commerce.units.UnitOfMeasureTools`	`getUnitOfMeasureTools()` Gets the unit of measure tools used for UOM conversions
`boolean`	`handleCurrentResultPageNum(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)` Called when user is iterating through pages of results.
`boolean`	`handleLocateItems(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)` Locate items within the provided distance restricted by site and using a central location of either address, city & state, postal code, or latitude & longitude.
`boolean`	`isEnableCountQuery()` If the `getMaxResultsPerPage()` is greater than zero, then this method returns true.
`boolean`	`isIncludeDisabledSites()` Returns the includeDisabledSites property.
`boolean`	`isIncludeInactiveSites()` Whether or not the site filter should include inactive sites.
`void`	`setAddress(java.lang.String pAddress)` Set the address field.
`void`	`setCity(java.lang.String pCity)` Sets the property city.
`void`	`setCoordinateManager(CoordinateManager pCoordinateManager)` Sets the coordinate manager.
`void`	`setCountryCode(java.lang.String pCountryCode)` Set the country code.
`void`	`setCurrentResultPageNum(int pCurrentResultPageNum)` Sets the property currentResultPageNum.
`void`	`setDistance(double pDistance)` Set the property distance.
`void`	`setEndIndex(int pIndex)` Set the endIndex to a particular value.
`void`	`setErrorURL(java.lang.String pURL)` Sets property ErrorURL.
`void`	`setGeoLocatorService(GeoLocatorService pGeoLocatorService)` Sets the GeoLocatorService
`void`	`setIncludeDisabledSites(boolean pIncludeDisabledSites)` Sets the includeDisabledSites property.
`void`	`setIncludeInactiveSites(boolean pIncludeInactiveSites)` Sets whether or not the site filter should include inactive sites.
`void`	`setItemType(java.lang.String pItemType)` Set the item type being located.
`void`	`setLanguage(java.lang.String pLanguage)` Sets the language property.
`void`	`setLatitude(double pLatitude)` Set the latitude.
`protected void`	`setLocationResults(java.util.ArrayList pLocationResults)` Sets property locationResults.
`void`	`setLongitude(double pLongitude)` Set the longitude
`void`	`setMaximumDistance(double pMaximumDistance)` Set the maximum distance that can be used to locate items
`void`	`setMaxResultsPerPage(int pMaxResultsPerPage)` Sets the property maxResultsPerPage.
`void`	`setPostalCode(java.lang.String pPostalCode)` Set the postalCode property.
`void`	`setResultSetSize(int pResultSetSize)`
`void`	`setSiteGroupManager(SiteGroupManager pSiteGroupManager)` Sets the SiteGroupManager component
`void`	`setSiteIds(java.util.Collection pSiteIds)` Set the site Ids
`void`	`setSiteManager(SiteManager pSiteManager)`
`void`	`setSiteScope(java.lang.String pSiteScope)` Sets the property siteScope.
`void`	`setStartIndex(int pIndex)` Set the startIndex to a particular value.
`void`	`setState(java.lang.String pState)` Sets the property state.
`void`	`setSuccessURL(java.lang.String pURL)` Sets property SuccessURL.
`void`	`setUnitOfMeasureKey(java.lang.String pUnitOfMeasureKey)`
`void`	`setUnitOfMeasureTools(atg.commerce.units.UnitOfMeasureTools pUnitOfMeasureTools)` Sets the unit of measure tools used for UOM conversions

Methods inherited from class atg.droplet.EmptyFormHandler
afterGet, beforeGet

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 final java.lang.String CLASS_VERSION
```
    Class version string
    
    See Also:
    
    Constant Field Values
  - INVALID_PROP_COMBINATION
```
public static final java.lang.String INVALID_PROP_COMBINATION
```
    droplet exception code: can't combine these properties
    
    See Also:
    
    Constant Field Values
  - mStartIndex
```
protected int mStartIndex
```
  - mEndIndex
```
protected int mEndIndex
```
- Constructor Detail
  - GeoLocatorFormHandler
```
public GeoLocatorFormHandler()
```
- Method Detail
  - getLocationResults
```
public java.util.Collection getLocationResults()
```
    Returns property locationResults. This property contains the results after handleLocateItems is run, and is the collection of repository items found to be within a certain distance of a central location.
    
    Returns:
    
    A Collection of repository items that are within a certain distance from a central location
  - setLocationResults
```
protected void setLocationResults(java.util.ArrayList pLocationResults)
```
    Sets property locationResults.
    
    Parameters:
    
    pLocationResults - the location results to set
  - getDistance
```
public double getDistance()
```
    Returns property distance. This is the distance, in meters, to find items within.
    
    Returns:
    
    the distance
  - setDistance
```
public void setDistance(double pDistance)
```
    Set the property distance. pDistance will be multiplied by distanceConversion to determine the distance in meters to search by. Only items within the resulting distance from the central location will be part of the results.
    
    Parameters:
    
    pDistance - the distance to set after multiplying this distance by distanceConversion
  - getLatitude
```
public double getLatitude()
```
    The latitude to use as a central location.
    
    Returns:
    
    the latitude
  - setLatitude
```
public void setLatitude(double pLatitude)
```
    Set the latitude.
    
    Parameters:
    
    pLatitude - the latitude to use as a central location.
  - getLongitude
```
public double getLongitude()
```
    The longitude to use as a central location
    
    Returns:
    
    the longitude
  - setLongitude
```
public void setLongitude(double pLongitude)
```
    Set the longitude
    
    Parameters:
    
    pLongitude - the longitude to use as a central location.
  - getPostalCode
```
public java.lang.String getPostalCode()
```
    Returns property postalCode. This is the postal code to use as a central location.
    
    Returns:
    
    The postal code.
  - setPostalCode
```
public void setPostalCode(java.lang.String pPostalCode)
```
    Set the postalCode property.
    
    Parameters:
    
    pPostalCode - Set the postal code to use as a central location.
  - getCity
```
public java.lang.String getCity()
```
    Returns property city. This is the city to use as a central location if provided with a city/state combination.
    
    Returns:
    
    The city.
  - setCity
```
public void setCity(java.lang.String pCity)
```
    Sets the property city.
    
    Parameters:
    
    pCity - The city to set.
  - getState
```
public java.lang.String getState()
```
    The state or region to use as a central location in combination with a provided city.
    
    Returns:
    
    The state.
  - setState
```
public void setState(java.lang.String pState)
```
    Sets the property state.
    
    Parameters:
    
    pState - The state to set.
  - getAddress
```
public java.lang.String getAddress()
```
    A free form address field that can indicate a central location
    
    Returns:
    
    The address string.
  - setAddress
```
public void setAddress(java.lang.String pAddress)
```
    Set the address field.
    
    Parameters:
    
    pAddress - The address to set.
  - getCountryCode
```
public java.lang.String getCountryCode()
```
    Get the country code
    
    Returns:
    
    the country code.
  - setCountryCode
```
public void setCountryCode(java.lang.String pCountryCode)
```
    Set the country code.
    
    Parameters:
    
    pCountryCode -
  - getLanguage
```
public java.lang.String getLanguage()
```
    Get the language.
    
    Returns:
    
    the language
  - setLanguage
```
public void setLanguage(java.lang.String pLanguage)
```
    Sets the language property. This property will be used along with country code to specify which locale is being used to locate items.
    
    Parameters:
    
    pLanguage - The language being used.
  - getItemType
```
public java.lang.String getItemType()
```
    Get the repository item type being located.
    
    Returns:
    
    the repository item type
  - setItemType
```
public void setItemType(java.lang.String pItemType)
```
    Set the item type being located.
    
    Parameters:
    
    pItemType - The repository item type to set
  - setSiteScope
```
public void setSiteScope(java.lang.String pSiteScope)
```
    Sets the property siteScope.
    
    Parameters:
    
    pSiteScope - the site scope to set.
  - getSiteScope
```
public java.lang.String getSiteScope()
```
    Gets the property siteScope
    
    Returns:
    
    the site scope
  - getSiteIds
```
public java.util.Collection<java.lang.String> getSiteIds()
```
    Get the siteIds property. These siteIds are used as a constraint for any results
    
    Returns:
    
    The siteIds
  - setSiteIds
```
public void setSiteIds(java.util.Collection pSiteIds)
```
    Set the site Ids
    
    Parameters:
    
    pSiteIds - the siteIds 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 the includeDisabledSites property.
    
    Returns:
    
    the includeDisabledSites property.
  - setIncludeDisabledSites
```
public void setIncludeDisabledSites(boolean pIncludeDisabledSites)
```
    Sets the includeDisabledSites property.
    
    Parameters:
    
    pIncludeDisabledSites - whether or not to include disabled sites in the matching process
  - getMaximumDistance
```
public double getMaximumDistance()
```
    The maximum distance that can be used to locate items. Distance cannot be greater than this value
    
    Returns:
    
    the maximumDistance
  - setMaximumDistance
```
public void setMaximumDistance(double pMaximumDistance)
```
    Set the maximum distance that can be used to locate items
    
    Parameters:
    
    pMaximumDistance - sets the maximum distance
  - 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
  - setUnitOfMeasureKey
```
public void setUnitOfMeasureKey(java.lang.String pUnitOfMeasureKey)
```
  - getUnitOfMeasureKey
```
public java.lang.String getUnitOfMeasureKey()
```
  - setMaxResultsPerPage
```
public void setMaxResultsPerPage(int pMaxResultsPerPage)
```
    Sets the property maxResultsPerPage. This property represents the maximum number of search results to present on a page. If there are more than maxResultsPerPage that fit the search query, the next set of maxResultsPerPage can be displayed upon the user hitting the next button. Default value is -1 which indicates no maximum.
    
    Parameters:
    
    pMaxResultsPerPage - the property to store the maximum number of results to be displayed per page.
  - getMaxResultsPerPage
```
public int getMaxResultsPerPage()
```
    Returns property maxResultsPerPage
    
    Returns:
    
    The maximum number of results to be displayed per page.
  - setCurrentResultPageNum
```
public void setCurrentResultPageNum(int pCurrentResultPageNum)
```
    Sets the property currentResultPageNum. This property tells which page of the result set is currently being viewed. The default value is 1, so be aware that this is a 1 based number so it is easy to display to the end user.
    
    Parameters:
    
    pCurrentResultPageNum - the property to tell which page of the result set is currently being viewed.
  - getCurrentResultPageNum
```
public int getCurrentResultPageNum()
```
    Returns property CurrentResultPageNum
    
    Returns:
    
    The current result page being viewed.
  - setResultSetSize
```
public void setResultSetSize(int pResultSetSize)
```
    Parameters:
    
    pResultSetSize - the property that represents the number of items that match the query.
  - getResultSetSize
```
public int getResultSetSize()
```
    Returns property ResultSetSize
    
    Returns:
    
    The number of items that match the query.
  - getResultPageCount
```
public int getResultPageCount()
```
    Returns the number of results pages which is calculated as the resultSetSize / maxResultsPerPage + 1 if any remainder exists.
    
    Returns:
    
    the number of results pages which is calculated as the resultSetSize/maxResultsPerPage + 1.
  - getStartIndex
```
public int getStartIndex()
```
    Returns the property startIndex. This is the index (0-based) into the full result set which is displayed on the current page.
    
    Returns:
    
    the start index (0-based) into the full result set which is displayed on the current page.
  - setStartIndex
```
public void setStartIndex(int pIndex)
```
    Set the startIndex to a particular value. In general you should not modify the start index without very good reason, e.g. you are implementing a subclass of SearchFormHandler that modifies the search results in some way and needs to make sure the indices represent your modified result set.
  - getEndIndex
```
public int getEndIndex()
```
    Returns the property EndIndex. This is the index (0-based) into the full result set which is displayed on the current page.
    
    Returns:
    
    the end index (0-based) into the full result set which is displayed on the current page.
  - setEndIndex
```
public void setEndIndex(int pIndex)
```
    Set the endIndex to a particular value. In general you should not modify the end index without very good reason, e.g. you are implementing a subclass of SearchFormHandler that modifies the search results in some way and needs to make sure the indices represent your modified result set.
  - getStartCount
```
public int getStartCount()
```
    Returns the property startCount. This is the index (1-based) into the full result set which is displayed on the current page.
    
    Returns:
    
    the start index (1-based) into the full result set which is displayed on the current page.
  - getEndCount
```
public int getEndCount()
```
    Returns the property EndCount. This is the index (1-based) into the full result set which is displayed on the current page.
    
    Returns:
    
    the end index (1-based) into the full result set which is displayed on the current page.
  - setSuccessURL
```
public void setSuccessURL(java.lang.String pURL)
```
    Sets property SuccessURL. If search is successful, hander redirects client to this URL.
    
    Parameters:
    
    pURL - a String property that is the URL to redirect to.
  - getSuccessURL
```
public java.lang.String getSuccessURL()
```
    Returns property SuccessURL
    
    Returns:
    
    The value of the property SuccessURL.
  - setErrorURL
```
public void setErrorURL(java.lang.String pURL)
```
    Sets property ErrorURL. If search fails, hander redirects client to this URL. For example, RepositoryException thrown
    
    Parameters:
    
    pURL - a String property that is the URL to redirect to.
  - getErrorURL
```
public java.lang.String getErrorURL()
```
    Returns property ErrorURL
    
    Returns:
    
    The value of the property ErrorURL.
  - getSiteManager
```
public SiteManager getSiteManager()
```
    Gets the SiteManager
    
    Returns:
    
    the siteManager
  - setSiteManager
```
public void setSiteManager(SiteManager pSiteManager)
```
    Parameters:
    
    pSiteManager - the siteManager to set
  - 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
  - getCoordinateManager
```
public CoordinateManager getCoordinateManager()
```
    The coordinate manager that is used to locate items for this form handler.
    
    Returns:
    
    The Coordinate Manager
  - setCoordinateManager
```
public void setCoordinateManager(CoordinateManager pCoordinateManager)
```
    Sets the coordinate manager.
    
    Parameters:
    
    pCoordinateManager - The CoordinateManager
  - getGeoLocatorService
```
public GeoLocatorService getGeoLocatorService()
```
    The GeoLocatorService that is used to take an input and find a corresponding latitude and longitude representing that location
    
    Returns:
    
    the GeoLocatorService.
  - setGeoLocatorService
```
public void setGeoLocatorService(GeoLocatorService pGeoLocatorService)
```
    Sets the GeoLocatorService
    
    Parameters:
    
    pGeoLocatorService - the GeoLocatorService to set
  - handleLocateItems
```
public boolean handleLocateItems(DynamoHttpServletRequest pRequest,
                                 DynamoHttpServletResponse pResponse)
                          throws javax.servlet.ServletException,
                                 java.io.IOException
```
    Locate items within the provided distance restricted by site and using a central location of either address, city & state, postal code, or latitude & longitude.
    
    Parameters:
    
    pRequest - The request
    
    pResponse - the response
    
    Throws:
    
    javax.servlet.ServletException
    
    java.io.IOException
  - handleCurrentResultPageNum
```
public boolean handleCurrentResultPageNum(DynamoHttpServletRequest pRequest,
                                          DynamoHttpServletResponse pResponse)
                                   throws javax.servlet.ServletException,
                                          java.io.IOException
```
    Called when user is iterating through pages of results. Instead of requerying, we set pointers to start and end of page results.
    
    Parameters:
    
    pRequest - the servlet's request
    
    pResponse - the servlet's response
    
    Returns:
    
    false to stop form processing
    
    Throws:
    
    javax.servlet.ServletException - if there was an error while executing the code
    
    java.io.IOException - if there was an error with servlet io
  - 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 form handler
    
    Parameters:
    
    pRequest - the request
    
    Returns:
    
    the coordinates to search for in the form of [latitude, longitude]
  - getItems
```
protected java.util.ArrayList getItems(Coordinate pCoordinate,
                                       double pDistance,
                                       java.util.Collection<java.lang.String> pSiteIds)
                                throws RepositoryException
```
    Gets the items for this form handler 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
  - generateSiteFilter
```
protected java.util.Collection<java.lang.String> generateSiteFilter()
```
    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 occurr 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
  - isEnableCountQuery
```
public boolean isEnableCountQuery()
```
    If the getMaxResultsPerPage() is greater than zero, then this method returns true. Otherwise false.
    
    Returns:
    
    true if getMaxResultsPerPage() > 0. False otherwise.
    
    See Also:
    
    getMaxResultsPerPage()

Class GeoLocatorFormHandler

Field Summary

Fields inherited from class atg.droplet.GenericFormHandler

Fields inherited from class atg.nucleus.GenericService

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

Constructor Summary

Method Summary

Methods inherited from class atg.droplet.GenericFormHandler

Methods inherited from class atg.droplet.EmptyFormHandler

Methods inherited from class atg.nucleus.GenericService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

INVALID_PROP_COMBINATION

mStartIndex

mEndIndex

Constructor Detail

GeoLocatorFormHandler

Method Detail

getLocationResults

setLocationResults

getDistance

setDistance

getLatitude

setLatitude

getLongitude

setLongitude

getPostalCode

setPostalCode

getCity

setCity

getState

setState

getAddress

setAddress

getCountryCode

setCountryCode

getLanguage

setLanguage

getItemType

setItemType

setSiteScope

getSiteScope

getSiteIds

setSiteIds

isIncludeInactiveSites

setIncludeInactiveSites

isIncludeDisabledSites

setIncludeDisabledSites

getMaximumDistance

setMaximumDistance

setUnitOfMeasureTools

getUnitOfMeasureTools

setUnitOfMeasureKey

getUnitOfMeasureKey

setMaxResultsPerPage

getMaxResultsPerPage

setCurrentResultPageNum

getCurrentResultPageNum

setResultSetSize

getResultSetSize

getResultPageCount

getStartIndex

setStartIndex

getEndIndex

setEndIndex

getStartCount

getEndCount

setSuccessURL

getSuccessURL

setErrorURL

getErrorURL

getSiteManager

setSiteManager

setSiteGroupManager

getSiteGroupManager

getCoordinateManager

setCoordinateManager