edu.ucdavis.cstars.client.tasks

Class Locator

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.Locator

public class Locator
extends com.google.gwt.core.client.JavaScriptObject

Represents a geocode service resource exposed by the ArcGIS Server REST API. It is used to generate candidates for an address. It also used to find an address for a given location.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Locator.Parameters Class for adding sending outFields in addressToLocations()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAddressToLocationsHandler(AddressToLocationsHandler handler) Add event handler for addressToLocations
void	addErrorHandler(ErrorHandler handler) Add event handler for errors
void	addLocationToAddressHandler(LocationToAddressHandler handler) Add event handler for locationToAddress
Deferred	addressToLocations(Locator.Parameters params) Sends a request to the ArcGIS REST geocode resource to find candidates for a single address specified in the address argument.
Deferred	addressToLocations(Locator.Parameters params, AddressToLocationsCallback callback) Sends a request to the ArcGIS REST geocode resource to find candidates for a single address specified in the address argument.
static Locator	create(java.lang.String url) Creates a new Locator object.
SpatialReference	getOutSpatialReference() The spatial reference of the output geometries.
java.lang.String	getUrl() URL to the ArcGIS Server REST resource that represents a locator service
Deferred	locationToAddress(Point location, double distance) Locates an address based on a given point.
Deferred	locationToAddress(Point location, double distance, LocationToAddressCallback callback) Locates an address based on a given point.
void	setOutSpatialReference(SpatialReference outSpatialReference) Sets the well-known ID of the spatial reference of the output geometries.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static Locator create(java.lang.String url)

Creates a new Locator object.

Parameters:

url - - URL to the ArcGIS Server REST resource that represents a locator service. An example is http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Locators/ESRI_Geocode_USA/GeocodeServer.

Returns:

Locator

getOutSpatialReference

public final SpatialReference getOutSpatialReference()

The spatial reference of the output geometries. If not specified, the output geometries are in the spatial reference of the input geometries. If processSpatialReferencew is specified and outSpatialReference is not specified, the output geometries are in the spatial reference of the process spatial reference. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.

Returns:

SpatialReference

getUrl

public final java.lang.String getUrl()

URL to the ArcGIS Server REST resource that represents a locator service

Returns:

String

addressToLocations

public final Deferred addressToLocations(Locator.Parameters params,
                          AddressToLocationsCallback callback)

Sends a request to the ArcGIS REST geocode resource to find candidates for a single address specified in the address argument. On completion, the onAddressToLocationsComplete event is fired and the optional callback function is invoked.

Parameters:

params - - Specify the address and optionally specify the outFields and searchExtent. The searchExtent parameter requires a locator published with ArcGIS Server 10.1 or greater.

callback - - The function to call when the method has completed or if an error object is returned if an error occurs on the Server during task execution

Returns:

Deferred

addressToLocations

public final Deferred addressToLocations(Locator.Parameters params)

Sends a request to the ArcGIS REST geocode resource to find candidates for a single address specified in the address argument. On completion, the onAddressToLocationsComplete event is fired and the optional callback function is invoked.

Parameters:

params - - Specify the address and optionally specify the outFields and searchExtent. The searchExtent parameter requires a locator published with ArcGIS Server 10.1 or greater.

Returns:

Deferred

locationToAddress

public final Deferred locationToAddress(Point location,
                         double distance,
                         LocationToAddressCallback callback)

Locates an address based on a given point.

Parameters:

location - - The point at which to search for the closest address. The location should be in the same spatial reference as that of the geocode service.

distance - - The distance in meters from the given location within which a matching address should be searched. If this parameter is not provided or an invalid value is provided, a default value of 0 meters is used.

callback - - The function to call when the method has completed or if an error object is returned if an error occurs on the Server during task execution.

Returns:

Deferred

locationToAddress

public final Deferred locationToAddress(Point location,
                         double distance)

Locates an address based on a given point.

Parameters:

location - - The point at which to search for the closest address. The location should be in the same spatial reference as that of the geocode service.

distance - - The distance in meters from the given location within which a matching address should be searched. If this parameter is not provided or an invalid value is provided, a default value of 0 meters is used.

Returns:

Deferred

setOutSpatialReference

public final void setOutSpatialReference(SpatialReference outSpatialReference)

Sets the well-known ID of the spatial reference of the output geometries.

Parameters:

outSpatialReference - - The well-known ID of a spatial reference.

addAddressToLocationsHandler

public final void addAddressToLocationsHandler(AddressToLocationsHandler handler)

Add event handler for addressToLocations

Parameters:

handler - - Fires when Locator.addressToLocation() has completed.

addErrorHandler

public final void addErrorHandler(ErrorHandler handler)

Add event handler for errors

Parameters:

handler - - Fires when an error occurs when executing the task.

addLocationToAddressHandler

public final void addLocationToAddressHandler(LocationToAddressHandler handler)

Add event handler for locationToAddress

Parameters:

handler - - Fires when Locator.locationToAddress() has completed.