MapperFilter Class

A MapperFilter is a specification for filtering an IMapper query. In almost all cases a MapperFilter is a SQL filter clause (a WHERE clause without the keyword WHERE) stored in Clause. One exception to this is Full-Text Search filters (FTS) which have a null/empty Clause and store their filter information in FullTextSearchValue.

These filters are applied to a mapper in order to restrict the set of records obtained when the IMapper requeries. Individual filters are replaceable, updateable, and removeable. Typically each filter provides a different type of functionality such as security (ForSecurity), user filtering (ForUser) and often with separate filters for each field criterium.

Inheritance Hierarchy

SystemObject
NetQuarry.DataMapperFilter

Namespace: NetQuarry.Data
Assembly: EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)

Syntax

Copy

public class MapperFilter : ICloneable, 
	IEAPBase

Public Class MapperFilter
	Implements ICloneable, IEAPBase

The MapperFilter type exposes the following members.

Constructors

	Name	Description
	MapperFilter	Constructs a new instance of the object.
	MapperFilter(String, String)	Constructs a new instance of the object.
	MapperFilter(String, String, FilterFlags)	Constructs a new instance of the object.
	MapperFilter(String, String, String)	Constructs a new instance of the object.
	MapperFilter(String, String, String, String)	Constructs a new instance of the object.
	MapperFilter(String, String, String, String, String)	Constructs a new instance of the object.
	MapperFilter(String, String, String, String, String, FilterFlags)	Constructs a new instance of the object.

Top

Properties

	Name	Description
	Attributes	Gets/Sets the MapperFilterAttrs from the metadata.
	Caption	Gets or sets the caption for the filter.
	Clause	Gets or sets the filter's SQL clause.
	CommandId	Gets/sets the command associated with this filter.
	Creator	Gets or sets the creator of the filter (typically a UserID).
	DebugInfo	Gets/sets debug information for this filter. DebugInfo can help a developer determine where a filter was added and what its purpose is. See DebugInfo for debug information on a MapperFilters collection. Note that this information is currently visible only in the debugger.
	Dirty	Gets or sets a flag indicating whether the filter has been modified.
	FieldKey	Gets or sets the IField.Value value from which the filter was built.
	FieldValue	The Value value from which the filter was built.
	Flags	Gets/Sets FilterFlags flags specifying additional information about the filter.
	FullTextSearchValue	Gets/sets the Full-Text Search (FTS) search value(s).
	ID	Gets/Sets the filter's ID.
	IsActive	Gets whether or not the filter is active (i.e. should generally be applied). For example, a filter marked Disabled will not be active. More complicated rules apply to filters marked Removeable.
	LongDesc	Gets or sets the long description for a filter.
	Name	Gets or sets the name of the filter.
	NamedFilter	Gets/Sets the named filter.
	Order	Gets or Sets the filter's order.
	Properties	The Properties collection of Property objects for this object.
	ShortDesc	Gets or sets the short description for the filter.
	TextItems	Gets the TextItems collection for this filter.
	Version	Gets/sets the version of this object's assembly.

Top

Methods

	Name	Description
	AddClause(String, Boolean)	Append an additional filter clause to this filter. The clause is added with a SQL AND or OR conjunction as specified.
	AddClause(IField, String, Int32)	Add a filter clause as generated by the specified field for the specified value. The operator should be prepended to the value (per FieldFilterFlags.OperandInValue).
	Clone	Make a copy (clone) of the filter.
	CreateRowKeyFilter	Creates a RowKey filter. Typically a RowKey filter is built by calling a mapper's RowKeyFilter(String) and passing the RowKey. RowKey filters are marked with PK and should include the RowKey in the filter's FieldValue.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Exec	The Exec method provides extended functionality.
	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.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	EqualValue	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

Remarks

Typically the MapperFilter objects are managed by the IMapper.Filters, a MapperFilters collection. The collection's GetFilter(GetFilterFlags) method is responsible for combining multiple filter clauses into a single functional SQL WHERE clause. You can use HasFilter(GetFilterFlags, FilterFlags) to determine if any filtering, or certain type(s) of filtering, is in effect.

Reference

NetQuarry.Data Namespace

NetQuarry.DataMapperFilters

NetQuarry.DataIMapper

IMapperFilters