Packagecom.esri.bacore
Classpublic class SummarizationInfo
InheritanceSummarizationInfo Inheritance Object

The SummarizationInfo class specifies properties of a summarization variable available for a Business Analyst data hierarchy.


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

Summarization variable alias name.


Implementation
    public function get alias():String
avgBaseproperty 
avgBase:String  [read-only]

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 the Business Analyst Online API.


Implementation
    public function get avgBase():String
categoryproperty 
category:String  [read-only]

Summarization variable category.


Implementation
    public function get category():String
decimalsproperty 
decimals:Number  [read-only]

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


Implementation
    public function get decimals():Number
indexBaseproperty 
indexBase:Number  [read-only]

Value of this variable for the whole country for the year. Zero or NaN value for this property means missing index base. This property is used in the Business Analyst Online API.


Implementation
    public function get indexBase():Number
longDescriptionproperty 
longDescription:String  [read-only]

User-friendly summarization name.


Implementation
    public function get longDescription():String
nameproperty 
name:String  [read-only]

Summarization variable name.


Implementation
    public function get name():String
percentageproperty 
percentage:String  [read-only]

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


Implementation
    public function get percentage():String
valueTypeproperty 
valueType:BAValueType  [read-only]

Type of value of this variable.


Implementation
    public function get valueType():BAValueType
Constructor Detail
SummarizationInfo()Constructor
public function SummarizationInfo(name:String, alias:String, category:String, longDescription:String, decimals:Number, percentage:String = null, avgBase:String = null, indexBase:Number, valueType:BAValueType = null)

Creates a new instance of the SummarizationInfo object.

Parameters
name:String — Summarization variable name.
 
alias:String — Summarization variable alias name.
 
category:String — Summarization variable category.
 
longDescription:String — User-friendly summarization name.
 
decimals:Number (default = NaN) — 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 = NaN) — Value of this variable for the whole US for the year.
 
valueType:BAValueType (default = null) — Type of value of this variable.



© 2010 ESRI, Inc. All rights reserved.

Mon Dec 20 2010, 05:04 PM +06:00