Interface CosNotifyFilter::MappingFilter

interface MappingFilter

The MappingFilter interface manages groups of mapping filter constraint-value pairs and has operations which evaluate events against these constraints.



Attribute Index

constraint_grammar
The constraint grammar specified during creation of the filter.
default_value
This parameter is returned as the result of a match operation for which the given event satisfied none of the constraints associated with the target mapping filter object.
value_type
Identifies the datatype of the property value which the mapping filter affects.

Operation Index

add_mapping_constraints
Add a list of mapping filter constraints to the target mapping filter object.
destroy
Destroys the target filter object.
get_all_mapping_constraints
Retrieve all constraint-value pairs associated with the target filter object.
get_mapping_constraints
Retrieves a set of constraint-value pairs 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_mapping_constraints
Modifies the list of constraint-value pairs associated with the target filter object.
remove_all_mapping_constraints
Remove all constraint-value pairs 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 a filter object must be expressed in this grammar.


default_value
readonly attribute any default_value;

This parameter is returned as the result of a match operation for which the given event satisfied none of the constraints associated with the target mapping filter object.


value_type
readonly attribute TypeCode value_type;

Identifies the datatype of the property value which the mapping filter affects.



Operations

add_mapping_constraints
MappingConstraintInfoSeq add_mapping_constraints(in MappingConstraintPairSeq pair_list)
    raises(InvalidConstraint,
           InvalidValue);

Add a list of mapping filter constraints to the target mapping filter object. This operation is incremental in that new constraints are appended to the existing list of constraints.

Parameters:
pair_list - The list of constraint-value pairs to be added to the target filter object.
Returns:
The target filter object assigns an ID to each constraint-value pair. The input list is returned along with the ID assigned to each constraint-value pair. If any of the constraints violate the constraint grammar an InvalidConstraint exception is raised. If any of the values in the list of constraint-value pairs are not of the same type as the value_type for the target filter object, an InvalidValue exception is raised.

destroy
void destroy();

Destroys the target filter object.


get_all_mapping_constraints
MappingConstraintInfoSeq get_all_mapping_constraints();

Retrieve all constraint-value pairs associated with the target filter object.

Returns:
All constraint-value pairs associated with the target filter object.

get_mapping_constraints
MappingConstraintInfoSeq get_mapping_constraints(in ConstraintIDSeq id_list)
    raises(ConstraintNotFound);

Retrieves a set of constraint-value pairs from the target filter object.

Parameters:
id_list - A list of constraint IDs representing the constraint-value pairs to be retrieved.
Returns:
The constraint-value pairs 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,
              out any result_to_set)
    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.
result_to_set - If the match is successful, that is the return result is TRUE, this parameter is set to the value paired with the matching constraint. Otherwise if the match fails, that is the return result is FALSE, this parameter is set to the default_value for the target filter object.
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,
                         out any result_to_set)
    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.
result_to_set - If the match is successful, that is the return result is TRUE, this parameter is set to the value paired with the matching constraint. Otherwise if the match fails, that is the return result is FALSE, this parameter is set to the default_value for the target filter object.
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,
                    out any result_to_set)
    raises(UnsupportedFilterableData);

Not Implemented.


modify_mapping_constraints
void modify_mapping_constraints(in ConstraintIDSeq del_list,
                                in MappingConstraintInfoSeq modify_list)
    raises(InvalidConstraint,
           InvalidValue,
           ConstraintNotFound);

Modifies the list of constraint-value pairs 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 constraint-value pairs to remove from the target filter object.
modify_list - A list of constraint IDs and constraint-value pairs. Constraints which exist in the target filter object are modified to those in the list with the same constraint ID. Both the constraint and value types may be modified. If a constraint in this list does not conform to the constraint grammar for the target filter object, an InvalidConstraint exception is raised. Likewise if a value in this list is not of the same type as the value_type for the target filter object, an InvalidValue exception is raised.

remove_all_mapping_constraints
void remove_all_mapping_constraints();

Remove all constraint-value pairs associated with the target filter object.



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