coherence::util::filter::PriorityFilter

PriorityFilter Class Reference

#include <coherence/util/filter/PriorityFilter.hpp>

Inherits AbstractPriorityTask, and EntryFilter.

List of all members.

Detailed Description

Base Filter implementation for doing extractor-based processing.

Author:
djl 2008.03.02

Public Types

typedef spec::Handle Handle
 PriorityFilter Handle definition.
typedef spec::View View
 PriorityFilter View definition.
typedef spec::Holder Holder
 PriorityFilter Holder definition.

Public Member Functions

virtual bool evaluateEntry (Map::Entry::View vEntry) const
 Apply the test to a Map::Entry.

Parameters:
vEntry the Map::Entry to evaluate; never NULL
Returns:
true if the test passes, false otherwise

virtual bool evaluate (Object::View v) const
 Apply the test to the object.

Parameters:
v 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 void toStream (std::ostream &out) const
 Output a human-readable description of this Object to the given stream.

coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toStream method, to output Objects. If a manged String object is desired, the COH_TO_STRING macro can be used to build up a String from streamable contents.

 Object::View vKey   = ...
 Object::View vValue = ...
 std::cout << vKey << " = " << vValue << std::endl;

 String::Handle hs = COH_TO_STRING(vKey << " = " << vValue);

Parameters:
out the stream used to output the description

virtual EntryFilter::View getFilter () const
 Obtain the underlying filter.

Protected Member Functions

 PriorityFilter ()
 Default constructor (necessary for the PortableObject interface).
 PriorityFilter (EntryFilter::View vFilter)
 Construct a PriorityFilter.

Protected Attributes

MemberView< EntryFilter > m_vFilter
 The wrapped filter.

Constructor & Destructor Documentation

PriorityFilter ( EntryFilter::View  vFilter  )  [protected]

Construct a PriorityFilter.

Parameters:
vFilter the filter wrapped by this PriorityFilter

Member Function Documentation

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

Obtain the underlying filter.

Returns:
the filter wrapped by this PriorityFilter

The documentation for this class was generated from the following file: Copyright (c) 2000-2008 Oracle. All rights reserved.