A FilterCompare is a type of IFilter
that performs a value comparison.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class FilterCompare : IFilter, IQueryNode
Public Class FilterCompare _ Implements IFilter, IQueryNode
public ref class FilterCompare : IFilter, IQueryNode
Members| All Members | Constructors | Methods | Properties | Fields | |
| Icon | Member | Description |
|---|---|---|
 | FilterCompareFilterCompareNew(String, FilterCompare..::FilterCompareOp, String) |
Creates a new FilterCompare object.
|
  | DVAL |
DVAL operator.
|
| EQ |
EQUAL TO operator.
|
| Equals(Object) | (Inherited from Object.) |
 | FieldName |
Gets and sets the fieldName for this FilterCompare.
|
 | Finalize()() | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| Function |
Gets and sets the comparison function for this FilterCompare.
|
| GetHashCode()() | Serves as a hash function for a particular type. GetHashCode()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
| GetType()() | Gets the Type of the current instance. (Inherited from Object.) |
| GT |
GREATER THAN operator.
|
| GTE |
GREATER THAN OR EQUAL TO operator.
|
| IS_NOT_NULL |
NON-NULL operator.
|
| IS_NULL |
NULL operator.
|
| LT |
LESS THAN operator.
|
| LTE |
LESS THAN OR EQUAL TO operator.
|
| MemberwiseClone()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| NEQ |
NOT EQUAL TO operator.
|
| ToString()() |
Returns the string form of this FilterCompare.
(Overrides Object.ToString()().) |
| ToWire()() |
Returns the wire form of this FilterCompare.
|
| ValidateSyntax()() |
Validates the syntax of this FilterCompare.
|
| Value |
Gets and sets the value for this FilterCompare.
|
Remarks
After being created, the FilterCompare object
is then set in a Statement object with the
HavingFilter or WhereFilter
methods.
A FilterCompare can also be used to determine if the value of an Endeca property or dimension is null or non-null.
Examples
A typical use of this class is to compare the
value of an Endeca property or dimension to a
specified literal value. This can be considered
as a programmatic equivalent of the SQL HAVING
and WHERE clauses. For example, this
text-based syntax snippet:
CopyC#
can be expressed programmatically as:
CopyC#
CopyC#RETURN Reps AS WHERE Region = 'West'
CopyC#Statement reps = new Statement(); reps.Name = "Reps"; FilterCompare whFilter = new FilterCompare("Region", FilterCompare.EQ, "West"); reps.WhereFilter = whFilter;
Inheritance Hierarchy| Object | |
 | FilterCompare |