C++ Client API Reference for Oracle Coherence: CacheEventFilter Class Reference

Detailed Description

MapEventFilter

Author:

rhl 2013.04.10

Public Types

typedef spec::Handle

Handle

CacheEventFilter Handle definition.

typedef spec::View

View

CacheEventFilter View definition.

typedef spec::Holder

Holder

CacheEventFilter Holder definition.

Public Member Functions

virtual bool

evaluate (Object::View v) const

Apply the test to the object.

Parameters:

the object to test

Returns:: true if the test passes, false otherwise

virtual void

readExternal (PofReader::Handle hIn)

virtual void

writeExternal (PofWriter::Handle hOut) const

virtual bool

equals (Object::View v) const

virtual size32_t

hashCode () const

Return a hash code value for the Object.

This method is supported for the benefit of hash-based containers.

The general contract of hashCode is:

Whenever it is invoked on the same Object more than once during an execution of an application, the hashCode method must consistently return the same value, provided no information used in equals comparisons on the object is modified. This value need not remain consistent from one execution of an application to another execution of the same application.
If two Objects are equal according to the equals method, then calling the hashCode method on each of the two Objects must produce the same value.
It is not required that if two Objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct results. However, the programmer should be aware that producing distinct results for unequal objects may improve the performance of hash-based containers.

The default implementation is identity based.

Returns:: a hash code value for this Object

virtual String::View

getDescription () const

Return a human-readable description of the state of this class in the form of a delimited list of name-value pairs.

The default implementation returns an empty string

Static Public Attributes

static const int32_t

e_synthetic

Bitmask to select synthetic events.

static const int32_t

e_natural

Bitmask to select natural events.

Protected Member Functions

CacheEventFilter ()

Default constructor (necessary for the PortableObject interface).

CacheEventFilter (int32_t nMask, int32_t nMaskSynthetic)

Construct a CacheEventFilter that evaluates MapEvent objects based on the specified combination of event types.

CacheEventFilter (Filter::View vFilter, int32_t nMaskSynthetic)

Construct a CacheEventFilter that evaluates MapEvent objects that would affect the results of a keySet filter issued by a previous call to coherence::util::QueryMap::keySet(coherence::util::Filter::View).

CacheEventFilter (int32_t nMask, Filter::View vFilter, int32_t nMaskSynthetic)

Construct a CacheEventFilter that evaluates MapEvent objects based on the specified combination of event types.

Protected Attributes

int32_t

m_nMaskSynthetic

Bitmask that selects whether to include synthetic, natural, or all events.

Constructor & Destructor Documentation

CacheEventFilter	(	int32_t	nMask,
		int32_t	nMaskSynthetic
	)			`[protected]`

Construct a CacheEventFilter that evaluates MapEvent objects based on the specified combination of event types.

Parameters:

	vFilter	the filter passed previously to a keySet() query method
	nMaskSynthetic	any combination of e_synthetic and e_natural

CacheEventFilter	(	Filter::View	vFilter,
		int32_t	nMaskSynthetic
	)			`[protected]`

It is possible to easily implement continuous query functionality.

Using this constructor is equivalent to: CacheEventFilter::create(e_keyset, vFilter, nMaskSynthetic);

Parameters:

	vFilter	the filter passed previously to a keySet() query method
	nMaskSynthetic	any combination of e_synthetic and e_natural

CacheEventFilter	(	int32_t	nMask,
		Filter::View	vFilter,
		int32_t	nMaskSynthetic
	)			`[protected]`

Construct a CacheEventFilter that evaluates MapEvent objects based on the specified combination of event types.

Parameters:

	nMask	any combination of e_inserted, e_updated, e_deleted, e_updated_entered, e_updated_within, and e_updated_left
	vFilter	the filter passed previously to a keySet() query method
	nMaskSynthetic	any combination of e_synthetic and e_natural