Packagecom.esri.bacore.domain
Classpublic class StringPatternProperties
InheritanceStringPatternProperties Inheritance Object

Since : Business Analyst API for Flex 3.0.

The StringPatternProperties class provides properties for creation string patterns.



Public Properties
 PropertyDefined By
  allowWildcard : Boolean
Allow wildcard symbol in string patterns or not.
StringPatternProperties
  caseInsensitive : Boolean
Need a case insensitive comparison with string patterns or not.
StringPatternProperties
  separator : String
Separator used for parsing a string into patterns and for conversion of summarization tags to a string.
StringPatternProperties
Public Methods
 MethodDefined By
  
StringPatternProperties(separator:String, caseInsensitive:Boolean, allowWildcard:Boolean = false)
Creates a new instance of the StringPatternProperties class.
StringPatternProperties
  
[static] Updates string pattern creation properties from attributes of a XML element.
StringPatternProperties
Property Detail
allowWildcardproperty
allowWildcard:Boolean

Allow wildcard symbol in string patterns or not.

The default value is true.


Implementation
    public function get allowWildcard():Boolean
    public function set allowWildcard(value:Boolean):void
caseInsensitiveproperty 
caseInsensitive:Boolean

Need a case insensitive comparison with string patterns or not.

The default value is false.


Implementation
    public function get caseInsensitive():Boolean
    public function set caseInsensitive(value:Boolean):void
separatorproperty 
separator:String

Separator used for parsing a string into patterns and for conversion of summarization tags to a string.

The default value is ';'.


Implementation
    public function get separator():String
    public function set separator(value:String):void
Constructor Detail
StringPatternProperties()Constructor
public function StringPatternProperties(separator:String, caseInsensitive:Boolean, allowWildcard:Boolean = false)

Creates a new instance of the StringPatternProperties class.

Parameters
separator:String — Separator used for parsing a string into patterns and for conversion of summarization tags to a string.
 
caseInsensitive:Boolean — Need a case insensitive comparison with string patterns or not.
 
allowWildcard:Boolean (default = false) — Allow wildcard symbol in string patterns or not.
Method Detail
updatePropertiesFromXML()method
public static function updatePropertiesFromXML(xml:XML, properties:StringPatternProperties = null):StringPatternProperties

Updates string pattern creation properties from attributes of a XML element.

This function tests the input XML element to have the following attributes: "separator", "caseInsensitive", and "allowWildcard". If any of these attributes is found, a new instance of StringPatternProperties is created from the input properties, its properties are updated with values of corresponding XML attributes, and this new instance is returned. Otherwise, the input instance of the properties is returned.

Parameters

xml:XML — XML element whose attributes are used for updating.
 
properties:StringPatternProperties (default = null) — Properties to be updated.

Returns
StringPatternProperties — Updated properties or input properties.