Eclipse JET Guide
Previous Page	Home	Next Page

JET Developer Guide Reference Extension Point Reference

JET Transformation

org.eclipse.jet.transform

1.0

Declares that the extending plugin is a JET transformation.

This extension point is not intended to be used directly by clients.

<!ELEMENT extension ( transform)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

<!ELEMENT transform ( description , tagLibraries , enablement?)>

<!ATTLIST transform

startTemplate CDATA #REQUIRED

templateLoaderClass CDATA #REQUIRED

modelLoader CDATA #IMPLIED

overrides CDATA #IMPLIED

modelExtension CDATA #IMPLIED

private (true | false) "false"

modelSchema CDATA #IMPLIED>

Declares transformation access details. For JET Transformation projects, there is exactly one of these.

startTemplate - The project relative path to the main template in the transformation. The main template serves as an entry point for the transformation. Typical values: template/control.jet or template/main.jet
templateLoaderClass - The fully qualified Java class name of the template loader class.
modelLoader - A reference to the id of the model loader to use when loading Eclipse resources. If not specified, a model loader is selected based on the file extension of the input model, or by the value of the 'modelExtension' attribute.
overrides - The id of a JET2 transformation that this transformation overrides. If not specified, the transformation does not override another transformation.
modelExtension - When specified, model loading ignores the file extension on the input model, and uses the value specified here instead. This can affect both the selection of a model loader (if the modelLoader attribute is not set), and the behavior of the selected model loader.
A typical use would be to force model loading to treat inputs as a specific type. For example, an Eclipse XML Schema file (exsd file extension) is an XML document that is not recognized by the XML model loaders. Setting the 'modelExtension' attribute to 'xml' would cause the model loading mechanism to treat an any input as if it had an 'xml' extension.
private - Indicate whether the transformation should appear in any JET UIs, or be enumerated by any JET APIs that search for available transformations. The default is false, indicating that the transformation will appear in all UIs and APIs.
modelSchema - An optional project relative path or a URL to a file that serves as a schema for transformation inputs. JET APIs makes no use of this information, but a schema can help users in creating valid models for the transformation.

<!ELEMENT tagLibraries ( importLibrary*)>

Declares tag libraries that may be used by the transformation's templates.

<!ELEMENT importLibrary EMPTY>

<!ATTLIST importLibrary

id CDATA #REQUIRED

usePrefix CDATA #REQUIRED

autoImport (true | false) >

References an JET2 tag library.

id - The tag library id. Example: org.eclipse.jet.controlTags
usePrefix - The prefix to use for the tag library when the tag library is auto imported into the project's templates.
autoImport - Indicates whether the project's templates should implicitly import the tags in this library.

<!ELEMENT description (#PCDATA)>

A textual description of the transformation.

<!ELEMENT enablement ( not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate)*>

A generic root element. The element can be used inside an extension point to define its enablement expression. The children of an enablement expression are combined using the and operator.

This element represent a NOT operation on the result of evaluating it's sub-element expression.

<!ELEMENT and ( not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate)*>

This element represent an AND operation on the result of evaluating all it's sub-elements expressions.

<!ELEMENT or ( not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate)*>

This element represent an OR operation on the result of evaluating all it's sub-element expressions.

<!ELEMENT instanceof EMPTY>

<!ATTLIST instanceof

value CDATA #REQUIRED>

This element is used to perform an instanceof check of the object in focus. The expression returns EvaluationResult.TRUE if the object's type is a sub type of the type specified by the attribute value. Otherwise EvaluationResult.FALSE is returned.

value - a fully qualified name of a class or interface.

<!ELEMENT test EMPTY>

<!ATTLIST test

property CDATA #REQUIRED

args CDATA #IMPLIED

value CDATA #IMPLIED

forcePluginActivation (true | false) >

This element is used to evaluate the property state of the object in focus. The set of testable properties can be extended using the propery tester extension point. The test expression returns EvaluationResult.NOT_LOADED if the property tester doing the actual testing isn't loaded yet and the attribute forcePluginActivation is set to false. If forcePluginActivation is set to true and the evaluation context used to evaluate this expression support plug-in activation then evaluating the property will result in activating the plug-in defining the tester.

property - the name of an object's property to test.
args - additional arguments passed to the property tester. Multiple arguments are seperated by commas. Each individual argument is converted into a Java base type using the same rules as defined for the value attribute of the test expression.
value - the expected value of the property. Can be omitted if the property is a boolean property. The test expression is supposed to return EvaluationResult.TRUE if the property matches the value and EvaluationResult.FALSE otherwise. The value attribute is converted into a Java base type using the following rules:
- the string "true" is converted into Boolean.TRUE
- the string "false" is converted into Boolean.FALSE
- if the string contains a dot then the interpreter tries to convert the value into a Float object. If this fails the string is treated as a java.lang.String
- if the string only consists of numbers then the interpreter converts the value in an Integer object.
- in all other cases the string is treated as a java.lang.String
- the conversion of the string into a Boolean, Float, or Integer can be suppressed by surrounding the string with single quotes. For example, the attribute value="'true'" is converted into the string "true"
forcePluginActivation - a flag indicating whether the plug-in contributing the property tester should be loaded if necessary. As such, this flag should be used judiciously, in order to avoid unnecessary plug-in activations. Most clients should avoid setting this flag to true. This flag is only honored if the evaluation context used to evaluate this expression allows plug-in activation. Otherwise the flag is ignored and no plug-in loading takes place.

<!ELEMENT systemTest EMPTY>

<!ATTLIST systemTest

property CDATA #REQUIRED

value CDATA #REQUIRED>

Tests a system property by calling the System.getProperty method and compares the result with the value specified through the value attribute.

property - the name of an system property to test.
value - the expected value of the property. The value is interpreted as a string value.

<!ELEMENT equals EMPTY>

<!ATTLIST equals

value CDATA #REQUIRED>

This element is used to perform an equals check of the object in focus. The expression returns EvaluationResult.TRUE if the object is equal to the value provided by the attribute value. Otherwise EvaluationResult.FALSE is returned.

value - the operatand of the equals tests. The value provided as a string is converted into a Java base type using the same rules as for the value attribute of the test expression.

<!ELEMENT count EMPTY>

<!ATTLIST count

value CDATA #REQUIRED>

This element is used to test the number of elements in a collection.

value - an expression to specify the number of elements in a list. Following wildcard characters can be used:

*

any number of elements

?

no elements or one element

+

one or more elements

!

no elements

integer value

the list must contain the exact number of elements

<!ELEMENT with ( not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate)*>

<!ATTLIST with

variable CDATA #REQUIRED>

This element changes the object to be inspected for all its child element to the object referneced by the given variable. If the variable can not be resolved then the expression will throw a ExpressionException when evaluating it. The children of a with expression are combined using the and operator.

variable - the name of the variable to be used for further inspection. It is up to the evaluator of an extension point to provide the variable in the variable pool.

<!ELEMENT resolve ( not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate)*>

<!ATTLIST resolve

variable CDATA #REQUIRED

args CDATA #IMPLIED>

variable - the name of the variable to be resolved. This variable is then used as the object in focus for child element evaluation. It is up to the evaluator of an extension point to provide a corresponding variable resolver (see IVariableResolver) through the evaluation context passed to the root expression element when evaluating the expression.
args - additional arguments passed to the variable resolver. Multiple arguments are seperated by commas. Each individual argument is converted into a Java base type using the same rules as defined for the value attribute of the test expression.

<!ELEMENT adapt ( not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate)*>

<!ATTLIST adapt

type CDATA #REQUIRED>

This element is used to adapt the object in focus to the type specified by the attribute type. The expression returns not loaded if either the adapter or the type referenced isn't loaded yet. It throws a ExpressionException during evaluation if the type name doesn't exist at all. The children of an adapt expression are combined using the and operator.

type - the type to which the object in focus is to be adapted.

<!ELEMENT iterate ( not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate)*>

<!ATTLIST iterate

operator (or|and) >

This element is used to iterate over a variable that is of type java.util.Collection. If the object in focus is not of type java.util.Collection then an ExpressionException will be thrown while evaluating the expression.

operator - either "and" or "or". The operator defines how the child elements will be combined. If not specified, "and" will be used.

[Enter extension point usage example here.]

[Enter API information here.]

[Enter information about supplied implementation of this extension point.]

JET Transformation

Identifier:

Since:

Description:

Configuration Markup:

Examples:

API Information:

Supplied Implementation: