Click or drag to resize

LimitFilter Class

Oracle® Fusion Middleware .NET API Reference for Oracle Coherence
14c (14.1.1.0)
F23534-02
IFilter which truncates the results of another filter.
Inheritance Hierarchy
SystemObject
  Tangosol.Util.FilterLimitFilter

Namespace:  Tangosol.Util.Filter
Assembly:  Coherence (in Coherence.dll) Version: 14.1.1.14 (14.1.1.14)
Syntax
C#
Copy
public class LimitFilter : IIndexAwareFilter, 
	IEntryFilter, IFilter, IPortableObject

The LimitFilter type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyBottomAnchor
Gets or sets the bottom anchor object, which is the last value object on the current page.
Public propertyComparer
Gets or sets the IComparer used to partition the entry values into pages.
Public propertyCookie
Gets or sets the cookie object.
Public propertyFilter
Gets the IFilter whose results are truncated by this filter.
Public propertyPage
Gets or sets current page number (zero-based).
Public propertyPageSize
Gets or sets the page size (expressed as a number of entries per page).
Public propertyTopAnchor
Gets or sets the top anchor object, which is the last value object on a previous page.
Top
Methods
  NameDescription
Public methodApplyIndex
Filter remaining keys using an IDictionary of available indexes.
Public methodCalculateEffectiveness
Given an IDictionary of available indexes, determine if this IIndexAwareFilter can use any of the indexes to assist in its processing, and if so, determine how effective the use of that index would be.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEvaluate
Apply the test to the object.
Public methodEvaluateEntry
Apply the test to an ICacheEntry.
Public methodExtractPage(ICollection)
Extract a subset of the specified set to fit the filter's parameters (i.e. page size and page number).
Public methodExtractPage(IEnumerator)
Extract a subset of the specified iterator to fit the filter's parameters (i.e. page size and page number).
Public methodExtractPage(Object)
Extract a subset of the specified array to fit the filter's parameters (i.e. page size and page number).
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNextPage
Switch to the next page.
Public methodPreviousPage
Switch to the previous page.
Public methodReadExternal
Restore the contents of a user type instance by reading its state using the specified IPofReader object.
Public methodToString
Return a human-readable description for this LimitFilter.
(Overrides ObjectToString.)
Public methodWriteExternal
Save the contents of a POF user type instance by writing its state using the specified IPofWriter object.
Top
Remarks
This filter is a mutable object that is modified by the query processor. Clients are supposed to hold a reference to this filter and repetitively pass it to query methods after setting a desired page context.
See Also