PriorityFilter Class

Oracle® Fusion Middleware .NET API Reference for Oracle Coherence
14c (14.1.1.0)
F23534-02

PriorityFilter is used to explicitly control the scheduling priority and timeouts for execution of filter-based methods.

Inheritance Hierarchy

SystemObject
Tangosol.NetAbstractPriorityTask
Tangosol.Util.FilterPriorityFilter

Namespace: Tangosol.Util.Filter
Assembly: Coherence (in Coherence.dll) Version: 14.1.1.14 (14.1.1.14)

Syntax

Copy

public class PriorityFilter : AbstractPriorityTask, 
	IIndexAwareFilter, IEntryFilter, IFilter

The PriorityFilter type exposes the following members.

Constructors

	Name	Description
	PriorityFilter	Default constructor.
	PriorityFilter(IIndexAwareFilter)	Construct a PriorityFilter.

Top

Properties

	Name	Description
	ExecutionTimeoutMillis	The maximum amount of time this task is allowed to run before the corresponding service will attempt to stop it. (Inherited from AbstractPriorityTask.)
	Filter	Obtain the underlying filter.
	RequestTimeoutMillis	The maximum amount of time a calling thread is willing to wait for a result of the request execution. (Inherited from AbstractPriorityTask.)
	SchedulingPriority	This task's scheduling priority. (Inherited from AbstractPriorityTask.)

Top

Methods

	Name	Description
	ApplyIndex	Filter remaining keys using an IDictionary of available indexes.
	CalculateEffectiveness	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.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Evaluate	Apply the test to the object.
	EvaluateEntry	Apply the test to an ICacheEntry.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (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.)
	ReadExternal	Restore the contents of a user type instance by reading its state using the specified IPofReader object. (Overrides AbstractPriorityTaskReadExternal(IPofReader).)
	RunCanceled	This method will be called if and only if all attempts to interrupt this task were unsuccesful in stopping the execution or if the execution was canceled before it had a chance to run at all. (Inherited from AbstractPriorityTask.)
	ToString	Return a human-readable description for this PriorityFilter. (Overrides ObjectToString.)
	WriteExternal	Save the contents of a POF user type instance by writing its state using the specified IPofWriter object. (Overrides AbstractPriorityTaskWriteExternal(IPofWriter).)

Top

Remarks

For example, let's assume that there is a cache that belongs to a partitioned cache service configured with a request-timeout and task-timeout of 5 seconds. Also assume that we are willing to wait longer for a particular rarely executed parallel query that does not employ any indexes. Then we could override the default timeout values by using the PriorityFilter as follows:

Copy

LikeFilter     filterStandard = new LikeFilter("GetComments", "%fail%");
PriorityFilter filterPriority = new PriorityFilter(filterStandard);
filterPriority.ExecutionTimeoutMillis = PriorityTaskTimeout.None;
filterPriority.RequestTimeoutMillis   = PriorityTaskTimeout.None;
ICollection entries = cache.GetEntries(filterPriority);

This is an advanced feature which should be used judiciously.

Reference

Tangosol.Util.Filter Namespace