|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The Transformation Descriptor interface provides access to the static information that is used to identify a transformation.
This static information includes the name of the transformation (localized),
a unique identifier (non-localized) and a brief description on the purpose
of the transformation. All information about a transformation is kept in
properties associated with this descriptor. Each property also has a unique
identifer and the default property values cannot be changed in this
descriptor. However, These properties can also be accessed via
ITransformContext
when a transformation instance is executed.
The constants in this interface define the identifers for the pre-defined properties, which may be optional. In addition, transformation authors can define their own properties for the transformation.
AbstractTransformationProvider
,
ITransformContext
,
TransformationServiceUtil
,
AbstractTransformGUI
Field Summary | |
static String |
AUTHOR
Property ID for the transformation author. |
static String |
DESCRIPTION
Property ID for the brief transformation description. |
static String |
DOCUMENT
Property ID for an HTML document containing detailed transformation information. |
static String |
EXTENSIBLE
Property ID for the transformation extensibility flag. |
static String |
GROUP_PATH
Property ID for the transformation's group path. |
static String |
GROUP_PATH_DELIMITERS
Delimiters for the group path property value. |
static String |
ICON
Property ID for the transformation's icon representation. |
static String |
ID
Property ID for the transformation's unique identifier. |
static String |
KEYWORDS
Property ID for the transformation keywords. |
static String |
KEYWORDS_DELIMITERS
Delimiters for the keywords property value. |
static String |
NAME
Property ID for the transformation name. |
static String |
PROFILES
Property ID for the transformation's required profiles. |
static String |
PROFILES_DELIMITERS
Delimiters for the profiles property value. |
static String |
PROVIDER
Property ID for the transformation provider (class name). |
static String |
PUBLIC
Property ID for the transformation visibility flag. |
static String |
SOURCE_MODEL_TYPE
Property ID for the transformation's source model type. |
static String |
SOURCE_MODEL_TYPE_DELIMITERS
Delimiters for the source model type property value. |
static String |
TARGET_MODEL_TYPE
Property ID for the transformation's target model type. |
static String |
TARGET_MODEL_TYPE_DELIMITERS
Delimiters for the target model type property value. |
static String |
TRANSFORM_GUI
Property ID for the transformation custom GUI class. |
static String |
VERSION
Property ID for the transformation's version string. |
Method Summary | |
ITransformationProperty[] |
getProperties()
Return all defined properties associated with this transformation. |
ITransformationProperty |
getProperty(String propertyId)
Return the specified property associated with this transformation. |
String[] |
getPropertyIds()
List the identifers of properties associated with this transformation. |
boolean |
isPublic()
Return true if the transformation is public (visible in UI). |
Methods inherited from interface com.ibm.xtools.transform.core.ITransformationItem |
getDescription, getId, getName |
Field Detail |
public static final String AUTHOR
public static final String NAME
The value of this property is also accessible via getName().
public static final String ID
The value of this property is also accessible via getId().
public static final String DESCRIPTION
The value of this property is also accessible via getDescription().
This description corresponds to the RAS ShortDescription property.
public static final String DOCUMENT
The contents of the document corresponds to the RAS Description property.
public static final String EXTENSIBLE
public static final String ICON
public static final String KEYWORDS
public static final String KEYWORDS_DELIMITERS
public static final String SOURCE_MODEL_TYPE
public static final String SOURCE_MODEL_TYPE_DELIMITERS
public static final String TARGET_MODEL_TYPE
public static final String TARGET_MODEL_TYPE_DELIMITERS
public static final String GROUP_PATH
A path is a slash ("/") separated list of subpaths, similar to a list of nested folders.
public static final String GROUP_PATH_DELIMITERS
public static final String PROFILES
public static final String PROFILES_DELIMITERS
public static final String PUBLIC
public static final String TRANSFORM_GUI
By defining this property, transformation authors have the ability to override the default tabs and/or to add their own custom tabs. For example, the standard transform property tab contains a table of property name/value pairs. This simplistic presentation of properties may not be suitable, especially if there are dependencies between these properties.
The value for this custom GUI transformation property should be a class in the transformation provider's plug-in that is derived from the class (@link com.ibm.xtools.transform.ui.AbstractTransformGUI).
public static final String VERSION
public static final String PROVIDER
Method Detail |
public ITransformationProperty[] getProperties()
public ITransformationProperty getProperty(String propertyId)
propertyId
- the identifier of the property
public String[] getPropertyIds()
public boolean isPublic()
This is a convenience method for returning the value of the PUBLIC property.
|
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.