Interface CosNotifyFilter::Filter

interface Filter

The Filter interface manages groups of filter constraint expressions and has operations which evaluate events against these constraints.



Attribute Index

constraint_grammar
The constraint grammar specified during creation of the filter.

Operation Index

add_constraints
Add a list of filter constraints to the target filter object.
attach_callback
Allows objects supporting the NotifySubscribe interface (proxy suppliers and consumer admins) to register with the target filter object.
destroy
Destroys the target filter object.
detach_callback
Removes a callback previously registered with attach_callback.
get_all_constraints
Retrieve all constraints associated with the target filter object.
get_callbacks
Retrieve a list of all callbacks registered with the target filter object.
get_constraints
Retrieves a set of constraints from the target filter object.
match
Compare the filter constraints from the target filter object with the supplied event.
match_structured
Compare the filter constraints from the target filter object with the supplied event.
match_typed
Not implemented.
modify_constraints
Modifies the list of constraints associated with the target filter object.
remove_all_constraints
Remove all constraints associated with the target filter object.

Attributes

constraint_grammar
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.



Operations

add_constraints
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.

Parameters:
constraint_list - The list of constraints to be added to the target filter object.
Returns:
The target filter object assigns an ID to each constraint. This list of constraint-ID pairs is returned. If any of the constraints violate the constraint grammar an InvalidConstraint exception is raised.

attach_callback
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.

Parameters:
callback - A reference to an object interested in subscription changes.
Returns:
The target filter object assigns and returns a unique ID to each registered callback.

destroy
void destroy();

Destroys the target filter object.


detach_callback
void detach_callback(in CallbackID callback)
    raises(CallbackNotFound);

Removes a callback previously registered with attach_callback.

Parameters:
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.

get_all_constraints
ConstraintInfoSeq get_all_constraints();

Retrieve all constraints associated with the target filter object.

Returns:
All constraints associated with the target filter object.

get_callbacks
CallbackIDSeq get_callbacks();

Retrieve a list of all callbacks registered with the target filter object.

Returns:
A list of IDs representing all callbacks currently registered.

get_constraints
ConstraintInfoSeq get_constraints(in ConstraintIDSeq id_list)
    raises(ConstraintNotFound);

Retrieves a set of constraints from the target filter object.

Parameters:
id_list - A list of constraint IDs representing the constraints to be retrieved.
Returns:
The constraints associated with the target filter object with the given IDs. If one or more of the IDs are not found the ConstraintNotFound exception is raised.

match
boolean match(in any filterable_data)
    raises(UnsupportedFilterableData);

Compare the filter constraints from the target filter object with the supplied event.

Parameters:
filterable_data - The event to be evaluated in the form of a CORBA::Any.
Returns:
Returns 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.

match_structured
boolean match_structured(in CosNotification::StructuredEvent filterable_data)
    raises(UnsupportedFilterableData);

Compare the filter constraints from the target filter object with the supplied event.

Parameters:
filterable_data - The event to be evaluated in the form of a structured event.
Returns:
Returns 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.

match_typed
boolean match_typed(in CosNotification::PropertySeq filterable_data)
    raises(UnsupportedFilterableData);

Not implemented.


modify_constraints
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.

Parameters:
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.

remove_all_constraints
void remove_all_constraints();

Remove all constraints associated with the target filter object.



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