| Package | com.esri.baserver.tasks.segmentation |
| Class | public final class ProfileByAreaSummationTask |
| Inheritance | ProfileByAreaSummationTask  BAServerTask BATask AbstractTask flash.events.EventDispatcher |
Use this task when you want to create a segmentation profile based on a polygon layer. Segmentation profiles can be created for any polygon feature class, such as trade areas, study areas, and standard geography units in Community Analyst.
Suppose you want to create a Customer Tapestry Profile Report for a set of customers around a given store location. In Community Analyst, you can create a customer derived trade area using the locations of each customer in relation to the store location. For example, you could create a trade area that represents the closest 80 percent of the customers around the store location. This type of trade area is often referred to as the store's primary trade area. Once the trade area is created, you can use the Profile by Area Summation task to create a segmentation profile of the primary market area. This profile will be used as the base segmentation profile for comparison with the target segmentation profile created from your customers from using the Profile by Table Geocoding task.
The result of this task is a new Tapestry segmentation profile which is primarily used as a base segmentation profile in other segmentation tasks. Additionally, the resulting segmentation profile 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 : ProfileData [read-only]
The last result of executing the Profile by Area Summation task. | ProfileByAreaSummationTask | ||
| 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 | ||
|---|---|---|---|
ProfileByAreaSummationTask(urlOrClient:Object = null)
Creates a new instance of the ProfileByAreaSummationTask class. | ProfileByAreaSummationTask | ||
Creates a new command encapsulating this task and the given parameters. | ProfileByAreaSummationTask | ||
execute(parameters:ProfileByAreaSummationParameters, responder:IResponder = null):AsyncToken
Sends a request for executing a Profile by Area Summation task to the Business Analyst Server HTTP (REST) Service. | ProfileByAreaSummationTask | ||
| Constant | Defined By | ||
|---|---|---|---|
| name : String = ProfileByAreaSummation [static] Task name. | ProfileByAreaSummationTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:ProfileData [read-only] The last result of executing the Profile by Area Summation task.
public function get lastResult():ProfileData| ProfileByAreaSummationTask | () | Constructor |
public function ProfileByAreaSummationTask(urlOrClient:Object = null)Creates a new instance of the ProfileByAreaSummationTask 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:ProfileByAreaSummationParameters, commandName:String = null):BACommandCreates a new command encapsulating this task and the given parameters.
Parameters
parameters:ProfileByAreaSummationParameters — Parameters of a task to be executed.
| |
commandName:String (default = null) |
BACommand — A new command.
|
| execute | () | method |
public function execute(parameters:ProfileByAreaSummationParameters, responder:IResponder = null):AsyncTokenSends a request for executing a Profile by Area Summation 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:ProfileByAreaSummationParameters — Parameters of the task.
| |
responder:IResponder (default = null) |
AsyncToken — Asynch token associated with the response.
|
| name | Constant |
public static const name:String = ProfileByAreaSummationTask name.