Creates a new geocode comparison filter.
Namespace:
Endeca.DataAssembly: Endeca.Data (in Endeca.Data.dll) Version: 2.1.3.0 (2.1.3.622)
Syntax
C# |
---|
public static RangeFilter CreateGeocodeComparisonRangeFilter( string attributeName, RangeFilterOperator rangeOperator, Geocode geocode, double bound1 ) |
Visual Basic (Declaration) |
---|
Public Shared Function CreateGeocodeComparisonRangeFilter ( _ attributeName As String, _ rangeOperator As RangeFilterOperator, _ geocode As Geocode, _ bound1 As Double _ ) As RangeFilter |
Visual C++ |
---|
public: static RangeFilter^ CreateGeocodeComparisonRangeFilter( String^ attributeName, RangeFilterOperator rangeOperator, Geocode^ geocode, double bound1 ) |
Parameters
- attributeName
- Type: System..::.String
The attribute (i.e. property or dimension) that this filter acts upon.
- rangeOperator
- Type: Endeca.Data..::.RangeFilterOperator
Describes the comparison operation for this filter.
- geocode
- Type: Endeca.Data..::.Geocode
The reference geocode for this filter.
- bound1
- Type: System..::.Double
The bound for the comparison operation.
Remarks
This filter will include records for which the geocode value of the record attribute
identified by the attributeName parameter, when evaluated relative to the specified reference
geocode, is greater than or less than the value specified by the bound1
parameter.
Exceptions
Exception | Condition |
---|---|
System..::.ArgumentNullException | if geocode is null. |
System..::.ArgumentException | if attributeName is null or empty, or if if rangeOperator is not one of GeocodeLessThan, GeocodeGreaterThan. |