XTools Transformation Utilities

Identifier:

com.ibm.xtools.transform.core.transformationUtilities

Description:

This extension point lets users define and register transform utilities that can be used by transformations. Transformations can specify which transform utilities they use by including the id of a transform utility within a UseUtility element for a transformation defined within a transformatonProviders extension.

Configuration Markup:

<!ELEMENT extension (TransformUtility+)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

point - The identifier of the extension point, e.g. com.ibm.xtools.transform.core.transformationUtilities.
id - The identifier of the extension, e.g. my.plugin.transformationUtilities.
name - The name of the extension, e.g. %ext.transformationUtilitiesProviderName.

<!ELEMENT TransformUtility (Property*)>

<!ATTLIST TransformUtility

id CDATA #REQUIRED

name CDATA #REQUIRED

description CDATA #IMPLIED

author CDATA #IMPLIED

document CDATA #IMPLIED

keywords CDATA #IMPLIED

version CDATA #REQUIRED

class CDATA #REQUIRED

configGUI CDATA #IMPLIED

supportsSilentMode (true | false) "false">

id - The unique identifier of the transform utility.
name - The localized name of the transform utility.
description - The description of the transform utility.
author - The author of the transform utility.
document - An HTML document reference containing detailed information on what the transform utility does and how it can be used. The referenced HTML document can either be an URL or a file path relative to the root directory of the plug-in.
keywords - A list of associated keywords (separated by commas).
version - The version of this transform utility. The version format should be compatible with the Eclipse version format: x.y.z.
class - The class to instantiate for this transform utility. The class must be derived from com.ibm.xtools.transform.core.TransformUtility.
configGUI - An optional class that enables transform utility authors to integrate custom GUI into the transformation user interface. The specified class must be derived from com.ibm.xtools.transform.ui.AbstractTransformGUI.
supportsSilentMode - The transform utility supports executing in silent/headless mode.

<!ELEMENT Property EMPTY>

<!ATTLIST Property

name CDATA #REQUIRED

id CDATA #REQUIRED

description CDATA #IMPLIED

value CDATA #IMPLIED

metatype CDATA #IMPLIED

metatypeData CDATA #IMPLIED

maxValues CDATA #IMPLIED

delimiters CDATA #IMPLIED

readonly (true | false) "false">

name - The localized name of the transformation property to be added.
id - The identifier of the transformation property which should be unique within the transform utility. However, if the property already exists in the transform utility and is read-write, the value specified in this property definition will override the default value in the transform utility descriptor. If the existing property is read-only, this property definition will have no effect.
description - A localized description of this transformation property.
value - The default value of the transformation property. Clients can override this default value in the transform context (ITransformContext). If the "maxValues" attribute is not "1", this default value will be parsed (using the "delimiters" attribute) to create a list of values instead of a single value. If this attribute is not specified, the property value is null.
metatype - Defines the underlying type of the property value(s). The property does not enforce this metatype. It is simply information for the client that interprets the property value. The default metatype value is "string".
metatypeData - Defines the data associated with the underlying type of the property value(s). The property does not interpret this metatype data. It is additional information for the client that interprets the property value and can be used to define constraints on the value. The default metatype data value is an empty string.
maxValues - Defines the maximum number of values that can be defined for the property. A number less than or equal to zero indicates an unlimited number of values. The default maximum number of values is "1".
delimiters - If a property can contain multiple values (maxValues != 1) and a string is defined for the "value" attribute, this delimiters attribute can be defined so that the single value string can be parsed into multiple values (e.g., the keywords property expects a space separated list of words as its "value" attribute). The default delimiters are " \t\r\n\f".
readonly - Identifies a property as being read-only and cannot be changed at runtime. The default is "false".