Module CosNotifyFilter

This module provides interfaces which support all aspects of filter and mapping filter management.



Interface Index

Filter
The Filter interface manages groups of filter constraint expressions and has operations which evaluate events against these constraints.
FilterAdmin
The FilterAdmin interface supports the management of filter objects.
FilterFactory
The FilterFactory interface includes operations which support the creation of filter objects and mapping filter objects.
MappingFilter
The MappingFilter interface manages groups of mapping filter constraint-value pairs and has operations which evaluate events against these constraints.

Exception Index

CallbackNotFound
Raised when an operation cannot find a callback with the given ID.
ConstraintNotFound
Raised when an operation cannot find a constraint with the given ID.
DuplicateConstraintID
Not used.
FilterNotFound
Indicates that a reference for a specified filter was not found.
InvalidConstraint
Raised during the addition or modification of constraints if the new constraint does not conform to the specified grammar for the target filter object.
InvalidGrammar
Raised during filter creation if an invalid constraint grammar is specified.
InvalidValue
Raised if the datatype of a value in an input constraint-value pair does not match the value_type for the target mapping filter object.
UnsupportedFilterableData
Raised during a match operation if the input event contains data that the match operation is not designed to handle.

Struct Index

ConstraintExp
A single filter constraint.
ConstraintInfo
Used to maintain an association between filter constraints and constraint IDs.
MappingConstraintInfo
Used to maintain an association between mapping filter constraints and constraint IDs.
MappingConstraintPair
The mapping filter constraint-value pair.

Alias Index

CallbackID
Alias for a callback ID.
CallbackIDSeq
Alias for a sequence of callback IDs.
ConstraintExpSeq
Alias for a sequence of filter constraints.
ConstraintID
Alias for a constraint ID.
ConstraintIDSeq
Alias for a sequence of constraint IDs.
ConstraintInfoSeq
Alias for a sequence of constraint-ID pairs.
FilterID
Alias for a filter ID.
FilterIDSeq
Alias for a sequence of filter IDs.
MappingConstraintInfoSeq
Alias for a sequence of constraint-value pairs.
MappingConstraintPairSeq
Alias for a sequence of mapping constraint pairs.

Structs

ConstraintExp
struct ConstraintExp
{
    CosNotification::EventTypeSeq event_types;
    string constraint_expr;
};

A single filter constraint.

Members:
event_types - A sequence of event types which are matched against the event type information in the structured event header.
constraint_expr - A constraint expression which conforms to some constraint grammar.

ConstraintInfo
struct ConstraintInfo
{
    ConstraintExp constraint_expression;
    ConstraintID constraint_id;
};

Used to maintain an association between filter constraints and constraint IDs.

Members:
constraint_expression - A reference to the filter constraint.
constraint_id - The ID assigned to the filter constraint by the target object.

MappingConstraintInfo
struct MappingConstraintInfo
{
    ConstraintExp constraint_expression;
    ConstraintID constraint_id;
    any value;
};

Used to maintain an association between mapping filter constraints and constraint IDs.

Members:
constraint_expression - A filter constraint.
constraint_id - A unique ID assigned to the constraint-value pair by the target mapping filter object.
value - The result to return from a match operation which matches on the corresponding constraint.

MappingConstraintPair
struct MappingConstraintPair
{
    ConstraintExp constraint_expression;
    any result_to_set;
};

The mapping filter constraint-value pair.

Members:
constraint_expression - A filter constraint.
result_to_set - The result to return from a match operation which matches on the corresponding constraint.


Exceptions

CallbackNotFound
exception CallbackNotFound
{
};

Raised when an operation cannot find a callback with the given ID.


ConstraintNotFound
exception ConstraintNotFound
{
    ConstraintID id;
};

Raised when an operation cannot find a constraint with the given ID.


DuplicateConstraintID
exception DuplicateConstraintID
{
    ConstraintID id;
};

Not used.


FilterNotFound
exception FilterNotFound
{
};

Indicates that a reference for a specified filter was not found.


InvalidConstraint
exception InvalidConstraint
{
    ConstraintExp constr;
};

Raised during the addition or modification of constraints if the new constraint does not conform to the specified grammar for the target filter object.


InvalidGrammar
exception InvalidGrammar
{
};

Raised during filter creation if an invalid constraint grammar is specified.


InvalidValue
exception InvalidValue
{
    ConstraintExp constr;
    any value;
};

Raised if the datatype of a value in an input constraint-value pair does not match the value_type for the target mapping filter object.


UnsupportedFilterableData
exception UnsupportedFilterableData
{
};

Raised during a match operation if the input event contains data that the match operation is not designed to handle.



Aliases

CallbackID
typedef long CallbackID;

Alias for a callback ID.


CallbackIDSeq
typedef sequence<CallbackID> CallbackIDSeq;

Alias for a sequence of callback IDs.


ConstraintExpSeq
typedef sequence<ConstraintExp> ConstraintExpSeq;

Alias for a sequence of filter constraints.


ConstraintID
typedef long ConstraintID;

Alias for a constraint ID.


ConstraintIDSeq
typedef sequence<ConstraintID> ConstraintIDSeq;

Alias for a sequence of constraint IDs.


ConstraintInfoSeq
typedef sequence<ConstraintInfo> ConstraintInfoSeq;

Alias for a sequence of constraint-ID pairs.


FilterID
typedef long FilterID;

Alias for a filter ID.


FilterIDSeq
typedef sequence<FilterID> FilterIDSeq;

Alias for a sequence of filter IDs.


MappingConstraintInfoSeq
typedef sequence<MappingConstraintInfo> MappingConstraintInfoSeq;

Alias for a sequence of constraint-value pairs.


MappingConstraintPairSeq
typedef sequence<MappingConstraintPair> MappingConstraintPairSeq;

Alias for a sequence of mapping constraint pairs.



Generated by the ORBacus IDL-to-HTML translator (non-commercial)