Packagecom.esri.bacore.domain
Classpublic class GroupingRulesFilter
InheritanceGroupingRulesFilter Inheritance SummarizationFilter Inheritance Object

Since : Community Analyst API for Flex 2.2.

The GroupingRulesFilter class implements a grouping filter configured with XML.



Public Methods
 MethodDefined By
  
GroupingRulesFilter(compareFunction:Function = null)
Creates a new instance of the GroupingRulesFilter class.
GroupingRulesFilter
 Inherited
getGroupings(summarizations:Array):Array
Gets an array of groupings available for the input array of summarization variables.
SummarizationFilter
  
initialize(xml:XML):void
Initializes the filter from XML.
GroupingRulesFilter
  
match(grouping:String, summarization:SummarizationInfo):Boolean
[override] Tests the summarization variable to belong to the given grouping.
GroupingRulesFilter
Constructor Detail
GroupingRulesFilter()Constructor
public function GroupingRulesFilter(compareFunction:Function = null)

Creates a new instance of the GroupingRulesFilter class.

Parameters
compareFunction:Function (default = null) — A comparison function to sort grouping values.
Method Detail
initialize()method
public function initialize(xml:XML):void

Initializes the filter from XML.

Parameters

xml:XML — XML to initialize the filter with.

match()method 
override public function match(grouping:String, summarization:SummarizationInfo):Boolean

Tests the summarization variable to belong to the given grouping.

Parameters

grouping:String — Name of grouping.
 
summarization:SummarizationInfo — Summarization valiable.

Returns
Boolean — True if the variable belongs to the given grouping.