|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Captures the information about the pattern that it is required or useful in understanding the semantics of the pattern, the steps involved in applying the pattern, and the result of applying the pattern.
A pattern descriptor represents a pattern. The descriptor includes simple information such as
the name, unique id, version, and author of the pattern as well as complex
information such as the descriptors for the parameters of the pattern. To retrieve the parameters for the pattern represented
by this pattern descriptor, call the getParameters
method.
The IPatternDescriptor extends the ITransformationDescriptor
interface;
a pattern descriptor is a kind of transformation descriptor.
Field Summary | |
static String |
DIAGRAM
Property identifier for the diagrams associated with the pattern. |
static String |
DIAGRAM_DELIMITERS
The delimiter for separating diagram qualified names. |
static String |
DOCUMENTATION
Property identifier for the documentation of the pattern. |
static String |
MANIFEST
Property identifier for the URL of the RAS manifest of the pattern. |
static String |
MODEL
Property identifier for the model associated with the pattern. |
static String |
OVERVIEW_DIAGRAM
Property identifier for the pattern overview diagram. |
static String |
PLUGIN_NAME
Property identifier for the plug-in name. |
static String |
PLUGIN_URL
Property identifier for the plug-in URL. |
static String |
TARGET_TYPE
Identifier for the property containing the target types for the pattern. |
static String |
TARGET_TYPE_DELIMITERS
The delimiters for separating target type values. |
static String |
TEMPLATE
Property identifier for the UML 2.0 template element associated with the pattern item. |
static String |
TYPE
Identifier for the property containing the instance type for the pattern. |
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 |
Method Summary | |
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. |
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. |
IParameterDescriptor[] |
getParameters()
Returns the parameters for the pattern represented by this pattern descriptor. |
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. |
Methods inherited from interface com.ibm.xtools.transform.core.ITransformationDescriptor |
getProperties, getProperty, getPropertyIds, isPublic |
Methods inherited from interface com.ibm.xtools.transform.core.ITransformationItem |
getDescription, getId, getName |
Methods inherited from interface java.lang.Comparable |
compareTo |
Field Detail |
public static final String DIAGRAM
public static final String DIAGRAM_DELIMITERS
public static final String DOCUMENTATION
public static final String MANIFEST
public static final String MODEL
public static final String OVERVIEW_DIAGRAM
public static final String PLUGIN_NAME
public static final String PLUGIN_URL
public static final String TYPE
public static final String TARGET_TYPE
public static final String TARGET_TYPE_DELIMITERS
public static final String TEMPLATE
Method Detail |
public IPatternIdentity getIdentity()
public String getVersion()
public String[] getAssignedGroups()
public String[] getKeywords()
public org.eclipse.core.runtime.IAdaptable getAdaptableProperty(String propertyId)
public IPatternMetatype getType()
public IPatternMetatype[] getTargetTypes()
public IPatternMetatype[] getContainerTypes()
public IParameterDescriptor[] getParameters()
public boolean isGroupMember(String groupPathString)
groupPathString
- 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
.
|
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.