org.omg.CosNotifyFilter
Class _MappingFilterStub

java.lang.Object
  extended by org.omg.CORBA.portable.ObjectImpl
      extended by org.omg.CosNotifyFilter._MappingFilterStub
All Implemented Interfaces:
java.io.Serializable, org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity, MappingFilter, MappingFilterOperations

public class _MappingFilterStub
extends org.omg.CORBA.portable.ObjectImpl
implements MappingFilter

The MappingFilter interface defines the behaviors of objects which encapsulate a sequence of constraint-value pairs, where each constraint is a structure of the same type as that described in section 3.2.1, and each value represents a possible setting of a particular property of an event. Note that setting of a particular property is not intended to imply that any contents of the event will be altered as a result of applying a mapping filter, but rather the way a proxy treats the event with respect to a particular property (i.e., priority or lifetime) could change. Upon receiving each event, a proxy object with an associated object supporting the MappingFilter interface will invoke the appropriate match operation variant (depending upon whether the event is received in the form of an untyped event, a Structured Event, or a typed event) on the mapping filter object in order to determine how it should modify a particular property value associated with the event to one of the values associated with one of the constraints encapsulated by the mapping filter. Internally, the mapping filter object applies the constraints it encapsulates to the event in order to determine whether or not the event?s property should be modified to one of the values associated with a constraint, or else the default value associated with the mapping filter. Each instance of an object supporting the MappingFilter interface is typically associated with a specific event property. For instance, in this specification MappingFilter object instances are used to affect the properties of priority and lifetime for events received by a proxy supplier object. Each event received by a proxy object which has an object supporting the MappingFilter interface associated with it must satisfy at least one of the constraints associated with the MappingFilter object in order to have its property value modified, otherwise the property will remain unchanged. A specific instance supporting the MappingFilter interface typically applies its encapsulated constraints in an order which begins with the best possible property setting (e.g., the highest priority or the longest lifetime), and ends with the worst possible property setting. As soon as a matching constraint is encountered, the associated value is returned as an output parameter and the proxy which invoked the operation proceeds to modify the property of the event to the new value. The constraint expressions associated with a particular object supporting the MappingFilter interface are expressed as strings which obey the syntax of a particular constraint grammar (i.e. a BNF). Every conformant implementation of this service must support constraint expressions expressed in the default constraint grammar described in section 2.4. In addition, implementations may support other constraint grammars, and/or users of this service may implement their own filter objects which allow constraints to be expressed in terms of an alternative constraint grammar. As long as such user-defined filter objects support the MappingFilter interface, they can be attached to proxy objects in the same fashion as the default MappingFilter objects supported by the implementation of the service are, and the channel should be able to use them to potentially affect the properties of events in the same fashion. The MappingFilter interface supports the operations required to manage the constraint-value pairs associated with an object instance which supports the interface. In addition, the MappingFilter interface supports a readonly attribute which identifies the particular constraint grammar in which the constraints encapsulated by this object have meaning. The MappingFilter interface also supports a readonly attribute which identifies the typecode associated with the datatype of the specific property value it is intended to affect, and another readonly attribute which holds the default value which will be returned as the result of a match operation in cases when the event in question is found to satisfy none of the constraints encapsulated by the mapping filter. Lastly, the MappingFilter interface supports three variants of the operation which will be invoked by an associated proxy object upon receipt of an event, to determine how the property of the event which the target mapping filter object was designed to affect should be modified. The operations supported by the MappingFilter object are described in more detail within the following subsections.

See Also:
Serialized Form

Constructor Summary
_MappingFilterStub()
           
 
Method Summary
 java.lang.String[] _ids()
           
 MappingConstraintInfo[] add_mapping_constraints(MappingConstraintPair[] pair_list)
          Operation add_mapping_constraints
 java.lang.String constraint_grammar()
          Read accessor for constraint_grammar attribute
 org.omg.CORBA.Any default_value()
          Read accessor for default_value attribute
 void destroy()
          Operation destroy
 MappingConstraintInfo[] get_all_mapping_constraints()
          Operation get_all_mapping_constraints
 MappingConstraintInfo[] get_mapping_constraints(int[] id_list)
          Operation get_mapping_constraints
 boolean match_structured(StructuredEvent filterable_data, org.omg.CORBA.AnyHolder result_to_set)
          Operation match_structured
 boolean match_typed(Property[] filterable_data, org.omg.CORBA.AnyHolder result_to_set)
          Operation match_typed
 boolean match(org.omg.CORBA.Any filterable_data, org.omg.CORBA.AnyHolder result_to_set)
          Operation match
 void modify_mapping_constraints(int[] del_list, MappingConstraintInfo[] modify_list)
          Operation modify_mapping_constraints
 void remove_all_mapping_constraints()
          Operation remove_all_mapping_constraints
 org.omg.CORBA.TypeCode value_type()
          Read accessor for value_type attribute
 
Methods inherited from class org.omg.CORBA.portable.ObjectImpl
_create_request, _create_request, _duplicate, _get_delegate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _invoke, _is_a, _is_equivalent, _is_local, _non_existent, _orb, _release, _releaseReply, _request, _request, _servant_postinvoke, _servant_preinvoke, _set_delegate, _set_policy_override, equals, hashCode, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.omg.CORBA.Object
_create_request, _create_request, _duplicate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _is_a, _is_equivalent, _non_existent, _release, _request, _set_policy_override
 

Constructor Detail

_MappingFilterStub

public _MappingFilterStub()
Method Detail

_ids

public java.lang.String[] _ids()
Specified by:
_ids in class org.omg.CORBA.portable.ObjectImpl

constraint_grammar

public java.lang.String constraint_grammar()
Read accessor for constraint_grammar attribute

Specified by:
constraint_grammar in interface MappingFilterOperations
Returns:
the attribute value

value_type

public org.omg.CORBA.TypeCode value_type()
Read accessor for value_type attribute

Specified by:
value_type in interface MappingFilterOperations
Returns:
the attribute value

default_value

public org.omg.CORBA.Any default_value()
Read accessor for default_value attribute

Specified by:
default_value in interface MappingFilterOperations
Returns:
the attribute value

add_mapping_constraints

public MappingConstraintInfo[] add_mapping_constraints(MappingConstraintPair[] pair_list)
                                                throws InvalidConstraint,
                                                       InvalidValue
Operation add_mapping_constraints

Specified by:
add_mapping_constraints in interface MappingFilterOperations
Throws:
InvalidConstraint
InvalidValue

modify_mapping_constraints

public void modify_mapping_constraints(int[] del_list,
                                       MappingConstraintInfo[] modify_list)
                                throws InvalidConstraint,
                                       InvalidValue,
                                       ConstraintNotFound
Operation modify_mapping_constraints

Specified by:
modify_mapping_constraints in interface MappingFilterOperations
Throws:
InvalidConstraint
InvalidValue
ConstraintNotFound

get_mapping_constraints

public MappingConstraintInfo[] get_mapping_constraints(int[] id_list)
                                                throws ConstraintNotFound
Operation get_mapping_constraints

Specified by:
get_mapping_constraints in interface MappingFilterOperations
Throws:
ConstraintNotFound

get_all_mapping_constraints

public MappingConstraintInfo[] get_all_mapping_constraints()
Operation get_all_mapping_constraints

Specified by:
get_all_mapping_constraints in interface MappingFilterOperations

remove_all_mapping_constraints

public void remove_all_mapping_constraints()
Operation remove_all_mapping_constraints

Specified by:
remove_all_mapping_constraints in interface MappingFilterOperations

destroy

public void destroy()
Operation destroy

Specified by:
destroy in interface MappingFilterOperations

match

public boolean match(org.omg.CORBA.Any filterable_data,
                     org.omg.CORBA.AnyHolder result_to_set)
              throws UnsupportedFilterableData
Operation match

Specified by:
match in interface MappingFilterOperations
Throws:
UnsupportedFilterableData

match_structured

public boolean match_structured(StructuredEvent filterable_data,
                                org.omg.CORBA.AnyHolder result_to_set)
                         throws UnsupportedFilterableData
Operation match_structured

Specified by:
match_structured in interface MappingFilterOperations
Throws:
UnsupportedFilterableData

match_typed

public boolean match_typed(Property[] filterable_data,
                           org.omg.CORBA.AnyHolder result_to_set)
                    throws UnsupportedFilterableData
Operation match_typed

Specified by:
match_typed in interface MappingFilterOperations
Throws:
UnsupportedFilterableData