Oracle Fusion Middleware C++ API Reference for Oracle Coherence
12c (12.1.2)
E26041-01

coherence::util::MapListenerSupport::FilterEvent

MapListenerSupport::FilterEvent Class Reference

#include <coherence/util/MapListenerSupport.hpp>

Inherits CacheEvent.

List of all members.

Detailed Description

An extension of the CacheEvent which may carry no values (old or new), but instead holds an array of Filter objects being the "cause" of the event.

Public Types

typedef spec::Handle Handle

FilterEvent Handle definition.

typedef spec::View View

FilterEvent View definition.

typedef spec::Holder Holder

FilterEvent Holder definition.

Public Member Functions

virtual ObjectArray::View getFilter () const

Return an array of filters that are the cause of this event.

virtual void setEvent (MapEvent::View vEvent)

Set the event that this FilterEvent wraps.

virtual void outputDescription (std::ostream &out) const

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

Generally it is also advisable to start with a call to super::outputDescription(out)

The default implementation does not output anything to the stream.

Parameters:

out

the stream to output the description to

virtual Object::View getKey () const

Return a key associated with this event.

Returns:: a key

virtual Object::View getOldValue () const

Return an old value associated with this event.

The old value represents a value deleted from or updated in a map. It is always NULL for "insert" notifications.

Returns:: an old value

virtual Object::View getNewValue () const

Return a new value associated with this event.

The new value represents a new value inserted into or updated in a map. It is always NULL for "delete" notifications.

Returns:: a new value

virtual bool containsFilter (Filter::View vFilter) const

Determine if this filter event contains a specified filter.

Protected Member Functions

FilterEvent (ObservableMap::Handle hMap, int32_t nId, Object::View vKey, Object::View vValueOld, Object::View vValueNew, bool fSynthetic, ObjectArray::View vaFilters)

Create a new FilterEvent with no old and new values.

FilterEvent (ObservableMap::Handle hMap, int32_t nId, Object::View vKey, Object::View vValueOld, Object::View vValueNew, bool fSynthetic, TransformationState nTransformState, ObjectArray::View vaFilters)

Create a new FilterEvent with no old and new values.

Protected Attributes

FinalView< ObjectArray > f_vaFilters

Filters which caused the event.

FinalView< MapEvent > f_vEvent

Optional wrapped MapEvent.

Constructor & Destructor Documentation

FilterEvent	(	ObservableMap::Handle	hMap,
		int32_t	nId,
		Object::View	vKey,
		Object::View	vValueOld,
		Object::View	vValueNew,
		bool	fSynthetic,
		ObjectArray::View	vaFilters
	)			`[protected]`

Create a new FilterEvent with no old and new values.

Parameters:

	hMap	the map on which the Event initially occurred
	nId	the events id (entry_inserted \| entry_updated \| entry_deleted)
	vKey	the key into the map
	fSynthetic	true iff the event is caused by internal cache processing such as eviction or loading
	vaFilters	an array of Filters that caused this event.

FilterEvent	(	ObservableMap::Handle	hMap,
		int32_t	nId,
		Object::View	vKey,
		Object::View	vValueOld,
		Object::View	vValueNew,
		bool	fSynthetic,
		TransformationState	nTransformState,
		ObjectArray::View	vaFilters
	)			`[protected]`

Create a new FilterEvent with no old and new values.

Parameters:

	hMap	the map on which the Event initially occurred
	nId	the events id (entry_inserted \| entry_updated \| entry_deleted)
	vKey	the key into the map
	fSynthetic	true iff the event is caused by internal cache processing such as eviction or loading
	nTransformState	the state describing how this event has been or should be transformed
	vaFilters	an array of Filters that caused this event.

Member Function Documentation

virtual ObjectArray::View getFilter ( ) const [virtual]

Return an array of filters that are the cause of this event.

Returns:: an array of filters

virtual void setEvent ( MapEvent::View vEvent ) [virtual]

Set the event that this FilterEvent wraps.

Parameters:

vEvent

the wrapped event

Since:: Coherence 3.7.1.8

virtual bool containsFilter ( Filter::View vFilter ) const [virtual]

Determine if this filter event contains a specified filter.

Parameters:

vFilter

the filter to search for

Returns:: true if the event contained the specified filter, false otherwise

Member Data Documentation

FinalView<MapEvent> f_vEvent [protected]

Optional wrapped MapEvent.

Since:: Coherence 3.7.1.8

The documentation for this class was generated from the following file:

coherence/util/MapListenerSupport.hpp

Copyright © 2000, 2013, Oracle and/or its affiliates. All rights reserved.