|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.xtools.transform.core.TransformationServiceUtil
The class provides access to the Transformation Service. Every transformation is represented by a transformation descriptor that contains transformation properties. An instance of a transformation (a transform) must be created before the transformation can be executed. The configurable data (properties) that a transform uses to execute is maintained in a transform context which can be obtained from the transform.
In addition to the properties defined in the transformation descriptor, the transform context has several special properties that the underlying transformation engine uses. The two key properties are the "source" for the transformation and the "target container" where the transformed source will be created. Before a transform can be executed, its populated transform context should be validated.
Method Summary | |
static AbstractTransform |
createTransformation(ITransformationDescriptor descriptor)
Create a transformation instance for the given transformation descriptor. |
static ITransformationDescriptor |
getTransformationDescriptor(String id)
Obtain the transformation descriptor for the given identifier. |
static org.eclipse.core.runtime.IStatus |
validateContext(ITransformationDescriptor descriptor,
ITransformContext context)
Validate the context for the corresponding transformation. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static AbstractTransform createTransformation(ITransformationDescriptor descriptor)
descriptor
- the transformation descriptor
public static ITransformationDescriptor getTransformationDescriptor(String id)
id
- the unique identifier fo the transformation
public static org.eclipse.core.runtime.IStatus validateContext(ITransformationDescriptor descriptor, ITransformContext context)
This method can return either a single status object or multiple status objects depending upon the validation performed. If multiple warnings/errors are to be returned use a MultiStatus object. If one of its child status objects has a severity of ERROR, the multi-status is assumed to be an error.
A valid context should return a single status object with a severity of OK. A "null" return value indicates a major error (e.g., the service could not locate or load the provider).
descriptor
- the transformation descriptorcontext
- the context to be validated
MultiStatus
,
Status
|
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.