| Java API Reference | Class Hierarchy | All Classes | All Fields and Methods |
com.ibm.xtools.patterns.framework
+-- Object +-- PatternDefinitionUsage
public Class PatternDefinitionUsage
extends Object
Represents the use of a pattern definition.
Any pattern definition to be used within framework-based pattern implementations must use the pattern definition usage class.
A pattern definition usage is required when constructing a pattern delegate instance. A pattern parameter mapping is associated with a pattern definition usage and used at expansion time.
This class is a proxy and for the case where a pattern identity is used to construct a usage, lazy loading is used and therefore the proxy is not resolved until first use. The state pattern is used to encapsulate the state-related code.
| Constructor summary |
|---|
| PatternDefinitionUsage(AbstractPatternDefinition used) Constructs a pattern definition usage with the given pattern definition. |
| PatternDefinitionUsage(PatternIdentity identity) Constructs a pattern definition usage with the given pattern identity. |
| Method summary | |
|---|---|
| int | compareTo(IPatternDescriptor patternDescriptor) Compares parameter descriptors. |
| IAdaptable | getAdaptableProperty(String propertyId) Retrieves the adaptable property of the object. |
| String | getAssignedGroups() Retrieves the assigned group values for the pattern descriptor. |
| IPatternMetatype | getContainerTypes() Retrieves the container types for the pattern descriptor. |
| String | getDescription() Retrieves the description of the pattern descriptor value. |
| URL | getIconURL() Retrieves the URL object representing the icon URL value. |
| String | getId() Retrieves the Id value of the pattern descriptor. |
| IPatternIdentity | getIdentity() Retrieves the IPatternIdentity object representing the identity value. |
| String | getImplementationTechnologyID() Retrieves the identity value. |
| String | getKeywords() Retrieves the array of Strings representing the keywords value. |
| String | getName() Retrieves the name value. |
| IParameterDescriptor | getParameters() Retrieves the array of IParameterDescriptor objects representing the parameters value. |
| ITransformationProperty | getProperties() Retrieves the array of ITransformationProperty objects representing the properties values. |
| ITransformationProperty | getProperty(String propertyName) Retrieves the property based on the name of the property. |
| String | getPropertyIds() Retrieves the array of Strings representing the property ids value. |
| IPatternMetatype | getTargetTypes() Retrieves the target type values. |
| IPatternMetatype | getType() Retrieves the type value. |
| String | getVersion() Retrieves the version value. |
| boolean | isGroupMember(String groupPathString) Retrieves whether the object is part of the path group. |
| boolean | isPublic() Retrieves whether the object is public. |
Constructor detail
public PatternDefinitionUsage(AbstractPatternDefinition used)
Constructs a pattern definition usage with the given pattern definition.
Parameters:
| used | - The definition to be used within this usage. |
public PatternDefinitionUsage(PatternIdentity identity)
Constructs a pattern definition usage with the given pattern identity.
Parameters:
| identity | - The identity to be used to retrieve the pattern definition when needed (lazily bound). |
Method detail
public int compareTo(IPatternDescriptor patternDescriptor)
Compares parameter descriptors.
Parameters:
| patternDescriptor | - |
Returns:
An integer representing the compared values. |
public IAdaptable getAdaptableProperty(String propertyId)
Retrieves the adaptable property of the object.
Parameters:
| propertyId | - The Id of the adaptable property to retrieve. |
Returns:
An IAdaptable object. |
public String getAssignedGroups()
Retrieves the assigned group values for the pattern descriptor.
Returns:
An array of Strings representing the assigned group values. |
public IPatternMetatype getContainerTypes()
Retrieves the container types for the pattern descriptor.
Returns:
An array of IPatternMetatype objects representing the container types values. |
public String getDescription()
Retrieves the description of the pattern descriptor value.
Returns:
A String representing the description value. |
public URL getIconURL()
Retrieves the URL object representing the icon URL value.
Returns:
A URL object representing the icon URL value. |
public String getId()
Retrieves the Id value of the pattern descriptor.
Returns:
A String representing the Id value. |
public IPatternIdentity getIdentity()
Retrieves the IPatternIdentity object representing the identity value.
Returns:
An IPatternIdentity object representing the identity value. |
public String getImplementationTechnologyID()
Retrieves the identity value.
Returns:
A String representing the implementation technology ID value. |
public String getKeywords()
Retrieves the array of Strings representing the keywords value.
Returns:
An array of Strings representing the keywords value. |
public String getName()
Retrieves the name value.
Returns:
A String representing the name value. |
public IParameterDescriptor getParameters()
Retrieves the array of IParameterDescriptor objects representing the parameters value.
Returns:
An array of IParameterDescriptor objects representing the parameters value. |
public ITransformationProperty getProperties()
Retrieves the array of ITransformationProperty objects representing the properties values.
Returns:
An array of ITransformationProperty objects representing the properties values. |
public ITransformationProperty getProperty(String propertyName)
Retrieves the property based on the name of the property.
Parameters:
| propertyName | - The name of the property to retrieve. |
Returns:
The property. |
public String getPropertyIds()
Retrieves the array of Strings representing the property ids value.
Returns:
An array of Strings representing the property ids value. |
public IPatternMetatype getTargetTypes()
Retrieves the target type values.
Returns:
An array of IPatternMetatype objects representing the target types value. |
public IPatternMetatype getType()
Retrieves the type value.
Returns:
An IPatternMetatype object representing the type value. |
public String getVersion()
Retrieves the version value.
Returns:
A String representing the version value. |
public boolean isGroupMember(String groupPathString)
Retrieves whether the object is part of the path group.
Parameters:
| groupPathString | - The string for the path of the group. |
Returns:
A boolean value of true if the object is part of the group. Otherwise, it returns a value of false. |