SCA/Components/SCA XML Editor

From Eclipsepedia

Jump to: navigation, search

TODO: add screenshots.


Contents

Basic Features

The SCA Composite XML editor extends and specialized the XML editor provided by the WTP Eclipse project. Thus, this editor inherits from the following features :

  • syntax highlighting
  • text formatting
  • XSD-based validation
  • ...

As a basic feature, the editor is automatically associated with *.composite files. It also uses the SCA XSD files to validate your file and provide auto-completion for mark-ups and attribute names.


Advanced Features

This editor provides three additional features the default XML editor does not offer.


Attribute Values Proposals

The first one consists in making auto-completion proposals for attribute values. Once you have entered an attribute name and that you are about to define its value, you can ask for auto-completion proposals by typing in ctrl + space. If the attribute is one of the supported ones, then you should get some proposals based on context information.

Currently, the editor proposes values for the following attributes:

  1. attribute promote from composite service mark-up
  2. attribute promote from composite reference mark-up
  3. attributes source and target from composite wire mark-up
  4. attribute target from component reference mark-up
  5. attribute name from composite include mark-up

The five first quoted attributes will get SCA relative URIs ( componentName/serviceName or componentName/referenceName ) as proposals. The proposals which are made take in account included composites, which means that proposals will include components from included composites. Composite inclusion is discussed in the next section.


Composite Inclusions

SCA assembly model provides an inclusion mechanism which allows a composite file to include several other composite files. A good example of this mechanism is available in the assembly model document of the SCA specification.

The SCA Composite XML editor can help you when using composite inclusion. When typing <include name", you can ask for auto-completion proposals by typing in ctrl + space. This will display the composites available in your project (and not already included in your file). The proposals only include composites which are valid XML files. Besides, they must have defined the targetNamespace attribute.

Since include names are QNames, the editor makes sure to add the namespace prefix to get a correct result. If the namespace URI was already defined in your document, the proposal will reuse its prefix. Otherwise, it will generate one and add it in the mark-up.

Auto-completion will use included files to make proposals. However, notice that recursive inclusions are not managed by this editor, since it is still not clear about how runtime platforms will handle it.

SCA Outline View

Eventually, the editor provides a SCA specific outline view. This view displays composite elements with their icon (the same one than those used by the SCA Composite Designer). As the previous features, this outline integrates included files. For the moment, the view provides very basic actions, but they will be extended in a future version.