Packagecom.esri.bacore
Classpublic final class SummarizationInfo

The SummarizationInfo class specifies properties of a summarization variable available in a Business Analyst data layer.

See also

com.esri.bao.tasks.utilities.GetSummarizationsTask
com.esri.baserver.tasks.utilities.GetSummarizationsTask


Public Properties
 PropertyDefined by
  alias : String
Summarization variable alias name.
SummarizationInfo
  avgBase : String
Field name for the denominator that is used to help calculate the average value of this variable for total households.
SummarizationInfo
  category : String
Summarization variable category.
SummarizationInfo
  decimals : Number
The number of decimal places after the decimal point for this variable.
SummarizationInfo
  indexBase : Number
Value of this variable for the whole US for the year.
SummarizationInfo
  longDescription : String
User-friendly summarization name.
SummarizationInfo
  name : String
Summarization variable name.
SummarizationInfo
  percentage : String
Field name for the denominator that is used to help calculate the percentage for this variable.
SummarizationInfo
Public Methods
 MethodDefined by
  
SummarizationInfo(name:String = null, alias:String = null, category:String = null, longDescription:String = null, decimals:Number = 0, percentage:String = null, avgBase:String = null, indexBase:Number = 0)
Creates a new instance of the SummarizationInfo object.
SummarizationInfo
Property detail
aliasproperty
alias:String  [read-write]

Summarization variable alias name.

Implementation
    public function get alias():String
    public function set alias(value:String):void
avgBaseproperty 
avgBase:String  [read-write]

Field name for the denominator that is used to help calculate the average value of this variable for total households. This property is used in Business Analyst Online API.

Implementation
    public function get avgBase():String
    public function set avgBase(value:String):void
categoryproperty 
category:String  [read-write]

Summarization variable category.

Implementation
    public function get category():String
    public function set category(value:String):void
decimalsproperty 
decimals:Number  [read-write]

The number of decimal places after the decimal point for this variable. This property is used in Business Analyst Online API.

Implementation
    public function get decimals():Number
    public function set decimals(value:Number):void
indexBaseproperty 
indexBase:Number  [read-write]

Value of this variable for the whole US for the year. This property is used in Business Analyst Online API.

Implementation
    public function get indexBase():Number
    public function set indexBase(value:Number):void
longDescriptionproperty 
longDescription:String  [read-write]

User-friendly summarization name.

Implementation
    public function get longDescription():String
    public function set longDescription(value:String):void
nameproperty 
name:String  [read-write]

Summarization variable name.

Implementation
    public function get name():String
    public function set name(value:String):void
percentageproperty 
percentage:String  [read-write]

Field name for the denominator that is used to help calculate the percentage for this variable. This property is used in Business Analyst Online API.

Implementation
    public function get percentage():String
    public function set percentage(value:String):void
Constructor detail
SummarizationInfo()constructor
public function SummarizationInfo(name:String = null, alias:String = null, category:String = null, longDescription:String = null, decimals:Number = 0, percentage:String = null, avgBase:String = null, indexBase:Number = 0)

Creates a new instance of the SummarizationInfo object.

Parameters
name:String (default = null) — Summarization variable name.
 
alias:String (default = null) — Summarization variable alias name.
 
category:String (default = null) — Summarization variable category.
 
longDescription:String (default = null) — User-friendly summarization name.
 
decimals:Number (default = 0) — The number of decimal places after the decimal point for this variable.
 
percentage:String (default = null) — Field name for the denominator that is used to help calculate the percentage for this variable.
 
avgBase:String (default = null) — Field name for the denominator that is used to help calculate the average value of this variable for total households.
 
indexBase:Number (default = 0) — Value of this variable for the whole US for the year.