| Java API Reference | Class Hierarchy | All Classes | All Fields and Methods |
com.ibm.xtools.patterns.framework
+-- Object +-- PatternParameterUsage
public Class PatternParameterUsage
extends Object
Represents a pattern parameter usage used to wrap the use of a pattern parameter from other parts within the framework.
This typically means that a parameter descriptor needs to be proxified and resolved only after the first time that it is needed. This occurs to eliminate re-entrant calls into the constructor of the particular abstract pattern library being initialized when the first pattern service interrogation calls come in to the framework.
There is an equivalent of this class for pattern definitions and nested pattern instances.
| Method summary | |
|---|---|
| int | compareTo(IParameterDescriptor parameterDescriptor) Compares parameter descriptors. |
| IPatternMetatype | getAlternateTypes() Retrieves the alternate type values. |
| String | getDescription() Retrieves the description of the pattern descriptor value. |
| String | getId() Retrieves the Id value of the pattern descriptor. |
| IMultiplicity | getMultiplicity() Retrieves the multiplicity of the object. |
| String | getName() Retrieves the name of the object. |
| int | getOrdinal() Retrieves the ordinal value. |
| IPatternIdentity | getPatternIdentity() Returns the pattern identity value. |
| ITransformationProperty | getProperties() Retrieves the pattern properties. |
| ITransformationProperty | getProperty(String propertyId) Retrieves the pattern property. |
| String | getPropertyIds() Retrieves the Ids of the pattern properties. |
| IPatternMetatype | getType() Retrieves the type of the pattern. |
| boolean | isBindable() Retrieves whether the object is bindable. |
| boolean | isPublic() Retrieves whether the object is public. |
| boolean | isValidArgumentType(IPatternMetatype metatype) Retrieves whether the type of the argument is valid. |
Method detail
public int compareTo(IParameterDescriptor parameterDescriptor)
Compares parameter descriptors.
Parameters:
| parameterDescriptor | - The descriptor of the parameter. |
Returns:
An integer representing the compared values. |
public IPatternMetatype getAlternateTypes()
Retrieves the alternate type values.
Returns:
An array of PatternMetatype objects representing the alternate type values. |
public String getDescription()
Retrieves the description of the pattern descriptor value.
Returns:
A String representing the description value. |
public String getId()
Retrieves the Id value of the pattern descriptor.
Returns:
A String representing the Id value. |
public IMultiplicity getMultiplicity()
Retrieves the multiplicity of the object.
Returns:
An IMultiplicity object representing the multiplicity value. |
public String getName()
Retrieves the name of the object.
Returns:
A string representing the name value. |
public int getOrdinal()
Retrieves the ordinal value.
Returns:
An integer representing the ordinal value. |
public IPatternIdentity getPatternIdentity()
Returns the pattern identity value.
Returns:
An IPatternIdentity object representing the pattern identity value. |
public ITransformationProperty getProperties()
Retrieves the pattern properties.
Returns:
An array of ITransformationProperty objects representing the properties value. |
public ITransformationProperty getProperty(String propertyId)
Retrieves the pattern property.
Parameters:
| propertyId | - The Id of the property. |
Returns:
An ITransformationProperty object. |
public String getPropertyIds()
Retrieves the Ids of the pattern properties.
Returns:
An array of strings representing the property Ids values. |
public IPatternMetatype getType()
Retrieves the type of the pattern.
Returns:
An IPatternMetatype object representing the type value. |
public boolean isBindable()
Retrieves whether the object is bindable.
Returns:
A boolean value of true if the object is bindable. Otherwise, it returns a value of false. |
public boolean isPublic()
Retrieves whether the object is public.
Returns:
A boolean value of true if the object is public. Otherwise, it returns a value of false. |
public boolean isValidArgumentType(IPatternMetatype metatype)
Retrieves whether the type of the argument is valid.
Parameters:
| metatype | - The metatype of argument to be checked. |
Returns:
A boolean value of true if the argument type is valid. Otherwise, it returns a value of false. |