Packagecom.esri.bacore.domain
Classpublic class SummarizationTagsFilter
InheritanceSummarizationTagsFilter Inheritance SummarizationFilter Inheritance Object

Since : Community Analyst API for Flex 2.2.

The SummarizationTagsFilter class implements a grouping filter extracting the group values from tags of the SummarizationInfo type.


Public Methods
 MethodDefined By
  
SummarizationTagsFilter(compareFunction:Function = null, tagsPropertyName:String = groups)
Creates a new instance of the SummarizationTagsFilter class.
SummarizationTagsFilter
 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 groupings property of the given summarization variable to contain the grouping parameter.
SummarizationTagsFilter
Constructor Detail
SummarizationTagsFilter()Constructor
public function SummarizationTagsFilter(compareFunction:Function = null, tagsPropertyName:String = groups)

Creates a new instance of the SummarizationTagsFilter class.

Parameters
compareFunction:Function (default = null) — A comparison function to sort grouping values.
 
tagsPropertyName:String (default = groups) — The name of property of SummarizationInfo whose tags will be used for grouping filter (possible values are "keywords" and "groups").
Method Detail
match()method
override public function match(grouping:String, summarization:SummarizationInfo):Boolean

Tests the groupings property of the given summarization variable to contain the grouping parameter.

Parameters

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

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



© 2011 Esri, Inc. All rights reserved.

Mon Dec 12 2011, 10:44 AM -08:00