Packagecom.esri.bacore
Classpublic class SummarizationTags
InheritanceSummarizationTags Inheritance Object

Since : Community Analyst API for Flex 2.2.

The SummarizationTags class provides a collection of tags such as keywords or group names associated with a summarization variable.

See also

SummarizationInfo


Public Properties
 PropertyDefined By
  count : uint
[read-only] The number of available tags.
SummarizationTags
Public Methods
 MethodDefined By
  
SummarizationTags(tags:Array = null)
Creates a new instance of the SummarizationTags class.
SummarizationTags
  
fromString(tagList:String, delimiter:String):SummarizationTags
[static] Splits the input string into a collection of tags.
SummarizationTags
  
getTag(index:uint):String
Gets a tag with the given index.
SummarizationTags
  
hasTag(tag:String, caseInsensitive:Boolean = false):Boolean
Tests the given tag to belong this collection of tag.
SummarizationTags
  
toString(delimiter:String):String
Joins tags into a string.
SummarizationTags
Property Detail
countproperty
count:uint  [read-only]

The number of available tags.


Implementation
    public function get count():uint
Constructor Detail
SummarizationTags()Constructor
public function SummarizationTags(tags:Array = null)

Creates a new instance of the SummarizationTags class.

Parameters
tags:Array (default = null) — An array of string tags.
Method Detail
fromString()method
public static function fromString(tagList:String, delimiter:String):SummarizationTags

Splits the input string into a collection of tags.

Parameters

tagList:String — The input string containing a list of tags (null value is allowed).
 
delimiter:String — Tags delimiter in the input string (default = ";").

Returns
SummarizationTags — A new collection of tags.
getTag()method 
public function getTag(index:uint):String

Gets a tag with the given index.

Parameters

index:uint — Zero-based index of tag.

Returns
String — The required tag.
hasTag()method 
public function hasTag(tag:String, caseInsensitive:Boolean = false):Boolean

Tests the given tag to belong this collection of tag.

Parameters

tag:String — A tag to compare.
 
caseInsensitive:Boolean (default = false) — Specifies to perform a case insensitive compare, true, or not, false.

Returns
Boolean — True value if the tag has been found in this collection.
toString()method 
public function toString(delimiter:String):String

Joins tags into a string.

Parameters

delimiter:String — Tags delimiter in the output string (default = ";").

Returns
String — String representation of tags.