| Package | com.esri.bao.tasks.utilities |
| Class | public class GetSummarizationsParameters |
| Inheritance | GetSummarizationsParameters  BAUtilityParameters BABaseParameters Object |
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BAUtilityParameters | |
| length : int
The maximum number of requested variables. | GetSummarizationsParameters | ||
| query : String
A query string filtering requested variables. | GetSummarizationsParameters | ||
| resultType : BAResultType [read-only]
Type of a result returned by the task associated with these parameters. | BABaseParameters | |
| start : int
Zero-based index of the first requested variable. | GetSummarizationsParameters | ||
| taskName : String [read-only]
Name of a Business Analyst Server task associated with these parameters. | BABaseParameters | |
| visibility : Array
Array of names of attributes of summarization variables to be requested. | GetSummarizationsParameters | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of the GetSummarizationsParameters class. | GetSummarizationsParameters | ||
| length | property |
Hide Inherited Public Properties
Show Inherited Public Propertieslength:intThe maximum number of requested variables. Negative value means requesting all remaining variables.
The default value is -1.
public function get length():int public function set length(value:int):void| query | property |
query:StringA query string filtering requested variables.
The query is specified using Lucene syntax. In the simple case, the string contains a search filter of the
form field-name:search-string where field-name is the name of the field to search
in and search-string is a string to search in the given field. For example,
"mappable:true" query will select variables whose "mappable" attribute is true.
The following properties of the SummarizationInfo class are searchable: "name", "alias", "category", "longDescription", and "mappable". The special Boolean "mappable" attribute describes an ability of using the variable in thematic mapping. To select variables that can be used in thematic mapping, use the "mappable:true" query.
public function get query():String public function set query(value:String):void| start | property |
start:intZero-based index of the first requested variable.
The default value is 0.
public function get start():int public function set start(value:int):void| visibility | property |
visibility:ArrayArray of names of attributes of summarization variables to be requested.
Using this parameter you can request only those attributes of summarization variables
which are necessary in your application. For example, ["name","alias"] value
of this parameter specifies that a name and an alias name of every summarization variable
will be received. You can also requiest a group of attributes using special group names:
| Value | Description |
|---|---|
"$all" | All attributes. |
"$id" | The "name" attribute. |
"$min" | The "name" and "alias" attributes. |
"$default" | The "name", "alias", "category", and "longDescription" attributes. |
"$thematic" | Attributes required for thematic mapping. |
If this array is empty, all attributes of summarization variables will be requested.
public function get visibility():Array public function set visibility(value:Array):void| GetSummarizationsParameters | () | Constructor |
public function GetSummarizationsParameters()Creates a new instance of the GetSummarizationsParameters class.
var parameters:GetSummarizationsParameters = new GetSummarizationsParameters();
// start and length parameters allow you to request variables partially.
// Default values of these parameters:
//parameters.start = 0;
//parameters.length = -1;
// query specifies a filter on variables to be returned.
// The query below requests variables which could be used in a thematic mapping layer.
//parameters.query = "mappable:true";
getSummarizationsTask.execute(parameters, new Responder(resultHandler, faultHandler));