The Filter
interface manages groups of filter
constraint expressions and has operations which evaluate events
against these constraints.
NotifySubscribe
interface (proxy suppliers and consumer admins) to register
with the target filter object.
attach_callback
.
readonly attribute string constraint_grammar;
The constraint grammar specified during creation of the filter. All constraints for the target filter object must be expressed in this grammar.
ConstraintInfoSeq add_constraints(in ConstraintExpSeq constraint_list) raises(InvalidConstraint);
Add a list of filter constraints to the target filter object. This operation is incremental in that new constraints are appended to the existing list of constraints.
constraint_list
- The list of constraints to be
added to the target filter object.
InvalidConstraint
exception is raised.
CallbackID attach_callback(in CosNotifyComm::NotifySubscribe callback);
Allows objects supporting the NotifySubscribe
interface (proxy suppliers and consumer admins) to register
with the target filter object. Registered objects are
notified when the set of event types required by the filter
constraints changes.
callback
- A reference to an object interested
in subscription changes.
void destroy();
Destroys the target filter object.
void detach_callback(in CallbackID callback) raises(CallbackNotFound);
Removes a callback previously registered with
attach_callback
.
callback
- The ID of the callback to be removed.
The CallbackNotFound
exception is raised of
the target object does not contain a reference with the
given ID.
ConstraintInfoSeq get_all_constraints();
Retrieve all constraints associated with the target filter object.
CallbackIDSeq get_callbacks();
Retrieve a list of all callbacks registered with the target filter object.
ConstraintInfoSeq get_constraints(in ConstraintIDSeq id_list) raises(ConstraintNotFound);
Retrieves a set of constraints from the target filter object.
id_list
- A list of constraint IDs representing the
constraints to be retrieved.
ConstraintNotFound
exception
is raised.
boolean match(in any filterable_data) raises(UnsupportedFilterableData);
Compare the filter constraints from the target filter object with the supplied event.
filterable_data
- The event to be evaluated in
the form of a CORBA::Any
.
TRUE
if the event satistifes
at least one constraint, FALSE
otherwise. If
the filterable data of the input event contains data that
the match operation cannot handle, an
UnsupportedFilterableData
exception is raised.
boolean match_structured(in CosNotification::StructuredEvent filterable_data) raises(UnsupportedFilterableData);
Compare the filter constraints from the target filter object with the supplied event.
filterable_data
- The event to be evaluated in the
form of a structured event.
TRUE
if the event satistifes
at least one constraint, FALSE
otherwise. If
the filterable data of the input event contains data that
the match operation cannot handle an
UnsupportedFilterableData
exception is raised.
boolean match_typed(in CosNotification::PropertySeq filterable_data) raises(UnsupportedFilterableData);
Not implemented.
void modify_constraints(in ConstraintIDSeq del_list, in ConstraintInfoSeq modify_list) raises(InvalidConstraint, ConstraintNotFound);
Modifies the list of constraints associated with the
target filter object. If one or more of the IDs in
either of the two lists are not found the
ConstraintNotFound
exception is raised.
del_list
- A list of constraint IDs representing
constraints to remove from the target filter object.
modify_list
- A list of constraint IDs and
constraint expressions. Constraints which exist in the
target filter object are modified to those in the list
with the same constraint ID. If a constraint in this
list does not conform to the constraint grammar for the
target filter object, an InvalidConstraint
exception is raised.
void remove_all_constraints();
Remove all constraints associated with the target filter object.
Generated by the ORBacus IDL-to-HTML translator (non-commercial)