ArrayFilter Class Reference

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

Inherits Object, EntryFilter, and PortableObject.

Inherited by AllFilter, AnyFilter, and XorFilter.

List of all members.


Detailed Description

Filter which is a logical operator of a filter array.

Author:
djl 2008.03.23

Public Types

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

Public Member Functions

virtual void readExternal (PofReader::Handle hIn)
 
virtual void writeExternal (PofWriter::Handle hOut) const
 
virtual bool equals (Object::View v) const
 Compare the ArrayFilter with another object to determine equality.
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 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 ObjectArray::View getFilters () const
 Obtain the Filter array.

Protected Member Functions

 ArrayFilter ()
 Default constructor (necessary for the PortableObject interface).
 ArrayFilter (ObjectArray::View vaFilter)
 Construct a logical filter that applies a binary operator to a filter array.

Protected Attributes

MemberView< ObjectArraym_vaFilter
 The Filter array.

Constructor & Destructor Documentation

ArrayFilter ( ObjectArray::View  vaFilter  )  [protected]

Construct a logical filter that applies a binary operator to a filter array.

The result is defined as: aFilter[0] <op> aFilter[1] ... <op> aFilter[n]

Parameters:
vaFilter the filter array


Member Function Documentation

virtual bool equals ( Object::View  v  )  const [virtual]

Compare the ArrayFilter with another object to determine equality.

Two ArrayFilter objects are considered equal iff they belong to the same class and their underlying Filter arrays are deep-equal.

Returns:
true iff this ArrayFilter and the passed object are equivalent

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

Obtain the Filter array.

Returns:
the Filter array


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