The MappingFilter
interface manages groups of mapping
filter constraint-value pairs and has operations which evaluate
events against these constraints.
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.
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.
readonly attribute TypeCode value_type;
Identifies the datatype of the property value which the mapping filter affects.
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.
pair_list
- The list of constraint-value pairs
to be added to the target filter object.
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.
void destroy();
Destroys the target filter object.
MappingConstraintInfoSeq get_all_mapping_constraints();
Retrieve all constraint-value pairs associated with the target filter object.
MappingConstraintInfoSeq get_mapping_constraints(in ConstraintIDSeq id_list) raises(ConstraintNotFound);
Retrieves a set of constraint-value pairs from the target filter object.
id_list
- A list of constraint IDs representing the
constraint-value pairs to be retrieved.
ConstraintNotFound
exception is raised.
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.
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.
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, out any result_to_set) 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.
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.
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, out any result_to_set) raises(UnsupportedFilterableData);
Not Implemented.
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.
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.
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)