Click or drag to resize

FilterHelper Class

A helper class use for mapper (and possibly other) filtering. The class includes support for filtering keyword localization.
Inheritance Hierarchy
SystemObject
  NetQuarryFilterHelper

Namespace:  NetQuarry
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public class FilterHelper

The FilterHelper type exposes the following members.

Constructors
  NameDescription
Public methodFilterHelper
Initializes a new instance of the FilterHelper class
Top
Properties
  NameDescription
Public propertyAnd
Gets the FilterKeyword AND conjunction keyword descriptor.
Public propertyBetween
Gets the FilterKeyword BETWEEN conjunction keyword descriptor.
Public propertyKeywords
Gets the FilterKeyword keyword collection.
Public propertyMillionsSymbol
Gets the localized millions symbol ("m" in English).
Public propertyNot
Gets the FilterKeyword negation keyword descriptor.
Public propertyNull
Gets the FilterKeyword NULL keyword. At this time the NULL keyword is specifically used for identifying null values in a picklist, for example filtering on a field with a priority picklist using filter text like "high or low or null". This is distinct from the standard null filtering outside of picklists which uses the IsNull keyword to reduce the probably of inadvertant null filtering when actually looking for normal text.
Public propertyOr
Gets the FilterKeyword OR conjunction keyword descriptor.
Public propertyPeriods
Gets the collection of localized TimePeriod objects.
Public propertyThousandsSymbol
Gets the localized thousands symbol ("k" in English).
Top
Methods
  NameDescription
Public methodDescription(String)
Get the localized description for the specified filter symbol.
Public methodDescription(String, FilterKeywordRules)
Get the localized description for the specified filter symbol with a preference for the specified data type.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetCascadedText
Get the specified localized text for this item. Obtaining the text is a cascading process from most specific to least specific always using the IDS as the id: 1) Look for the text item in the application's TextItems collection, 2) If not found, look for the item in the locale resource file, 3) If not found, use the provided defaultText.
Public methodStatic memberGetFilterHelper
Gets the filtering helper object to use. The filtering helper provides for filter keyword localization and provides various filtering utility methods. If a helper object already exists for the current culture then that existing object will be returned. If not, a new object will be created and initialized.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasConjunction
Determines if the specified string includes a conjunction operator and, if so, returns the type of FilterConjunction and the two subclauses.
Public methodInvert
Get the inverse operator the specific comparison.
Public methodLoad
Loads the helper's keywords including any localized text avaliable.
Public methodLookupSymbol
Look up a FilterKeyword keyword by its FilterSyms symbol.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodParseApprox
Attempt to parse a filter value for an approximation (+/- or =-) filter. Note that it is the responsibility of the caller to parse and apply the margin.
Public methodStartsWithKeyword
Determines if the specified string starts with a comparison operator and, if so, returns that operator and the search clause with the operator removed.
Public methodSymbolText
Gets the localized text for the specified FilterSyms symbol.
Public methodToFilterOp
Convert a filtering symbol (from FilterSyms) to its corresponding enumeration.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Top
See Also