IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.patterns.core
Interface IPatternDescriptor

All Superinterfaces:
Comparable, ITransformationDescriptor, ITransformationItem
All Known Implementing Classes:
AbstractPatternDefinition, PatternDefinitionUsage

public interface IPatternDescriptor
extends ITransformationDescriptor, Comparable

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
 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

DIAGRAM

public static final String DIAGRAM
Property identifier for the diagrams associated with the pattern.

See Also:
Constant Field Values

DIAGRAM_DELIMITERS

public static final String DIAGRAM_DELIMITERS
The delimiter for separating diagram qualified names.

See Also:
Constant Field Values

DOCUMENTATION

public static final String DOCUMENTATION
Property identifier for the documentation of the pattern.

See Also:
Constant Field Values

MANIFEST

public static final String MANIFEST
Property identifier for the URL of the RAS manifest of the pattern. The manifest URL property is an adaptable property.

See Also:
Constant Field Values

MODEL

public static final String MODEL
Property identifier for the model associated with the pattern. The model property is an adaptable property.

See Also:
Constant Field Values

OVERVIEW_DIAGRAM

public static final String OVERVIEW_DIAGRAM
Property identifier for the pattern overview diagram. The overview diagram property is an adaptable property.

See Also:
Constant Field Values

PLUGIN_NAME

public static final String PLUGIN_NAME
Property identifier for the plug-in name. The plug-in name property is a string.

See Also:
Constant Field Values

PLUGIN_URL

public static final String PLUGIN_URL
Property identifier for the plug-in URL. The plug-in URL property is an adaptable property.

See Also:
Constant Field Values

TYPE

public static final String TYPE
Identifier for the property containing the instance type for the pattern.

See Also:
Constant Field Values

TARGET_TYPE

public static final String TARGET_TYPE
Identifier for the property containing the target types for the pattern. The target types property is multi-valued, using the specified delimiters for separating values.

See Also:
Constant Field Values

TARGET_TYPE_DELIMITERS

public static final String TARGET_TYPE_DELIMITERS
The delimiters for separating target type values.

See Also:
Constant Field Values

TEMPLATE

public static final String TEMPLATE
Property identifier for the UML 2.0 template element associated with the pattern item.

See Also:
Constant Field Values
Method Detail

getIdentity

public IPatternIdentity getIdentity()
Returns the composite identity of the pattern represented by this pattern descriptor.

Returns:
Returns the identity of the pattern.

getVersion

public String getVersion()
Returns the version of the pattern represented by this pattern descriptor.

Returns:
Returns the version of the pattern.

getAssignedGroups

public String[] getAssignedGroups()
Returns the string paths of groups to which the pattern represented by this pattern descriptor is assigned.

Returns:
Returns the string paths of the groups to which the pattern is assigned.

getKeywords

public String[] getKeywords()
Returns the keywords associated with the pattern represented by this pattern descriptor.

Returns:
Returns the keywords associated with the pattern.

getAdaptableProperty

public IAdaptable getAdaptableProperty(String propertyId)
Returns the property with the given property id that is implemented as an adaptable object.

Returns:
Returns the adaptable object with the given property id associated with the pattern.

getType

public IPatternMetatype getType()
Returns the type of element to which an instance of the pattern represented by this pattern descriptor will be bound.

Returns:
Returns the type to which an instance the pattern will be bound.

getTargetTypes

public IPatternMetatype[] getTargetTypes()
Returns the types of elements that are valid targets for an instance of the pattern represented by this pattern descriptor.

Returns:
Returns the types of elements that are targets for an instance of the pattern.

getContainerTypes

public IPatternMetatype[] getContainerTypes()
Returns the types of elements that are valid containers for an instance of the pattern represented by this pattern descriptor.

Returns:
Returns the types of elements that are the containers for an instance of the pattern.

getParameters

public IParameterDescriptor[] getParameters()
Returns the parameters for the pattern represented by this pattern descriptor.

Returns:
Returns the parameters for the pattern.

isGroupMember

public 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.

Parameters:
groupPathString - The string for the group path designating a group for which the pattern represented by this pattern descriptor will be tested for membership.
Returns:
Returns 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


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.