Packagecom.esri.baserver.tasks.utilities
Classpublic class GetSummarizationsParameters
InheritanceGetSummarizationsParameters Inheritance BAUtilityParameters Inheritance BABaseParameters Inheritance Object

The GetSummarizationsParameters class provides input parameters for the Get Summarizations task.

View the examples

See also

GetSummarizationsTask

Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BAUtilityParameters
  dataHierarchy : String
Name of a hierarchy of data layers whose summarization variables are requested.
GetSummarizationsParameters
  length : int
The maximum number of requested variables.
GetSummarizationsParameters
  query : String
A query string filtering requested variables.
GetSummarizationsParameters
 InheritedresultType : 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
 InheritedtaskName : 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
Public Methods
 MethodDefined By
  
GetSummarizationsParameters(dataHierarchy:String = null)
Creates a new instance of the GetSummarizationsParameters class.
GetSummarizationsParameters
Property Detail
dataHierarchyproperty
dataHierarchy:String

Name of a hierarchy of data layers whose summarization variables are requested. 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.


Implementation
    public function get dataHierarchy():String
    public function set dataHierarchy(value:String):void

See also

GetDataHierarchiesTask
lengthproperty 
length:int

The maximum number of requested variables. Negative value means requesting all remaining variables.

The default value is -1.


Implementation
    public function get length():int
    public function set length(value:int):void
queryproperty 
query:String

A 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, "category:CEX" query will select variables whose category property contains the "CEX" string (ignore case).

The following properties of the SummarizationInfo class are searchable: "name", "alias", "category", "longDescription", "vintage", "groups", and "keywords".


Implementation
    public function get query():String
    public function set query(value:String):void
startproperty 
start:int

Zero-based index of the first requested variable.

The default value is 0.


Implementation
    public function get start():int
    public function set start(value:int):void
visibilityproperty 
visibility:Array

Array 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:

ValueDescription
"$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.


Implementation
    public function get visibility():Array
    public function set visibility(value:Array):void
Constructor Detail
GetSummarizationsParameters()Constructor
public function GetSummarizationsParameters(dataHierarchy:String = null)

Creates a new instance of the GetSummarizationsParameters class.

Parameters
dataHierarchy:String (default = null) — Name of a hierarchy of data layers whose summarization variables are requested.
Examples
ActionScript to execute a Get Summarizations task: 
     
     var parameters:GetSummarizationsParameters = new GetSummarizationsParameters();
     
     // dataHierarchy is the name of a hierarchy of data layers whose summarization variables are requested.
     // "Standard Community Analyst Data" hierarchy is requested if this parameter is missing.
     //parameters.dataHierarchy = "Standard Community Analyst Data";
     
     // start and length parameters allow you to partially request summarization variables.
     // Default values of these parameters:
     //parameters.start = 0;
     //parameters.length = -1;
     
     // query specifies a filter on variables to be returned.
     // The query below requests for Consumer Expenditure variables:
     //parameters.query = "category:CEX"; 
     
     getSummarizationsTask.execute(parameters, new Responder(resultHandler, faultHandler));



© 2011 Esri, Inc. All rights reserved.

Mon Dec 12 2011, 10:44 AM -08:00