Package | com.esri.baserver.tasks.analyses |
Class | public final class SpatialOverlayTask |
Inheritance | SpatialOverlayTask BAServerTask BATask AbstractTask flash.events.EventDispatcher |
The Spatial Overlay task allows you to summarize demographic data for a set of custom trade areas and add summarized values as attribute fields to the output feature class.
The result of this task is a TaskResultOutput
object,
which is compatible with ArcGIS Server's mapping APIs. FeatureSet and MapImage objects
can be returned in it depending on task output options requested.
Additionally, the output analysis layer can be stored to the Business Analyst Server repository.
See also
Property | Defined By | ||
---|---|---|---|
activeDatasetID : String
Active dataset ID. | BAServerTask | ||
concurrency : String
Value that indicates how to handle multiple calls to the same task. | AbstractTask | ||
disableClientCaching : Boolean
If true, adds a timestamp parameter ("_ts") to the REST request to prevent the request from
being loaded from the browser's cache. | AbstractTask | ||
isFullErrorMessage : Boolean
Produce an error message with stack trace (true) or without stack trace (false). | BAServerTask | ||
lastResult : TaskResultOutput [read-only]
The last result of executing the Spatial Overlay task. | SpatialOverlayTask | ||
proxyURL : String
The URL to proxy the request through. | AbstractTask | ||
requestTimeout : Number
The request timeout in seconds. | AbstractTask | ||
showBusyCursor : Boolean
If true, a busy cursor is displayed while a service is executing. | AbstractTask | ||
token : String
Token for accessing a secure task. | AbstractTask | ||
tokenProvider : ITokenProvider
Provider responsible for updating the security token if the last one expires. | BATask | ||
url : String
URL of the task. | AbstractTask |
Method | Defined By | ||
---|---|---|---|
SpatialOverlayTask(urlOrClient:Object = null)
Creates a new instance of the SpatialOverlayTask class. | SpatialOverlayTask | ||
Creates a new command encapsulating this task and the given parameters. | SpatialOverlayTask | ||
execute(parameters:SpatialOverlayParameters, responder:IResponder = null):AsyncToken
Sends a request for executing a Spatial Overlay task to the Business Analyst Server HTTP (REST) Service. | SpatialOverlayTask |
Constant | Defined By | ||
---|---|---|---|
name : String = SpatialOverlay [static] Task name. | SpatialOverlayTask |
lastResult | property |
lastResult:TaskResultOutput
[read-only] The last result of executing the Spatial Overlay task.
public function get lastResult():TaskResultOutput
SpatialOverlayTask | () | Constructor |
public function SpatialOverlayTask(urlOrClient:Object = null)
Creates a new instance of the SpatialOverlayTask class.
A new task can be constructed in two ways: as a task sharing a BAServerClient type instance
with other tasks (the urlOrClient
parameter has the BAServerClient type) or
as a standalone task encapsulating its own client.
The base URL to the Business Analyst Server HTTP Service looks as follows:
http://{host}:{port}/ArcGIS/baserver/REST/services/DefaultMap/BAServer
The {host}
and {port}
parameters in this URL should be substituted with
valid Business Analyst Server host name and port, respectively.
urlOrClient:Object (default = null ) — A variable containing either Business Analyst Server HTTP Service base URL string or an
instance of the BAServerClient class.
|
See also
createCommand | () | method |
public function createCommand(parameters:SpatialOverlayParameters, commandName:String = null):BACommand
Creates a new command encapsulating this task and the given parameters.
Parameters
parameters:SpatialOverlayParameters — Parameters of a task to be executed.
| |
commandName:String (default = null ) — Command name.
|
BACommand — A new command.
|
execute | () | method |
public function execute(parameters:SpatialOverlayParameters, responder:IResponder = null):AsyncToken
Sends a request for executing a Spatial Overlay task to the Business Analyst Server HTTP (REST) Service.
A response can be received in two ways—in an optional
responder
object passed in parameters
of this method and/or in listeners of fault
and taskCompleted
events registered for this task.
The responder is notified first when a response is received and parsed.
Its fault
method receives a parameter of the FaultEvent
type and its
result
method receives a parameter of the BATaskCompletedEvent
type
whose result
property contains the result object.
After that the received event is dispatched to listeners of this task.
If a response is succesfully received and parsed, the result is assigned to the
lastResult
property of this task.
Parameters
parameters:SpatialOverlayParameters — Parameters of the task.
| |
responder:IResponder (default = null ) — A responder to call on result or fault.
|
AsyncToken — Asynch token associated with the response.
|
name | Constant |
public static const name:String = SpatialOverlay
Task name.