OpenCOM
Interface IMetaInterface

All Known Implementing Classes:
CFMetaInterface, OpenCOMComponent

public interface IMetaInterface

This interface is implemented by every OpenCOM component. It support the interface meta-model of OpenCOM. Allow instrospection and manipualtion of interfaces and receptacles on the component plus the corresponding meta-data attachments.


Method Summary
 int enumIntfs(java.util.Vector<java.lang.Class> ppIntf)
          Returns a Vector of meta-information.
 int enumRecps(java.util.Vector<OCM_RecpMetaInfo_t> ppRecpMetaInfo)
          Returns a Vector of meta-information.
 java.util.Hashtable GetAllValues(java.lang.String Kind, java.lang.String iid)
          This method retrieves all the meta-data stored on the interface or receptacle.
 TypedAttribute GetAttributeValue(java.lang.String iid, java.lang.String Kind, java.lang.String Name)
          Meta-data can be retrieved from each interface/receptacle of a component.
 boolean SetAttributeValue(java.lang.String iid, java.lang.String Kind, java.lang.String Name, java.lang.String Type, java.lang.Object Value)
          Meta-data can be attached to each interface/receptacle of a component.
 

Method Detail

enumRecps

int enumRecps(java.util.Vector<OCM_RecpMetaInfo_t> ppRecpMetaInfo)
Returns a Vector of meta-information. Each elements of the Vector is an object of type OCM_RecpMetaInfo_t, which describes the attributes of indiviudal receptacles including: type (single or multiple) & interface type.

Parameters:
ppRecpMetaInfo - a Vector to be filled with receptacle meta-information.
Returns:
an Integer describing the number of receptacles on the component.

enumIntfs

int enumIntfs(java.util.Vector<java.lang.Class> ppIntf)
Returns a Vector of meta-information. Each elements of the Vector is a String describing that interface's type.

Parameters:
ppRecpMetaInfo - a Vector to be filled with interface meta-information.
Returns:
an Integer describing the number of interfaces on the component.

SetAttributeValue

boolean SetAttributeValue(java.lang.String iid,
                          java.lang.String Kind,
                          java.lang.String Name,
                          java.lang.String Type,
                          java.lang.Object Value)
Meta-data can be attached to each interface/receptacle of a component. This method adds a name value pair to a given interface or receptacle instance.

Parameters:
iid - the type of the interface or receptacle.
Kind - a string saying whether to attach to an interface or a receptacle.
Name - A String describing the attribute name.
Type - A String describing the attribute type.
Value - An object representing the attribute value.
Returns:
A boolean indicating the success of the operation.

GetAttributeValue

TypedAttribute GetAttributeValue(java.lang.String iid,
                                 java.lang.String Kind,
                                 java.lang.String Name)
Meta-data can be retrieved from each interface/receptacle of a component. This method retrieves the value of a name attribute on a receptacle or interface.

Parameters:
iid - the type of the interface or receptacle.
Kind - a string saying whether to attach to an interface or a receptacle.
Name - A String describing the attribute name.
Returns:
A TypedAttribute object containing the value and type of the meta-data attribute.

GetAllValues

java.util.Hashtable GetAllValues(java.lang.String Kind,
                                 java.lang.String iid)
This method retrieves all the meta-data stored on the interface or receptacle.

Parameters:
iid - the type of the interface or receptacle.
Kind - a string saying whether to attach to an interface or a receptacle.
Returns:
A hashatable containing all of the attribute-value pairs for the receptacle or interface.