MapperFilters Class

Creates the collection, setting the base type to MapperFilter.

Creates the collection, setting the base type to MapperFilter.

The number of elements actually contained in the ArrayList.

Gets debug information for this filter. To append to DebugInfo use AddDebugInfo(String). DebugInfo can help a developer determine where a filter was added and what its purpose is. See DebugInfo for debug information on individual MapperFilter items. Note that this information is currently visible only in the debugger.

Used to track whether the any filter within the collection has changed. If cleared, the Dirty flag is cleared on all filters in the collection. When set, the collection's Dirty flag is set, but the Dirty flags of the individual filters are not affected.

Determines whether or not the collection contains an enabled (not Disabled) PK filter.

true if the ArrayList has a fixed size; otherwise, false. The default is false.

Returns true if the collection is read-only. (Default is false)

true if access to the internal ArrayList is synchronized (thread-safe); otherwise, false. The default is false.

Indexer for this collection.

Indexer for this collection.

The filters have been modified and should override whatever filtering is being carried by the mapper in its internal state. This property is primarily intended for internal use by IFilterControl components such as the SearchBar.

Gets the RowKey from the collection where the collection has at least one filter marked PK that IsActive and has a non-null/empty FieldValue.

An object that can be used to synchronize access to the ArrayList.

The filters collection's localized text collection. This is intended for internal use only.

Adds a MapperFilter to the collection

Adds an object to the collection. Override. This method simply calls the Add method with CollectionAddFlags.replace as the flags.

Adds a MapperFilter object to the collection.

Simple way to add a SQL filter CLAUSE to the collection.

Adds an item to the collection

Adds an item to the collection at the specified index. To append an item use -1 or the collection item count as the index.

Append debug information to this collection's DebugInfo text. Note that this information is currently visible only in the debugger.

Creates a new RowKey MapperFilter and adds it to the collection. The filter is built by calling the provided mapper's RowKeyFilter(String) and passing the mapper's RowKey. See CreateRowKeyFilter(String, String, String) for more details on a RowKey filter.

Creates a new RowKey MapperFilter and adds it to the collection. See CreateRowKeyFilter(String, String, String) for more details on a RowKey filter.

Clears the collection

Clears all filters having any of the specified FilterFlags set.

Clears all filters not having any of the specified FilterFlags set.

Creates a copy of the object and returns it.

Determines whether an element is in the collection.

Determine if a particular SQL filter clause is already present in the collection.

Checks for the existence of an item in the hashtable

Copies the entire ArrayList to a compatible one-dimensional Array, starting at the beginning of the target array.

Creates an instance of the collection. If metadata caching is enabled, this method retrieves an instance from the global cache and creates a clone of the object. If metadata caching is enabled and the object isn't yet cached, this method caches the object.

Creates an instance of the collection. If metadata caching is enabled, this method retrieves an instance from the global cache and creates a clone of the object. If metadata caching is enabled and the object isn't yet cached, this method caches the object.

Determines whether the specified Object is equal to the current Object.

Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

Returns an enumerator that can iterate through the ArrayList.

Returns the complete filter by combining filters in the collection according to provided GetFilterFlags. In general GetFilter(GetFilterFlags, IMapper) is preferred as it has improved handlng for NamedFilters. For testing for filter existence HasFilter(GetFilterFlags, FilterFlags) is preferred.

Returns the complete filter by combining filters in the collection according to provided GetFilterFlags and resolving any filters marked FutureEval (which requires the IMapper. For testing for filter existence HasFilter(GetFilterFlags, FilterFlags) is preferred.

Serves as a hash function for a particular type.

Returns an item that matches the specified string index

Returns an item that matches the specified string index

Returns the name of the item.

Inspects the filters collection for filters marked Parent and extracts the row key value (FieldValue) associated with each such filter. Some Parent filters may not have non-null/empty 'values' associated with them. If multiple Parent filters with non-null/empty values are found, then, arbitrarily, one of the values will be returned, but the fact is devlogged.

Inspects the filters collection for filters marked PK and extracts the row key value (FieldValue) associated with each such filter. Some PK filters may not have non-null/empty 'values' associated with them. If multiple PK filters with non-null/empty values are found, then, arbitrarily, one of the values will be returned, but the fact is devlogged.

Construct a detailed description for the entire collection of filters.

Calculates a short description for the entire collection of applied filters.

Calculates a short description for the entire collection of applied filters per the provided FilterDescOptions.

Gets the Type of the current instance.

Determines the existence of one or more relevant filters in the collection according to provided GetFilterFlags. Note that use of HasFilter(GetFilterFlags, FilterFlags) is preferred over GetFilter(GetFilterFlags) when testing for the existence of filtering.

Returns the zero-based index of the first occurrence of an object in the internal ArrayList or in a portion of it.

Returns the index of the item in the collection (by key)

Inserts an element into the internal ArrayList at the specified index

Determine the current dirty state of the collection and all MapperFilter items in it.

Returns true if the item is marked for deletion.

Verifies the item is an acceptable type. Generally this is a test like "return (item is [class]);".

Loads the collection from the xmt_filters table.

Creates a shallow copy of the current Object.

Recalculates the internal hash

Removes the first occurrence of a specific object from the collection

Remove the specified item from the collection.

Removes the element at the specified index

Removes the properties marked for deletion.

Removes the element at the specified index

Set the dirty state of the collection and possibly all items in it.

Sets an item's value at the specified index.

Sets an item's value at the string index indicated by the parameters.

Sort the list by its key value.

Sort the collection using the provided comparer.

Splits a string of zero or more filter or description clauses that were munged using ClauseSeparator. Generally the munged string will have been created by calling either GetFilter(GetFilterFlags) or GetLongDesc(GetFilterFlags) and passing the UseSeparator flag.

Obtain a MapperFilters collection with a subset of this collection's MapperFilter filters where each has all the specified flags set. For example, just ForUser to get all user-applied filters.

Get a string describing these filters and appropriate for use as a toolbar description.

Construct the complete filter from this collection.

Construct the complete filter from this collection (per GetFilterFlags flags).

Truncate the array starting at the specified index.

Called when the collection is cleared allowing a derived class to clean up.

Used in conjuntion with UseSeparator to allow multiple filters to be combined into one string that can be split back into its constituent clauses. Munged filters/description are typically created by passing this flag to GetFilter(GetFilterFlags) or GetLongDesc(GetFilterFlags) and later separated using SplitClauses(String).

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.