Package | com.esri.bao.tasks.thematicmapping |
Class | public class ThematicMappingQueryTask |
Inheritance | ThematicMappingQueryTask Object |
Implements | IQueryTask, IBATask, IBADatasetParameters |
IQueryTask
facade for
a task executing a Community Analyst thematic mapping query.
See also
Property | Defined By | ||
---|---|---|---|
activeDatasetID : String
Active dataset ID. | ThematicMappingQueryTask | ||
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. | ThematicMappingQueryTask | ||
initializeSummarizations : Boolean
Whether request summarization variables or not while initialization this task. | ThematicMappingQueryTask | ||
proxyURL : String
The URL to proxy the request through. | ThematicMappingQueryTask | ||
requestTimeout : Number
The request timeout in seconds. | ThematicMappingQueryTask | ||
summarizations : TMSummarizations
Summarization variables available for the current account. | ThematicMappingQueryTask | ||
token : String
Token for accessing a secure HTTP client. | ThematicMappingQueryTask | ||
tokenProvider : ITokenProvider
Provider responsible for updating the security token if the last one expires. | ThematicMappingQueryTask | ||
url : String
The base URL to the Community Analyst HTTP Service. | ThematicMappingQueryTask |
Method | Defined By | ||
---|---|---|---|
ThematicMappingQueryTask(client:BAOnlineClient = null)
Creates a new instance of the ThematicMappingQueryTask class. | ThematicMappingQueryTask | ||
execute(layerInfo:IGeographyLayerInfo, query:Query, responder:IResponder):Boolean
Executes the given query for the given layer if the layer is owned by this task. | ThematicMappingQueryTask | ||
initialize(responder:IResponder):void
Initializes the query task. | ThematicMappingQueryTask |
activeDatasetID | property |
activeDatasetID:String
Active dataset ID. Null value means the default Community Analyst dataset.
The default value is null
.
public function get activeDatasetID():String
public function set activeDatasetID(value:String):void
disableClientCaching | property |
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.
The default value is false
.
public function get disableClientCaching():Boolean
public function set disableClientCaching(value:Boolean):void
initializeSummarizations | property |
initializeSummarizations:Boolean
Whether request summarization variables or not while initialization this task.
The default value is true
.
public function get initializeSummarizations():Boolean
public function set initializeSummarizations(value:Boolean):void
proxyURL | property |
proxyURL:String
The URL to proxy the request through.
public function get proxyURL():String
public function set proxyURL(value:String):void
requestTimeout | property |
requestTimeout:Number
The request timeout in seconds. A value less than or equal to zero prevents request timeout.
The default value is -1
.
public function get requestTimeout():Number
public function set requestTimeout(value:Number):void
summarizations | property |
summarizations:TMSummarizations
Summarization variables available for the current account.
Bu default, summarization variables are populated when this task is initialized.
You can avoid requesting summarization variables while initialization either
assigning the false value to the initializeSummarizations
property or
assigning a custom collection of summarization variables to this property.
public function get summarizations():TMSummarizations
public function set summarizations(value:TMSummarizations):void
token | property |
token:String
Token for accessing a secure HTTP client.
public function get token():String
public function set token(value:String):void
tokenProvider | property |
tokenProvider:ITokenProvider
Provider responsible for updating the security token if the last one expires.
public function get tokenProvider():ITokenProvider
public function set tokenProvider(value:ITokenProvider):void
url | property |
url:String
The base URL to the Community Analyst HTTP Service.
public function get url():String
public function set url(value:String):void
ThematicMappingQueryTask | () | Constructor |
public function ThematicMappingQueryTask(client:BAOnlineClient = null)
Creates a new instance of the ThematicMappingQueryTask 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.
client:BAOnlineClient (default = null ) — A variable containing either Community Analyst HTTP Service base URL string or an
instance of the BAOnlineClient class.
|
See also
execute | () | method |
public function execute(layerInfo:IGeographyLayerInfo, query:Query, responder:IResponder):Boolean
Executes the given query for the given layer if the layer is owned by this task.
This task is an owner of layers that were returned by the initialize
method
in geography levels and it is also an owner of copies of these layers created with the
IGeographyLayerInfo.createCopy
method.
Before executing the query, the method tests that this task owns the given geography layer. If not, the query task doesn't executed.
Parameters
layerInfo:IGeographyLayerInfo — A geography layer to execute query on.
| |
query:Query — A query to execute.
| |
responder:IResponder — A responder to handle query results.
|
Boolean — True if the query task is started.
|
initialize | () | method |
public function initialize(responder:IResponder):void
Initializes the query task.
Parameters
responder:IResponder — A responder to handle initialization results.
|