Oracle® Fusion Middleware C++ API Reference for Oracle Coherence
12c (12.2.1.1.0)

E69640-01

FilterTrigger Class Reference

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

List of all members.


Detailed Description

A generic Filter-based MapTrigger implementation.

If an evaluation of the coherence::util::MapTrigger::Entry object representing a pending change fails (returns false), then one of the following actions is taken:

Note: This trigger never prevents entries from being removed.

Author:
djl 2008.05.22

Public Types

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

Public Member Functions

virtual void process (MapTrigger::Entry::Handle vEntry)
 
virtual void readExternal (PofReader::Handle hIn)
 
virtual void writeExternal (PofWriter::Handle hOut) const
 
virtual bool equals (Object::View v) const
 Compare the FilterTrigger with another object to determine equality.
virtual size32_t hashCode () const
 
virtual TypedHandle
< const String > 
toString () const
 
virtual Filter::View getFilter () const
 Obtain the underlying Filter.
virtual int32_t getAction () const
 Obtain the action code for this FilterTrigger.

Static Public Attributes

static const int32_t action_rollback
 Evaluation failure results in an IllegalArgumentException thrown by the trigger.
static const int32_t action_ignore
 Evaluation failure results in restoring the original Entry's value.
static const int32_t action_remove
 Evaluation failure results in a removal of the entry.

Protected Member Functions

 FilterTrigger ()
 Default constructor (necessary for the PortableObject interface).
 FilterTrigger (Filter::View vFilter, int32_t nAction=action_rollback)
 Construct a FilterTrigger based on the specified Filter object and the action constant.

Protected Attributes

FinalView< Filter > f_vFilter
 The underlying filter.
int32_t m_nAction
 The action code.

Constructor & Destructor Documentation

FilterTrigger ( Filter::View  vFilter,
int32_t  nAction = action_rollback 
) [protected]

Construct a FilterTrigger based on the specified Filter object and the action constant.

Parameters:
vFilter the underlying Filter
nAction one of the ACTION_* constants, default is action_rollback


Member Function Documentation

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

Compare the FilterTrigger with another object to determine equality.

Two FilterTrigger objects are considered equal iff the wrapped filters and action codes are equal.

Returns:
true iff this FilterTrigger and the passed object are equivalent FilterTrigger objects

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

Obtain the underlying Filter.

Returns:
the underlying Filter object

virtual int32_t getAction (  )  const [virtual]

Obtain the action code for this FilterTrigger.

Returns:
one of the ACTION_* constants


The documentation for this class was generated from the following file:
Copyright © 2000, 2016, Oracle and/or its affiliates. All rights reserved.