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

CosNotifyFilter::MappingFilter Interface Reference

Interface for a mapping filter. More...

import "CosNotifyFilter.idl";

List of all members.

Public Methods

MappingConstraintInfoSeq add_mapping_constraints (in MappingConstraintPairSeq pair_list) raises (InvalidConstraint, InvalidValue)
 Associates one or more mapping constraints with this filter object. More...

void modify_mapping_constraints (in ConstraintIDSeq del_list, in MappingConstraintInfoSeq modify_list) raises (InvalidConstraint, InvalidValue, ConstraintNotFound)
 Delete or modify mapping constraints on this filter object. More...

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

MappingConstraintInfoSeq get_all_mapping_constraints ()
 Return a list of all mapping constraints for this filter object. More...

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

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

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

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

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


Public Attributes

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

readonly attribute CORBA::TypeCode value_type
 The data type of the property value that this filter was designed to affect. More...

readonly attribute any default_value
 The output value for any match operation that returns true. More...


Detailed Description

Interface for a mapping filter.


Member Function Documentation

MappingConstraintInfoSeq CosNotifyFilter::MappingFilter::add_mapping_constraints in MappingConstraintPairSeq    pair_list raises (InvalidConstraint, InvalidValue)
 

Associates one or more mapping constraints with this filter object.

m <code>constraint_list</code> - List of mapping constraints to
be associated with filter.
Returns:
A list with ID for each of the added mapping constraints. @raises InvalidConstraint If any of the mapping constraints are invalid. @raises InvalidValue If any of the constraints have a typecode that is different from the value_type attribute.

void CosNotifyFilter::MappingFilter::destroy  
 

Destroys this mapping filter object.

MappingConstraintInfoSeq CosNotifyFilter::MappingFilter::get_all_mapping_constraints  
 

Return a list of all mapping constraints for this filter object.

Returns:
A list of all mapping constraints.

MappingConstraintInfoSeq CosNotifyFilter::MappingFilter::get_mapping_constraints in ConstraintIDSeq    id_list raises (ConstraintNotFound)
 

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

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

boolean CosNotifyFilter::MappingFilter::match in any    filterable_data,
out any    result_to_set
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.
m <code>result_to_set</code> - Value of a constraint that
matches the event or default_value if the event does not match any constraints.
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::MappingFilter::match_structured in CosNotification::StructuredEvent    filterable_data,
out any    result_to_set
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.
m <code>result_to_set</code> - Value of a constraint that
matches the event or default_value if the event does not match any constraints.
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::MappingFilter::match_typed in CosNotification::PropertySeq    filterable_data,
out any    result_to_set
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.
m <code>result_to_set</code> - Value of a constraint that
matches the event or default_value if the event does not match any constraints.
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::MappingFilter::modify_mapping_constraints in ConstraintIDSeq    del_list,
in MappingConstraintInfoSeq    modify_list
raises (InvalidConstraint, InvalidValue, ConstraintNotFound)
 

Delete or modify mapping constraints on this filter object.

m <code>del_list</code> - List of mapping 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 InvalidValue If any of the constraints have a typecode that is different from the value_type attribute. @raises ConstraintNotFound If a constraint in either of the two input sequences was not found.

void CosNotifyFilter::MappingFilter::remove_all_mapping_constraints  
 

Removes all mapping constraints defined on this filter object.


Member Data Documentation

readonly attribute string CosNotifyFilter::MappingFilter::constraint_grammar
 

The constraint grammer used by this filter.

readonly attribute any CosNotifyFilter::MappingFilter::default_value
 

The output value for any match operation that returns true.

readonly attribute CORBA::TypeCode CosNotifyFilter::MappingFilter::value_type
 

The data type of the property value that this filter was designed to affect.