| Package | com.esri.bacore.thematicmapping |
| Class | public class TMQueryTaskProvider |
| Inheritance | TMQueryTaskProvider  Object |
| Implements | IQueryTask |
Query tasks specified with this provider are logically composed into one query task.
Their initialization result lists of GeographyLevelInfo items are merged into one list.
When the composed query task is executed, it redirects the execution to the particular query task which
owns the geography layer passed in parameters of the execute method.
See also
| Property | Defined By | ||
|---|---|---|---|
| isReadOnly : Boolean [read-only]
True value indicates that the list of query tasks for this provider is read-only. | TMQueryTaskProvider | ||
| queryTasksCount : int [read-only]
The number of query tasks associated with this layer. | TMQueryTaskProvider | ||
| Method | Defined By | ||
|---|---|---|---|
Initializes a new instance of the TMQueryTaskProvider class. | TMQueryTaskProvider | ||
addQueryTask(queryTask:IQueryTask):void
Adds a query task to this provider. | TMQueryTaskProvider | ||
execute(layerInfo:IGeographyLayerInfo, query:Query, responder:IResponder):Boolean
Executes a query for the given geography layer. | TMQueryTaskProvider | ||
getQueryTask(index:int):IQueryTask
Gets a query task by its index. | TMQueryTaskProvider | ||
initialize(responder:IResponder):void
Initializes the query tasks associated with this provider. | TMQueryTaskProvider | ||
| isReadOnly | property |
isReadOnly:Boolean [read-only] True value indicates that the list of query tasks for this provider is read-only.
public function get isReadOnly():Boolean| queryTasksCount | property |
queryTasksCount:int [read-only] The number of query tasks associated with this layer.
public function get queryTasksCount():int| TMQueryTaskProvider | () | Constructor |
public function TMQueryTaskProvider()Initializes a new instance of the TMQueryTaskProvider class.
| addQueryTask | () | method |
public function addQueryTask(queryTask:IQueryTask):voidAdds a query task to this provider.
This operation is available while this provider doesn't initialized. On initialization, the list of query tasks becomes read-only, and an attempt to add a query task after initialization throws an exception.
Parameters
queryTask:IQueryTask — A query task.
|
| execute | () | method |
public function execute(layerInfo:IGeographyLayerInfo, query:Query, responder:IResponder):BooleanExecutes a query for the given geography layer.
The query task provider at first validates the geography layer. If this layer doesn't recognized by any query task specified in its list, the false value is returned. Otherwise, an appropriate query task starts executing query and the true value is returned.
An instance of the BATaskCompletedEvent type is
passed to the responder.result method.
Parameters
layerInfo:IGeographyLayerInfo — A geography layer to execute query on.
| |
query:Query — A query to execute.
| |
responder:IResponder — Async responder to handle query results.
|
Boolean — True if the query task is started.
|
See also
| getQueryTask | () | method |
public function getQueryTask(index:int):IQueryTaskGets a query task by its index.
Parameters
index:int — Zero-based index of query task.
|
IQueryTask — The required query task.
|
| initialize | () | method |
public function initialize(responder:IResponder):voidInitializes the query tasks associated with this provider.
An instance of the BATaskCompletedEvent type is
passed to the responder.result method.
If more than one query task is specified for this provider, all of them are initialized and their result lists are merged into one list which is passed to the method.
Parameters
responder:IResponder |
See also