public interface MModeledClassDescription extends MClassDescription
MModeledClassDescription
for
each class defined in the metadata document.
In effect, MModeledClassDescription
is used for application-specific
information.
MApp
parses information in the repository directory, it creates an
instance of MModeledClassDescription
for each class defined there. MModeledClassDescription
using the MClassFactory
interface. They can then use the instance as the type
of attributes of a class defined in the metadata document. Modifier and Type | Method and Description |
---|---|
MAttributeDescription |
addAttribute(java.lang.String attributeName,
com.tibco.infra.base.GlobalName attributeClassName,
java.lang.String defaultValStr,
boolean isKey,
boolean isReadOnly,
boolean isWriteOnly)
Deprecated.
as of TIBCO Adapter SDK Version 5.0.0
|
MAttributeDescription |
addAttribute(java.lang.String attributeName,
MClassDescription attributeClass,
java.lang.Object defaultVal,
boolean isKey,
boolean isReadOnly,
boolean isWriteOnly)
Create an attribute as specified and attach it to this class
|
MAttributeDescription |
addAttribute(java.lang.String attributeName,
java.lang.String attributeClassName,
java.lang.String defaultValStr,
boolean isKey,
boolean isReadOnly,
boolean isWriteOnly)
Create an attribute and attach it to this class.
|
void |
addMangledNameToMap(java.lang.String attrName,
java.lang.String mangledAttrName)
Deprecated.
internal use only - do not document
|
MOperationDescription |
addOperation(java.lang.String operationName,
com.tibco.infra.base.GlobalName returnClassName,
boolean oneWay)
Deprecated.
as of TIBCO Adapter SDK Version 5.0.0
|
MOperationDescription |
addOperation(java.lang.String operationName,
MClassDescription returnClass,
boolean oneWay)
Create an operation as specified and attach it to this class
|
MOperationDescription |
addOperation(java.lang.String operationName,
java.lang.String returnClassName,
boolean oneWay)
Create the specified operation and attach it to this class.
|
MAssociationDescription |
getAssociation(java.lang.String name)
Retrieve the association with the specified name.
|
java.util.Enumeration |
getAssociations()
Iterate through all associations, including those in ancestor classes.
|
MAttributeDescription |
getAttribute(int pos)
Retrieve an attribute from this
MModeledClassDescription . |
MAttributeDescription |
getAttribute(java.lang.String name)
Retrieve an attribute from this
MModeledClassDescription . |
int |
getAttributeCount()
Return the number of attributes for this MModeledClassDescription.
|
java.util.Enumeration |
getAttributes()
Iterate through the list of attributes for this MModeledClassDescription.
|
java.util.Enumeration |
getLocalAttributes()
Deprecated.
internal use only - do not document
|
MOperationDescription |
getOperation(java.lang.String name)
Return the named operation, looking in ancestor classes if necessary.
|
java.util.Enumeration |
getOperations()
Enumerate over the list of operations, including those of ancestor classes.
|
java.lang.String |
getOriginalAttributeName(java.lang.String mangledAttrName)
Deprecated.
internal use only - do not document
|
MClassDescription |
getParentClassDescription()
Return the parent class.
|
addDefaultValue, construct, getClassDescriptionGlobalName, getClassDescriptionName, getClassDescriptionShortName, getClassRegistry, getDataType, getDefaultList, getDefaultValue, getFullName, getPathName, getShortName, getXsiTypeName, getXsiTypeRelPath, isAssignable, isSubclass, isSuperclass, setXsiTypeName, setXsiTypeRelPath
getProperties, getProperty, getPropertyCount, getPropertyNames, isOK, isOK
MClassDescription getParentClassDescription()
MAttributeDescription getAttribute(java.lang.String name)
MModeledClassDescription
. This method
retrieves an attribute based on a specified name.
The method iterates through the superclass attributes after it has looked through all local attributes. It returns null if an attribute of the name or position cannot be found.
name
- Attribute to retrieve.MAttributeDescription getAttribute(int pos)
MModeledClassDescription
.
This method retrieves an attribute given the position of the attribute. The position is determined by the order in which the attribute was added.
The method iterates through the superclass attributes after it has looked through all local attributes. It returns null if an attribute of the specified position cannot be found.
pos
- Position of attribute to retrieve.java.util.Enumeration getAttributes()
int getAttributeCount()
MOperationDescription getOperation(java.lang.String name)
Enumeration.nextElement()
can
be cast to MAttributeDescription
.java.util.Enumeration getOperations()
Enumeration.nextElement()
can
be cast to MAttributeDescription
.MAssociationDescription getAssociation(java.lang.String name)
java.util.Enumeration getAssociations()
MAttributeDescription addAttribute(java.lang.String attributeName, com.tibco.infra.base.GlobalName attributeClassName, java.lang.String defaultValStr, boolean isKey, boolean isReadOnly, boolean isWriteOnly) throws MException
MException
MAttributeDescription addAttribute(java.lang.String attributeName, java.lang.String attributeClassName, java.lang.String defaultValStr, boolean isKey, boolean isReadOnly, boolean isWriteOnly) throws MException
attributeName
- Name of the attribute to add to the specified class.attributeClassName
- Name of the class of the attribute, for
example string or i4.defaultValStr
- Default value for this attribute, specified as an object.isKey
- If true
, this attribute is considered a key attribute.
If false
, it is not considered a key.isReadOnly
- If true
, this attribute is read only.isWriteOnly
- If true
, this attribute is write only.MException
- if there is a duplicated attribute (detected by name comparison).MRestrictedMethodException
- if this class description was created
from a repository description, not explicitly by the application itself.MAttributeDescription addAttribute(java.lang.String attributeName, MClassDescription attributeClass, java.lang.Object defaultVal, boolean isKey, boolean isReadOnly, boolean isWriteOnly) throws MException
MException
- On duplicated attribute ( detected by name comparison )MRestrictedMethodException
- If the class description was created from
configuration definitionMOperationDescription addOperation(java.lang.String operationName, com.tibco.infra.base.GlobalName returnClassName, boolean oneWay) throws MException
MException
addOperation(String, String, boolean)
MOperationDescription addOperation(java.lang.String operationName, java.lang.String returnClassName, boolean oneWay) throws MException
operationName
- Name of the operation to add to the specified class.returnClassName
- Global name of the class whose name is returned by this operation.oneWay
- If true
, this is a oneway operation. If false
, it is not.MException
- if there is a duplicated attribute (detected by name comparison).MRestrictedMethodException
- if this class description was created from
a repository description, not explicitly by the application itselfMOperationDescription addOperation(java.lang.String operationName, MClassDescription returnClass, boolean oneWay) throws MException
MException
- On duplicated operation ( detected by name comparison )MRestrictedMethodException
- If the class description was created from
configuration definitionvoid addMangledNameToMap(java.lang.String attrName, java.lang.String mangledAttrName)
java.lang.String getOriginalAttributeName(java.lang.String mangledAttrName)
java.util.Enumeration getLocalAttributes()