Packagecom.esri.bacore.domain
Classpublic class VintageFilter
InheritanceVintageFilter Inheritance SummarizationFilter Inheritance Object

Since : Community Analyst API for Flex 2.2.

The VintageFilter class implements a vintage filter extracting the vintage value from the SummarizationInfo.vintage property.



Public Methods
 MethodDefined By
  
VintageFilter(compareFunction:Function = null)
Creates a new instance of the VintageFilter class.
VintageFilter
 Inherited
getGroupings(summarizations:Array):Array
Gets an array of groupings available for the input array of summarization variables.
SummarizationFilter
  
match(grouping:String, summarization:SummarizationInfo):Boolean
[override] Tests the given summarization variable to have the vintage property equal to the grouping parameter.
VintageFilter
Protected Methods
 MethodDefined By
  
extractVintage(summarization:SummarizationInfo):String
Extracts the vintage value from the summarization.vintage property.
VintageFilter
Constructor Detail
VintageFilter()Constructor
public function VintageFilter(compareFunction:Function = null)

Creates a new instance of the VintageFilter class.

Parameters
compareFunction:Function (default = null) — A comparison function to sort vintage values.
Method Detail
extractVintage()method
protected function extractVintage(summarization:SummarizationInfo):String

Extracts the vintage value from the summarization.vintage property.

Parameters

summarization:SummarizationInfo — Summarization variable.

Returns
String — The vintage value.
match()method 
override public function match(grouping:String, summarization:SummarizationInfo):Boolean

Tests the given summarization variable to have the vintage property equal to the grouping parameter.

Parameters

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

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