| Package | com.esri.bacore.domain |
| Class | public class SummarizationFilter |
| Inheritance | SummarizationFilter  Object |
| Implements | ISummarizationFilter |
| Subclasses | GroupingRulesFilter, SummarizationTagsFilter, VintageFilter |
| Since : | Community Analyst API for Flex 2.2. |
The initializeGroupings and match methods are abstract. They should be
implemented in derived classes.
| Method | Defined By | ||
|---|---|---|---|
SummarizationFilter(compareFunction:Function = null)
Creates a new instance of the SummarizationFilter class. | SummarizationFilter | ||
getGroupings(summarizations:Array):Array
Gets an array of groupings available for the input array of summarization variables. | SummarizationFilter | ||
match(grouping:String, summarization:SummarizationInfo):Boolean
Tests the given summarization variable to belong to the given grouping. | SummarizationFilter | ||
| Method | Defined By | ||
|---|---|---|---|
initializeGroupings(summarizations:Array):Array
Initializes an array of groupings available for the input array of summarization variables. | SummarizationFilter | ||
| SummarizationFilter | () | Constructor |
public function SummarizationFilter(compareFunction:Function = null)Creates a new instance of the SummarizationFilter class.
The compareFunction is used
to sort names of groupings returned with the initializeGroupings method.
A comparison function should take two String arguments to compare.
compareFunction:Function (default = null) |
| getGroupings | () | method |
public function getGroupings(summarizations:Array):ArrayGets an array of groupings available for the input array of summarization variables.
This method at first gets available groupings with the initializeGroupings
method and then sorts groupings with the compareFunction function specified in the
constructor of this class. If the compareFunction function is missing, the groupings
are alphabetically sorted using case-insensitive comparison.
Parameters
summarizations:Array — Array of SummarizationInfo items.
|
Array — Array of String items containing names of available groupings.
|
See also
| initializeGroupings | () | method |
protected function initializeGroupings(summarizations:Array):ArrayInitializes an array of groupings available for the input array of summarization variables.
Parameters
summarizations:Array — Array of SummarizationInfo items.
|
Array — Array of String items containing names of available groupings.
|
See also
| match | () | method |
public function match(grouping:String, summarization:SummarizationInfo):BooleanTests the given summarization variable to belong to the given grouping. This method is abstract. It should be implemented in derived classes.
Parameters
grouping:String — Grouping name.
| |
summarization:SummarizationInfo — Summarization valiable.
|
Boolean — True if the variable belongs to the given group.
|