| Package | com.esri.bao.tasks.reports |
| Class | public final class BenchmarkReportTask |
| Inheritance | BenchmarkReportTask  BAOnlineTask BATask AbstractTask flash.events.EventDispatcher |
This task allows you to compare multiple trade areas against one another to decipher how different or similar one location is over the next. You can easily measure the demographic characteristics of one area versus all other areas. The report shows statistical differences in raw number, percent, and index values.
The benchmarks can only be made on variables that exist in all trade areas being compared. Variables and trade areas can be shown in either rows or columns. When benchmarking all trade areas against a single trade area, the average or the median of all the trade areas can be calculated and used as the benchmark.
The result of this task is a TaskResultOutput object,
which is compatible with ArcGIS Server's mapping APIs.
The output report is specified as a single item of the array of ReportInfo objects.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BAOnlineTask | |
| 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 | |
| lastResult : TaskResultOutput [read-only]
The last result of executing the Benchmark Report task. | BenchmarkReportTask | ||
| 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 | ||
|---|---|---|---|
BenchmarkReportTask(urlOrClient:Object = null)
Creates a new instance of the BenchmarkReportTask class. | BenchmarkReportTask | ||
Creates a new command encapsulating this task and the given parameters. | BenchmarkReportTask | ||
execute(parameters:BenchmarkReportParameters, responder:IResponder = null):AsyncToken
Sends a request for executing a Benchmark Report task to the Community Analyst HTTP (REST) Service. | BenchmarkReportTask | ||
| Method | Defined By | ||
|---|---|---|---|
resultHandler(asyncToken:AsyncToken):void [override] | BenchmarkReportTask | ||
| Constant | Defined By | ||
|---|---|---|---|
| name : String = report/BenchmarkReport [static] Task name. | BenchmarkReportTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:TaskResultOutput [read-only] The last result of executing the Benchmark Report task.
public function get lastResult():TaskResultOutput| BenchmarkReportTask | () | Constructor |
public function BenchmarkReportTask(urlOrClient:Object = null)Creates a new instance of the BenchmarkReportTask class.
A new task can be constructed in two ways: as a task sharing a BAOnlineClient type instance
with other tasks (the urlOrClient parameter has the BAOnlineClient type) or
as a standalone task encapsulating its own client.
The base URL to the Community Analyst Web Services looks as follows:
http://{host}:{port}
The {host} and {port} parameters in this URL should be substituted with
valid Community Analyst host name and port, respectively.
If urlOrClient is null, the "http://baoapi.esri.com" value is assigned as the base URL.
urlOrClient:Object (default = null) |
See also
| createCommand | () | method |
public function createCommand(parameters:BenchmarkReportParameters, commandName:String = null):BACommandCreates a new command encapsulating this task and the given parameters.
Parameters
parameters:BenchmarkReportParameters — Parameters of a task to be executed.
| |
commandName:String (default = null) |
BACommand — A new command.
|
| execute | () | method |
public function execute(parameters:BenchmarkReportParameters, responder:IResponder = null):AsyncTokenSends a request for executing a Benchmark Report task to the Community Analyst 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:BenchmarkReportParameters — Parameters of the task.
| |
responder:IResponder (default = null) |
AsyncToken — Asynch token associated with the response.
|
| resultHandler | () | method |
override protected function resultHandler(asyncToken:AsyncToken):voidParameters
asyncToken:AsyncToken |
| name | Constant |
public static const name:String = report/BenchmarkReportTask name.