Oracle Coherence for C++ API: ConditionalPutAll Class Reference

Detailed Description

ConditionalPutAll is an EntryProcessor that performs a InvocableMap::Entry::setValue Entry.setValue} operation for multiple entries that satisfy the specified condition.

Author:

tb 2008.04.28

Public Types

typedef spec::Handle

Handle

ConditionalPutAll Handle definition.

typedef spec::View

View

ConditionalPutAll View definition.

typedef spec::Holder

Holder

ConditionalPutAll Holder definition.

Public Member Functions

virtual Object::Holder

process (InvocableMap::Entry::Handle hEntry) const

Process a Map::Entry object.

Parameters:

hEntry

the Entry to process

Returns:: the result of the processing, if any

virtual Map::View

processAll (Set::View vsetEntries) const

Process a Set of InvocableMap::Entry objects.

This method is semantically equivalent to:

   Map::Handle hMapResults = HashMap::create();
   for (Iterator::Handle hIter = vSetEntries->iterator();
       iter->hasNext; )
       {
       InvocableMap::Entry::Handle hEntry =
               cast<InvocableMap::Entry::Handle>(hIter->next());
       hMapResults->put(hEntry->getKey(), process(hEntry));
       }
   return hMapResults;

Parameters:

vSetEntries

a Set of InvocableMap::Entry objects to process

Returns:: a Map containing the results of the processing, up to one entry for each InvocableMap::Entry that was processed, keyed by the keys of the Map that were processed, with a corresponding value being the result of the processing for each key

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

Protected Member Functions

ConditionalPutAll ()

Construct a ConditionalPutAll.

ConditionalPutAll (Filter::View vFilter, Map::View vMap)

Construct a ConditionalPutAll processor that updates an entry with a new value if and only if the filter applied to the entry evaluates to true.

Protected Attributes

MemberView< Filter >

m_vFilter

The underlying filter.

MemberView< Map >

m_vMap

Specifies the map of new values.

Constructor & Destructor Documentation

ConditionalPutAll	(	Filter::View	vFilter,
		Map::View	vMap
	)			`[protected]`

Construct a ConditionalPutAll processor that updates an entry with a new value if and only if the filter applied to the entry evaluates to true.

The new value is extracted from the specified map based on the entry's key.

Parameters:

	vFilter	the filter to evaluate all supplied entries
	vMap	a map of values to update entries with

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