|
IBM Rational Software Modeler Release 6.0 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.ibm.xtools.patterns.framework.PatternDefinitionUsage
The pattern definition usage class represents the use of a pattern definition. Any pattern definition to be used within framework-based pattern implementations should 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.
AbstractPatternDelegate#AbstractPatternDelegate(PatternDefinitionUsage, PatternParameterMapping.Provider)| Field Summary |
| Fields inherited from interface com.ibm.xtools.patterns.core.IPatternDescriptor |
DIAGRAM, DIAGRAM_DELIMITERS, DOCUMENTATION, MANIFEST, MODEL, OVERVIEW_DIAGRAM, PLUGIN_NAME, PLUGIN_URL, TARGET_TYPE, TARGET_TYPE_DELIMITERS, TEMPLATE, TYPE |
| Fields inherited from interface com.ibm.xtools.transform.core.ITransformationDescriptor |
AUTHOR, DESCRIPTION, DOCUMENT, EXTENSIBLE, GROUP_PATH, GROUP_PATH_DELIMITERS, ICON, ID, KEYWORDS, KEYWORDS_DELIMITERS, NAME, PROFILES, PROFILES_DELIMITERS, PROVIDER, PUBLIC, SOURCE_MODEL_TYPE, SOURCE_MODEL_TYPE_DELIMITERS, TARGET_MODEL_TYPE, TARGET_MODEL_TYPE_DELIMITERS, TRANSFORM_GUI, VERSION |
| 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(Object object)
|
org.eclipse.core.runtime.IAdaptable |
getAdaptableProperty(String propertyId)
Returns the property with the given property id that is implemented as an adaptable object. |
String[] |
getAssignedGroups()
Returns the string paths of groups to which the pattern represented by this pattern descriptor is assigned. |
IPatternMetatype[] |
getContainerTypes()
Returns the types of elements that are valid containers for an instance of the pattern represented by this pattern descriptor. |
String |
getDescription()
Retrieve the localized description of the transformation item. |
String |
getId()
Retrieve the unique id of the transformation item. |
IPatternIdentity |
getIdentity()
Returns the composite identity of the pattern represented by this pattern descriptor. |
String[] |
getKeywords()
Returns the keywords associated with the pattern represented by this pattern descriptor. |
String |
getName()
Retrieve the localized name of the transformation item. |
IParameterDescriptor[] |
getParameters()
Returns the parameters for the pattern represented by this pattern descriptor. |
ITransformationProperty[] |
getProperties()
Return all defined properties associated with this transformation. |
ITransformationProperty |
getProperty(String propertyName)
Return the specified property associated with this transformation. |
String[] |
getPropertyIds()
List the identifers of properties associated with this transformation. |
IPatternMetatype[] |
getTargetTypes()
Returns the types of elements that are valid targets for an instance of the pattern represented by this pattern descriptor. |
IPatternMetatype |
getType()
Returns the type of element to which an instance of the pattern represented by this pattern descriptor will be bound. |
String |
getVersion()
Returns the version of the pattern represented by this pattern descriptor. |
boolean |
isGroupMember(String groupPathString)
Determines whether the pattern represented by this pattern descriptor is assigned to the group designated by the given group path string. |
boolean |
isPublic()
Return true if the transformation is public (visible in UI). |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public PatternDefinitionUsage(AbstractPatternDefinition used)
used - the definition to be used within this usagepublic PatternDefinitionUsage(PatternIdentity identity)
identity - the identity to be used to retrieve the pattern definition
when needed (lazily bound)| Method Detail |
public int compareTo(Object object)
compareTo in interface Comparablepublic org.eclipse.core.runtime.IAdaptable getAdaptableProperty(String propertyId)
IPatternDescriptor
getAdaptableProperty in interface IPatternDescriptorpublic String[] getAssignedGroups()
IPatternDescriptor
getAssignedGroups in interface IPatternDescriptorpublic IPatternMetatype[] getContainerTypes()
IPatternDescriptor
getContainerTypes in interface IPatternDescriptorpublic String getDescription()
ITransformationItem
getDescription in interface ITransformationItempublic String getId()
ITransformationItem
getId in interface ITransformationItempublic IPatternIdentity getIdentity()
IPatternDescriptor
getIdentity in interface IPatternDescriptorpublic String[] getKeywords()
IPatternDescriptor
getKeywords in interface IPatternDescriptorpublic String getName()
ITransformationItem
getName in interface ITransformationItempublic IParameterDescriptor[] getParameters()
IPatternDescriptor
getParameters in interface IPatternDescriptorpublic ITransformationProperty[] getProperties()
ITransformationDescriptor
getProperties in interface ITransformationDescriptorpublic ITransformationProperty getProperty(String propertyName)
ITransformationDescriptor
getProperty in interface ITransformationDescriptorpropertyName - the identifier of the property
public String[] getPropertyIds()
ITransformationDescriptor
getPropertyIds in interface ITransformationDescriptorpublic IPatternMetatype[] getTargetTypes()
IPatternDescriptor
getTargetTypes in interface IPatternDescriptorpublic IPatternMetatype getType()
IPatternDescriptor
getType in interface IPatternDescriptorpublic String getVersion()
IPatternDescriptor
getVersion in interface IPatternDescriptorpublic boolean isGroupMember(String groupPathString)
IPatternDescriptor
isGroupMember in interface IPatternDescriptorgroupPathString - The string for the group path designating
a group for which the pattern represented
by this pattern descriptor will be tested
for membership.
true if the pattern is a member of the group
designated by the given group path string;
otherwise, it returns false.public boolean isPublic()
ITransformationDescriptorThis is a convenience method for returning the value of the PUBLIC property.
isPublic in interface ITransformationDescriptor
|
IBM Rational Software Modeler Release 6.0 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2004. All rights reserved.