| Package | com.esri.baserver.tasks.reports |
| Class | public final class SummarizePointsTask |
| Inheritance | SummarizePointsTask  BAServerTask BATask AbstractTask flash.events.EventDispatcher |
This task allows you to take point data (e.g. customer data) in Community Analyst along with any associated volumetric data and sum that data up to any boundary layer (e.g. Census Tracts). For example, if you needed to see the distribution of the sales data associated with your customer points across the ZIP Codes in your market, this endpoint would allow you to see total sales associated with each ZIP Code of your interest. It would perform this function by automatically selecting all the points which fall into each ZIP Code and then summing up the selected fields to each ZIP Code boundary.
The result of this task is a TaskResultOutput object,
which is compatible with ArcGIS Server's mapping APIs. FeatureSet, MapImage, and an array of
ReportInfo objects can be returned depending on the task output options requested.
The array of ReportInfo items if returned contains the single report.
Additionally, the output analysis layer and/or report 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 Summarize Points task. | SummarizePointsTask | ||
| 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 | ||
|---|---|---|---|
SummarizePointsTask(urlOrClient:Object = null)
Creates a new instance of the SummarizePointsTask class. | SummarizePointsTask | ||
Creates a new command encapsulating this task and the given parameters. | SummarizePointsTask | ||
execute(parameters:SummarizePointsParameters, responder:IResponder = null):AsyncToken
Sends a request for executing a Summarize Points task to the Business Analyst Server HTTP (REST) Service. | SummarizePointsTask | ||
| Constant | Defined By | ||
|---|---|---|---|
| name : String = SummarizePoints [static] Task name. | SummarizePointsTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:TaskResultOutput [read-only] The last result of executing the Summarize Points task.
public function get lastResult():TaskResultOutput| SummarizePointsTask | () | Constructor |
public function SummarizePointsTask(urlOrClient:Object = null)Creates a new instance of the SummarizePointsTask 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) |
See also
| createCommand | () | method |
public function createCommand(parameters:SummarizePointsParameters, commandName:String = null):BACommandCreates a new command encapsulating this task and the given parameters.
Parameters
parameters:SummarizePointsParameters — Parameters of a task to be executed.
| |
commandName:String (default = null) |
BACommand — A new command.
|
| execute | () | method |
public function execute(parameters:SummarizePointsParameters, responder:IResponder = null):AsyncTokenSends a request for executing a Summarize Points 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:SummarizePointsParameters — Parameters of the task.
| |
responder:IResponder (default = null) |
AsyncToken — Asynch token associated with the response.
|
| name | Constant |
public static const name:String = SummarizePointsTask name.