Packagecom.esri.baserver.tasks.reports
Classpublic final class BenchmarkReportTask
InheritanceBenchmarkReportTask Inheritance BAServerTask Inheritance BATask Inheritance AbstractTask Inheritance flash.events.EventDispatcher

The Benchmark Report task is a comparative report that benchmarks two or more trade areas based on selected volumetric data (typically demographic data).

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 numbers, percent, and index values.

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. Additionally, the output report can be stored to the Business Analyst Server repository.

See also

BenchmarkReportParameters
TaskResultOutput

Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BAServerTask
 Inheritedconcurrency : String
Value that indicates how to handle multiple calls to the same task.
AbstractTask
 InheriteddisableClientCaching : 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
 InheritedisFullErrorMessage : 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 Benchmark Report task.
BenchmarkReportTask
 InheritedproxyURL : String
The URL to proxy the request through.
AbstractTask
 InheritedrequestTimeout : Number
The request timeout in seconds.
AbstractTask
 InheritedshowBusyCursor : Boolean
If true, a busy cursor is displayed while a service is executing.
AbstractTask
 Inheritedtoken : String
Token for accessing a secure task.
AbstractTask
 InheritedtokenProvider : ITokenProvider
Provider responsible for updating the security token if the last one expires.
BATask
 Inheritedurl : String
URL of the task.
AbstractTask
Public Methods
 MethodDefined By
  
BenchmarkReportTask(urlOrClient:Object = null)
Creates a new instance of the BenchmarkReportTask class.
BenchmarkReportTask
  
createCommand(parameters:BenchmarkReportParameters, commandName:String = null):BACommand
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 Business Analyst Server HTTP (REST) Service.
BenchmarkReportTask
Events
 Event Summary Defined By
 Inherited
fault
The fault event is dispatched when an asynchronous execution of a Community Analyst Task fails.BATask
 Inherited
taskCompleted
The taskCompleted event is dispatched when an asynchronous execution of a Community Analyst Task successfully completes.BATask
Public Constants
 ConstantDefined By
  name : String = BenchmarkReport
[static] Task name.
BenchmarkReportTask
Property Detail
lastResultproperty
lastResult:TaskResultOutput  [read-only]

The last result of executing the Benchmark Report task.


Implementation
    public function get lastResult():TaskResultOutput
Constructor Detail
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 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.

Parameters
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

BAServerClient
Method Detail
createCommand()method
public function createCommand(parameters:BenchmarkReportParameters, commandName:String = null):BACommand

Creates a new command encapsulating this task and the given parameters.

Parameters

parameters:BenchmarkReportParameters — Parameters of a task to be executed.
 
commandName:String (default = null) — Command name.

Returns
BACommand — A new command.
execute()method 
public function execute(parameters:BenchmarkReportParameters, responder:IResponder = null):AsyncToken

Sends a request for executing a Benchmark Report 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:BenchmarkReportParameters — Parameters of the task.
 
responder:IResponder (default = null) — A responder to call on result or fault.

Returns
AsyncToken — Asynch token associated with the response.
Constant Detail
nameConstant
public static const name:String = BenchmarkReport

Task name.




© 2011 Esri, Inc. All rights reserved.

Mon Dec 12 2011, 10:44 AM -08:00