Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members  

CosNotifyFilter::Filter Interface Reference

Interface for a filter. More...

import "CosNotifyFilter.idl";

List of all members.

Public Methods

ConstraintInfoSeq add_constraints (in ConstraintExpSeq constraint_list) raises (InvalidConstraint)
 Associates one or more constraints with this filter object. More...

void modify_constraints (in ConstraintIDSeq del_list, in ConstraintInfoSeq modify_list) raises (InvalidConstraint, ConstraintNotFound)
 Delete or modify constraints on this filter object. More...

ConstraintInfoSeq get_constraints (in ConstraintIDSeq id_list) raises (ConstraintNotFound)
 Return a list of constraints for this filter object based on IDs. More...

ConstraintInfoSeq get_all_constraints ()
 Return a list of all constraints for this filter object. More...

void remove_all_constraints ()
 Removes all constraints defined on this filter object. More...

void destroy ()
 Destroys this filter object. More...

boolean match (in any filterable_data) raises (UnsupportedFilterableData)
 Evaluates the input event against the filter constraints defined on this filter object. More...

boolean match_structured (in CosNotification::StructuredEvent filterable_data) raises (UnsupportedFilterableData)
 Evaluates the input event against the filter constraints defined on this filter object. More...

boolean match_typed (in CosNotification::PropertySeq filterable_data) raises (UnsupportedFilterableData)
 Evaluates the input event against the filter constraints defined on this filter object. More...

CallbackID attach_callback (in CosNotifyComm::NotifySubscribe callback)
 Attach a callback object to this filter that will be notified each time the constraints on this filter are modified. More...

void detach_callback (in CallbackID callback) raises ( CallbackNotFound )
 Detach a callback object from this filter. More...

CallbackIDSeq get_callbacks ()
 Returns a list of callback objects attached to this filter. More...


Public Attributes

readonly attribute string constraint_grammar
 The constraint grammer used by this filter. More...


Detailed Description

Interface for a filter.


Member Function Documentation

ConstraintInfoSeq CosNotifyFilter::Filter::add_constraints in ConstraintExpSeq    constraint_list raises (InvalidConstraint)
 

Associates one or more constraints with this filter object.

m <code>constraint_list</code> - List of constraints to be
associated with filter.
Returns:
A list with ID for each of the added constraints. @raises InvalidConstraint If any of the constraints are invalid.

CallbackID CosNotifyFilter::Filter::attach_callback in CosNotifyComm::NotifySubscribe    callback
 

Attach a callback object to this filter that will be notified each time the constraints on this filter are modified.

m <code>callback</code> - A callback object reference of type
NotifySubscribe.
Returns:
A ID which is unique for the newly attached object.

void CosNotifyFilter::Filter::destroy  
 

Destroys this filter object.

void CosNotifyFilter::Filter::detach_callback in CallbackID    callback raises ( CallbackNotFound )
 

Detach a callback object from this filter.

m <code>callback</code> - ID of the callback object to detach.
@raises CallbackNotFound If the ID does not correspond to any attached callback object reference.

ConstraintInfoSeq CosNotifyFilter::Filter::get_all_constraints  
 

Return a list of all constraints for this filter object.

Returns:
A list of all constraints.

CallbackIDSeq CosNotifyFilter::Filter::get_callbacks  
 

Returns a list of callback objects attached to this filter.

Returns:
List of callback object IDs.

ConstraintInfoSeq CosNotifyFilter::Filter::get_constraints in ConstraintIDSeq    id_list raises (ConstraintNotFound)
 

Return a list of constraints for this filter object based on IDs.

m <code>id_list</code> - List of constraint IDs.
Returns:
A list of constraints for the IDs in the input sequence. @raises ConstraintNotFound If a constraint was not found.

boolean CosNotifyFilter::Filter::match in any    filterable_data raises (UnsupportedFilterableData)
 

Evaluates the input event against the filter constraints defined on this filter object.

If the event satisfies one of the filter constraints TRUE is returned, otherwise FALSE is returned.

m <code>filterable_data</code> - The event to evaluate.
Returns:
TRUE if event matches any constraint, FALSE otherwise. raises UnsupportedFilterableData If the event specified by filterable_data contains data that this filter is not designed to handle.

boolean CosNotifyFilter::Filter::match_structured in CosNotification::StructuredEvent    filterable_data raises (UnsupportedFilterableData)
 

Evaluates the input event against the filter constraints defined on this filter object.

If the event satisfies one of the filter constraints TRUE is returned, otherwise FALSE is returned.

m <code>filterable_data</code> - The structured event to evaluate.
Returns:
TRUE if event matches any constraint, FALSE otherwise. raises UnsupportedFilterableData If the event specified by filterable_data contains data that this filter is not designed to handle.

boolean CosNotifyFilter::Filter::match_typed in CosNotification::PropertySeq    filterable_data raises (UnsupportedFilterableData)
 

Evaluates the input event against the filter constraints defined on this filter object.

If the event satisfies one of the filter constraints TRUE is returned, otherwise FALSE is returned.

m <code>filterable_data</code> - The typed event to evaluate.
Returns:
TRUE if event matches any constraint, FALSE otherwise. raises UnsupportedFilterableData If the event specified by filterable_data contains data that this filter is not designed to handle.

void CosNotifyFilter::Filter::modify_constraints in ConstraintIDSeq    del_list,
in ConstraintInfoSeq    modify_list
raises (InvalidConstraint, ConstraintNotFound)
 

Delete or modify constraints on this filter object.

m <code>del_list</code> - List of constraints to delete.
m <code>modify_list</code> - List of constraints to modify.
@raises InvalidConstraint If any of the constraints in the modify_list input sequences are invalid. @raises ConstraintNotFound If a constraint in either of the two input sequences was not found.

void CosNotifyFilter::Filter::remove_all_constraints  
 

Removes all constraints defined on this filter object.


Member Data Documentation

readonly attribute string CosNotifyFilter::Filter::constraint_grammar
 

The constraint grammer used by this filter.