| Package | com.esri.bao.tasks.stdgeographies |
| Class | public final class StdGeographiesByAttributesTask |
| Inheritance | StdGeographiesByAttributesTask  BAOnlineTask BATask AbstractTask flash.events.EventDispatcher |
Features/areas in the Community Analyst data layers are often identified by standardized FIPS codes. Alternatively, they may be identified in the Community Analyst data layers by some other ID. Standard Geographies by Attributes can be used to look up these IDs.
Some applications of Standard Geographies by Attributes include the following:
The result of this task is an array of StdGeographiesFeature items containing all of the feature/area names and their corresponding IDs that satisfy the string-based query on the data layer. After looking up these IDs, they may be used to specify one or more geographic features/areas in a Summary Reports analysis using the StandardLayer as the value for the Boundaries parameter.
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 : Array [read-only]
The last result of executing the Standard Geographies by Attributes task. | StdGeographiesByAttributesTask | ||
| 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 | ||
|---|---|---|---|
StdGeographiesByAttributesTask(urlOrClient:Object = null)
Creates a new instance of the StdGeographiesByAttributesTask class. | StdGeographiesByAttributesTask | ||
Creates a new command encapsulating this task and the given parameters. | StdGeographiesByAttributesTask | ||
execute(parameters:StdGeographiesByAttributesParameters, responder:IResponder = null):AsyncToken
Sends a request for executing a Standard Geographies by Attributes task to the Community Analyst HTTP (REST) Service. | StdGeographiesByAttributesTask | ||
| Method | Defined By | ||
|---|---|---|---|
resultHandler(asyncToken:AsyncToken):void [override] | StdGeographiesByAttributesTask | ||
| Constant | Defined By | ||
|---|---|---|---|
| name : String = report/StdGeographiesByAttributes [static] Task name. | StdGeographiesByAttributesTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:Array [read-only] The last result of executing the Standard Geographies by Attributes task. This array contains items of the StdGeographiesFeature type.
public function get lastResult():ArraySee also
| StdGeographiesByAttributesTask | () | Constructor |
public function StdGeographiesByAttributesTask(urlOrClient:Object = null)Creates a new instance of the StdGeographiesByAttributesTask 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:StdGeographiesByAttributesParameters, commandName:String = null):BACommandCreates a new command encapsulating this task and the given parameters.
Parameters
parameters:StdGeographiesByAttributesParameters — Parameters of a task to be executed.
| |
commandName:String (default = null) |
BACommand — A new command.
|
| execute | () | method |
public function execute(parameters:StdGeographiesByAttributesParameters, responder:IResponder = null):AsyncTokenSends a request for executing a Standard Geographies by Attributes 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:StdGeographiesByAttributesParameters — 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/StdGeographiesByAttributesTask name.