public interface ITransformationDescriptor extends ITransformationItem
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
identifier 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 identifiers for the pre-defined properties, which may be optional. In addition, transformation authors can define their own properties for the transformation.
This interface should not be implemented or extended by clients.
AbstractTransformationProvider
,
ITransformContext
,
TransformationServiceUtil
,
com.ibm.xtools.transform.ui.AbstractTransformGUI
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
AUTHOR
Property ID for the transformation author.
|
static java.lang.String |
DESCRIPTION
Property ID for the brief transformation description.
|
static java.lang.String |
DOCUMENT
Property ID for an HTML document containing detailed transformation
information.
|
static java.lang.String |
EXECUTION_LIST
Property ID for the execution list of the transformation.
|
static java.lang.String |
EXTENSIBLE
Property ID for the transformation extensibility flag.
|
static java.lang.String |
GROUP_PATH
Property ID for the transformation's group path.
|
static java.lang.String |
GROUP_PATH_DELIMITERS
Delimiters for the group path property value.
|
static java.lang.String |
ICON
Property ID for the transformation's icon representation.
|
static java.lang.String |
ID
Property ID for the transformation's unique identifier.
|
static java.lang.String |
KEYWORDS
Property ID for the transformation keywords.
|
static java.lang.String |
KEYWORDS_DELIMITERS
Delimiters for the keywords property value.
|
static java.lang.String |
LICENSE_ID
Property ID for the the component Id that contains this plugin
The transformation service will use this property value to check the license.
|
static java.lang.String |
LICENSE_VERSION
Property ID for the the component version that contains this plugin
if the LICENSE_ID is not null, the transformation service will use this
property value to check the license.
|
static java.lang.String |
MODEL_TYPE_DELIMITERS
Delimiters for the source model type, target model type,
reverse source model type and reverse target model type property values.
|
static java.lang.String |
NAME
Property ID for the transformation name.
|
static java.lang.String |
PROFILES
Property ID for the transformation's required profiles.
|
static java.lang.String |
PROFILES_DELIMITERS
Delimiters for the profiles property value.
|
static java.lang.String |
PROVIDER
Property ID for the transformation provider (class name).
|
static java.lang.String |
PUBLIC
Property ID for the transformation visibility flag.
|
static java.lang.String |
REVERSE_TRANSFORM_ID
Property ID for the transformation ID of a reverse transformation for this transformation.
|
static java.lang.String |
SOURCE_MODEL_TYPE
Property ID for the transformation's source model type.
|
static java.lang.String |
SOURCE_MODEL_TYPE_DELIMITERS
Deprecated.
|
static java.lang.String |
SUPPORTS_SILENT
Property ID for the transformation silent support flag.
|
static java.lang.String |
SUPPORTS_SOURCE_OVERRIDE
Property ID for the transformation source override support flag.
|
static java.lang.String |
TARGET_MODEL_TYPE
Property ID for the transformation's target model type.
|
static java.lang.String |
TARGET_MODEL_TYPE_DELIMITERS
Deprecated.
|
static java.lang.String |
TRANSFORM_GUI
Property ID for the transformation custom GUI class.
|
static java.lang.String |
VERSION
Property ID for the transformation's version string.
|
Modifier and Type | Method and Description |
---|---|
ITransformationProperty[] |
getProperties()
Return all defined properties associated with this transformation.
|
ITransformationProperty |
getProperty(java.lang.String propertyId)
Return the specified property associated with this transformation.
|
java.lang.String[] |
getPropertyIds()
List the identifiers of properties associated with this transformation.
|
boolean |
isPublic()
Return true if the transformation is public (visible in UI).
|
getDescription, getId, getName
static final java.lang.String AUTHOR
static final java.lang.String NAME
The value of this property is also accessible via getName().
static final java.lang.String ID
The value of this property is also accessible via getId().
static final java.lang.String DESCRIPTION
The value of this property is also accessible via getDescription().
This description corresponds to the RAS ShortDescription property.
static final java.lang.String DOCUMENT
The contents of the document corresponds to the RAS Description property.
static final java.lang.String EXTENSIBLE
static final java.lang.String ICON
static final java.lang.String KEYWORDS
static final java.lang.String KEYWORDS_DELIMITERS
static final java.lang.String MODEL_TYPE_DELIMITERS
static final java.lang.String SOURCE_MODEL_TYPE
static final java.lang.String SOURCE_MODEL_TYPE_DELIMITERS
static final java.lang.String TARGET_MODEL_TYPE
static final java.lang.String TARGET_MODEL_TYPE_DELIMITERS
static final java.lang.String GROUP_PATH
A path is a slash ("/") separated list of subpaths, similar to a list of nested folders.
static final java.lang.String GROUP_PATH_DELIMITERS
static final java.lang.String PROFILES
static final java.lang.String PROFILES_DELIMITERS
static final java.lang.String PUBLIC
static final java.lang.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 AbstractTransformGUI.
com.ibm.xtools.transform.ui.AbstractTransformGUI
,
Constant Field Valuesstatic final java.lang.String VERSION
static final java.lang.String PROVIDER
static final java.lang.String EXECUTION_LIST
static final java.lang.String SUPPORTS_SILENT
static final java.lang.String REVERSE_TRANSFORM_ID
static final java.lang.String SUPPORTS_SOURCE_OVERRIDE
static final java.lang.String LICENSE_ID
static final java.lang.String LICENSE_VERSION
ITransformationProperty[] getProperties()
ITransformationProperty getProperty(java.lang.String propertyId)
propertyId
- the identifier of the propertyjava.lang.String[] getPropertyIds()
boolean isPublic()
This is a convenience method for returning the value of the PUBLIC property.