Packagecom.esri.bacore.thematicmapping.extensionClasses
Classpublic class MatchValueFilter
InheritanceMatchValueFilter Inheritance Object
Implements IAttributesFilter

Since : Community Analyst API for Flex 2.2.

The MatchValueFilter class calculates a value using the given value calculator and tests it to match filter criteria.


Public Properties
 PropertyDefined By
  calculator : ValueCalculator
[read-only] Value calculator associated with this filter.
MatchValueFilter
  enabled : Boolean
Whether filter is enabled or not.
MatchValueFilter
  lowerBound : Number
The lower bound of the whole range of values.
MatchValueFilter
  maximumValue : Number
The maximum value for matching range of values.
MatchValueFilter
  minimumValue : Number
The minimum value for matching range of values.
MatchValueFilter
  upperBound : Number
The upper bound of the whole range of values.
MatchValueFilter
Public Methods
 MethodDefined By
  
MatchValueFilter(calculator:ValueCalculator)
Creates a new instance of the MatchValueFilter class.
MatchValueFilter
  
calculateBound(value:Number, isUpper:Boolean):Number
Calculates a bound by a value.
MatchValueFilter
  
round(value:Number):Number
Rounds the value to the number of digits after decimal point specified by decimals property of the associated value calculator.
MatchValueFilter
  
testAttributes(attributes:Object, attributesProvider:TMAttributesProvider, strictMatch:Boolean):AttributesFilterResult
Tests a value calculated for feature attributes to fit to the given range of values.
MatchValueFilter
  
testValue(value:Number, ignoreEnabled:Boolean = false):AttributesFilterResult
Tests a value to fit to the given range of values.
MatchValueFilter
Property Detail
calculatorproperty
calculator:ValueCalculator  [read-only]

Value calculator associated with this filter.


Implementation
    public function get calculator():ValueCalculator
enabledproperty 
enabled:Boolean

Whether filter is enabled or not.

The default value is true.


Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
lowerBoundproperty 
lowerBound:Number

The lower bound of the whole range of values.

If lowerBound is equal to minimumValue, the filter is considered unbounded from the bottom.


Implementation
    public function get lowerBound():Number
    public function set lowerBound(value:Number):void
maximumValueproperty 
maximumValue:Number

The maximum value for matching range of values. The Infinity means missing maximum value.


Implementation
    public function get maximumValue():Number
    public function set maximumValue(value:Number):void
minimumValueproperty 
minimumValue:Number

The minimum value for matching range of values. The -Infinity means missing minimum value.


Implementation
    public function get minimumValue():Number
    public function set minimumValue(value:Number):void
upperBoundproperty 
upperBound:Number

The upper bound of the whole range of values.

If upperBound is equal to maximumValue, the filter is considered unbounded from the bottom.


Implementation
    public function get upperBound():Number
    public function set upperBound(value:Number):void
Constructor Detail
MatchValueFilter()Constructor
public function MatchValueFilter(calculator:ValueCalculator)

Creates a new instance of the MatchValueFilter class.

Parameters
calculator:ValueCalculator — Value calculator to be associated with this filter.
Method Detail
calculateBound()method
public function calculateBound(value:Number, isUpper:Boolean):Number

Calculates a bound by a value.

The calculated bound is at first rounded to the number of digits after decimal point specified by decimals property of the associated value calculator. After that, the bound is moved up or down to the half of the last digit after the decimal point.

Parameters

value:Number — A value to calculate the bound for.
 
isUpper:Boolean — Whether this is an upper bound or lower bound.

Returns
Number — The required bound.
round()method 
public function round(value:Number):Number

Rounds the value to the number of digits after decimal point specified by decimals property of the associated value calculator.

Parameters

value:Number — A value to round.

Returns
Number — Rounded value.
testAttributes()method 
public function testAttributes(attributes:Object, attributesProvider:TMAttributesProvider, strictMatch:Boolean):AttributesFilterResult

Tests a value calculated for feature attributes to fit to the given range of values.

If the filter is disabled, AttributesFilterResult.MATCHES value is returned.

Parameters

attributes:Object — Attributes of a feature.
 
attributesProvider:TMAttributesProvider — Provider of feature attributes.
 
strictMatch:Boolean — This parameter is ignored in this filter.

Returns
AttributesFilterResult — Result of testing.
testValue()method 
public function testValue(value:Number, ignoreEnabled:Boolean = false):AttributesFilterResult

Tests a value to fit to the given range of values.

If the filter is disabled, AttributesFilterResult.MATCHES value is returned.

Parameters

value:Number — Value to test.
 
ignoreEnabled:Boolean (default = false) — Whether ignore enabled state or not.

Returns
AttributesFilterResult — Result of testing.



© 2011 Esri, Inc. All rights reserved.

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