| Package | com.esri.baserver.tasks.stdgeographies |
| Class | public class ThematicMappingQueryTask |
| Inheritance | ThematicMappingQueryTask  Object |
| Implements | IQueryTask, IBATask, IBADatasetParameters |
IQueryTask facade for
a task executing a Business Analyst Server thematic mapping query.
See also
| Property | Defined By | ||
|---|---|---|---|
| activeDatasetID : String
Active dataset ID. | ThematicMappingQueryTask | ||
| dataHierarchy : String
Name of a data hierarchy used for summarization. | 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 | ||
| isFullErrorMessage : Boolean
Produce an error message with stack trace (true) or without stack trace (false). | ThematicMappingQueryTask | ||
| proxyURL : String
The URL to proxy the request through. | ThematicMappingQueryTask | ||
| requestTimeout : Number
The request timeout in seconds. | 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 Business Analyst Server HTTP Service. | ThematicMappingQueryTask | ||
| Method | Defined By | ||
|---|---|---|---|
ThematicMappingQueryTask(urlOrClient:Object = null)
Creates a new instance of the ThematicMappingQueryTask class. | ThematicMappingQueryTask | ||
createGeographyLayerInfo(geoLevelId:String, name:String, generalizationLevel:int, scale:Number, idField:String, nameField:String):IGeographyLayerInfo
Creates a new geography layer info object owned by this task. | ThematicMappingQueryTask | ||
execute(layerInfo:IGeographyLayerInfo, query:Query, responder:IResponder):Boolean
Executes a 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:StringActive dataset ID. Null value means the default Business Analyst Server dataset which is the first dataset in the dataset list is used.
The default value is null.
public function get activeDatasetID():String public function set activeDatasetID(value:String):void| dataHierarchy | property |
dataHierarchy:String| Since : | Community Analyst API for Flex 2.2. |
Name of a data hierarchy used for summarization. If this property value is null or empty, the default data hierarchy is used. List of available data hierarchies can be retrieved with Get Data Hierarchies task.
public function get dataHierarchy():String public function set dataHierarchy(value:String):voidSee also
| disableClientCaching | property |
disableClientCaching:BooleanIf 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| isFullErrorMessage | property |
isFullErrorMessage:BooleanProduce an error message with stack trace (true) or without stack trace (false).
public function get isFullErrorMessage():Boolean public function set isFullErrorMessage(value:Boolean):void| proxyURL | property |
proxyURL:StringThe URL to proxy the request through.
public function get proxyURL():String public function set proxyURL(value:String):void| requestTimeout | property |
requestTimeout:NumberThe 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| token | property |
token:StringToken for accessing a secure HTTP client.
public function get token():String public function set token(value:String):void| tokenProvider | property |
tokenProvider:ITokenProviderProvider 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:StringThe base URL to the Business Analyst Server HTTP Service.
public function get url():String public function set url(value:String):void| ThematicMappingQueryTask | () | Constructor |
public function ThematicMappingQueryTask(urlOrClient:Object = null)Creates a new instance of the ThematicMappingQueryTask 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
| createGeographyLayerInfo | () | method |
public function createGeographyLayerInfo(geoLevelId:String, name:String, generalizationLevel:int, scale:Number, idField:String, nameField:String):IGeographyLayerInfoCreates a new geography layer info object owned by this task.
Parameters
geoLevelId:String — ID of a standard geography level to find geography features in.
| |
name:String — Display name of this layer.
| |
generalizationLevel:int — Generalization of a standard geography level to find geography features in.
| |
scale:Number — Maximum scale value the layer supports.
| |
idField:String — Name of field representing a feature ID.
| |
nameField:String — Name of field representing a feature name.
|
IGeographyLayerInfo — A new geography layer info object.
|
| execute | () | method |
public function execute(layerInfo:IGeographyLayerInfo, query:Query, responder:IResponder):BooleanExecutes a 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
createGeographyLayerInfo method and copies of 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):voidInitializes the query task.
Parameters
responder:IResponder — A responder to handle initialization results.
|