Package | com.esri.baserver.tasks.stdgeographies |
Class | public class StdGeographiesFromTreeParameters |
Inheritance | StdGeographiesFromTreeParameters BAUtilityParameters BABaseParameters Object |
A geography level is selected using the branchID
and depth
parameters.
The branchID
specifies a branch of the tree of standard geography levels
(e.g. "USbyTracts", "USbyCounties", or "USbyZIP5") and the depth
specifies the
geography level depth for the given branch (e.g. the level depth in "USbyZIP5" branch is
0 for whole USA, 1 for States, 2 for Counties, and 3 for ZIPs).
The criterion
and idCriterion
parameters specify the criteria
for search in locations' name and ID fields, respectively. If both criteria are specified,
the geography locations are searched in the standard geography level using the logical AND operation.
If both criteria are missing, all locations of the standard geography level are queried.
The returned feature list represents the complete list of children of all matching locations
from the specified geography level.
See also
Property | Defined By | ||
---|---|---|---|
activeDatasetID : String
Active dataset ID. | BAUtilityParameters | ||
branchID : String
The ID of branch in the tree of standard geography levels (required). | StdGeographiesFromTreeParameters | ||
criterion : String
A string to search in names of geography locations. | StdGeographiesFromTreeParameters | ||
depth : int
Depth of the geography level in the given branch (required). | StdGeographiesFromTreeParameters | ||
idCriterion : String
A string to search in IDs of geography locations. | StdGeographiesFromTreeParameters | ||
resultType : BAResultType [read-only]
Type of a result returned by the task associated with these parameters. | BABaseParameters | ||
taskName : String [read-only]
Name of a Business Analyst Server task associated with these parameters. | BABaseParameters |
Method | Defined By | ||
---|---|---|---|
Creates a new instance of the StdGeographiesFromTreeParameters class. | StdGeographiesFromTreeParameters |
branchID | property |
branchID:String
The ID of branch in the tree of standard geography levels (required). The tree could be retrieved with Standard Geographies Tree task.
public function get branchID():String
public function set branchID(value:String):void
See also
criterion | property |
criterion:String
A string to search in names of geography locations.
public function get criterion():String
public function set criterion(value:String):void
depth | property |
depth:int
Depth of the geography level in the given branch (required).
public function get depth():int
public function set depth(value:int):void
idCriterion | property |
idCriterion:String
A string to search in IDs of geography locations.
public function get idCriterion():String
public function set idCriterion(value:String):void
StdGeographiesFromTreeParameters | () | Constructor |
public function StdGeographiesFromTreeParameters()
Creates a new instance of the StdGeographiesFromTreeParameters class.
var parameters : StdGeographiesFromTreeParameters = new StdGeographiesFromTreeParameters(); // Set an ID of branch in the tree of standard geography levels. parameters.branchID = "USbyZIP5"; // Set a depth of the geography level in the given branch. This is the US Counties level. parameters.depth = 2; // Set a string to search in names of geography locations. This is the San Diego County. parameters.criterion = "San Diego"; // Execute the task. The result will be a list of all ZIP5 codes of the San Diego County. stdGeographiesFromTreeTask.execute(parameters, new Responder(resultHandler, faultHandler));