MDWorkbench Service

Identifier:

com.sodius.mdw.platform.services.service

Since:

MDWorkbench 3.0

Description:

This extension is used to add new services. A service provides a piece of functionnality that the user can execute, usually based on model or model element arguments. An example of service is the export of HTML pages based on a model.

Configuration Markup:

<!ELEMENT extension (category* , service* , helpService* , ruleService* , operationService*)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

point - a fully qualified identifier of the target extension point
id - an optional identifier of the extension instance
name - an optional name of the extension instance

<!ELEMENT category EMPTY>

<!ATTLIST category

id CDATA #REQUIRED

name CDATA #REQUIRED

parentId CDATA #IMPLIED>

id - a unique name that will be used to identify this category
name - a translatable name that will be used in the UI for this category
parentId - an id of another category if this category should be added as a child

<!ELEMENT service (description? , property*)>

<!ATTLIST service

id CDATA #REQUIRED

name CDATA #REQUIRED

icon CDATA #IMPLIED

category IDREF #IMPLIED

launcher CDATA #REQUIRED

helpContextId CDATA #IMPLIED>

SODIUS internal usage

id - a unique name that will be used to identify this service
name - a translatable name that will be used in the UI for this service
icon - a relative name of the icon that will be used to display this service
category - the id of the containing category, if any
launcher -
helpContextId -

<!ELEMENT helpService (description? , property*)>

<!ATTLIST helpService

id CDATA #REQUIRED

name CDATA #REQUIRED

icon CDATA #IMPLIED

category IDREF #IMPLIED

href CDATA #REQUIRED

helpContextId CDATA #IMPLIED>

a service aimed to open a specific help page

id - a unique name that will be used to identify this service
name - a translatable name that will be used in the UI for this service
icon - a relative name of the icon that will be used to display this service
category - the id of the containing category, if any
href - the href of the HTML resource to display
helpContextId -

<!ELEMENT ruleService (description? , property* , editableTemplate* , (rule? | template?))>

<!ATTLIST ruleService

id CDATA #REQUIRED

name CDATA #REQUIRED

icon CDATA #IMPLIED

category IDREF #IMPLIED

launcher CDATA #IMPLIED

helpContextId CDATA #IMPLIED>

a service used to launch a generation or a transformation, based on a ruleset execution

id - a unique name that will be used to identify this service
name - a translatable name that will be used in the UI for this service
icon - a relative name of the icon that will be used to display this service
category - the id of the containing category, if any. Here are some standard categories:
- Import: com.sodius.mdw.platform.services.importCategory
- Export: com.sodius.mdw.platform.services.exportCategory
launcher - SODIUS internal usage
helpContextId -

<!ELEMENT operationService (description? , property*)>

<!ATTLIST operationService

id CDATA #REQUIRED

name CDATA #REQUIRED

icon CDATA #IMPLIED

category IDREF #IMPLIED

wizard CDATA #IMPLIED

factory CDATA #REQUIRED

helpContextId CDATA #IMPLIED>

a service used to execute a com.sodius.mdw.core.operations.Operation. @since 3.6.0

id - a unique name that will be used to identify this service
name - a translatable name that will be used in the UI for this service
icon - a relative name of the icon that will be used to display this service
category - the id of the containing category, if any. Here are some standard categories:
- Import: com.sodius.mdw.platform.services.importCategory
- Export: com.sodius.mdw.platform.services.exportCategory
wizard - An optional org.eclipse.jface.wizard.IWizard to display before executing the operation. The wizard allows the user to configure some settings. The wizard must store those options in its associated IDialogSettings instance. The content of the IDialogSettings is then given as properties to the OperationContext provided to the related OperationFactory.
factory - the com.sodius.mdw.core.operations.OperationFactory that instantiates the main Operation to execute. The framework calls the create() method of the factory, with an OperationContext that contains properties for each entry of the IDialogSettings of the wizard declared in this extension. The execution is then performed by the framework, not by the factory.
helpContextId -

<!ELEMENT property EMPTY>

<!ATTLIST property

name CDATA #REQUIRED

value CDATA #REQUIRED>

defines a property to customize the service launcher

name - name of the property
value - value of the property

<!ELEMENT description (#PCDATA)>

a description of the purpose of this service, presented to the user in the service selection wizard.

<!ELEMENT rule (stringParameter* , metamodelParameter* , instanceParameter* , modelParameter* , fileParameter* , directoryParameter*)>

<!ATTLIST rule

ruleSet CDATA #REQUIRED

rule CDATA #REQUIRED

evalDirSelection (none|directory) >

the main rule to launch

ruleSet - the qualified name of the ruleset (e.g. "foo.bar.MyRuleSet")
rule - the simple name of the rule (e.g. "main")
evalDirSelection - determines if an evaluation direction selection is required. This is typically true for code generators, but generally useless for model transformations.

<!ELEMENT template (stringParameter* , metamodelParameter* , instanceParameter* , modelParameter* , fileParameter* , directoryParameter*)>

<!ATTLIST template

template CDATA #REQUIRED

evalDirSelection (none|directory) >

the main template to launch

template - the qualified name of the template (e.g. "foo.bar.MyTemplate")
evalDirSelection - determines if an evaluation direction selection is required.
Tip: if the service generates only one file, a good pratice is to introduce a ruleset that takes a File parameter and that calls the template. Then the user can select a file rather than setting an evaluation directory.

<!ELEMENT stringParameter EMPTY>

<!ATTLIST stringParameter

value CDATA #IMPLIED

fixed (true | false)

wizardTitle CDATA #IMPLIED

wizardDescription CDATA #IMPLIED

helpContextId CDATA #IMPLIED>

a parameter for any String value. The String will be converted as required to match a rule parameter of type number or boolean.

value - the String default value
fixed - if true, the value is fixed and the user can't modify it (this parameter won't appear in the service wizard)
wizardTitle - the title in the service wizard for this parameter
wizardDescription - the description in the service wizard for this parameter
helpContextId -

<!ELEMENT metamodelParameter EMPTY>

<!ATTLIST metamodelParameter

wizardTitle CDATA #IMPLIED

wizardDescription CDATA #IMPLIED

helpContextId CDATA #IMPLIED>

a parameter for a metamodel. If the rule parameter is a String, this parameter will set the unique ID of the selected metamodel.

wizardTitle - the title in the service wizard for this parameter
wizardDescription - the description in the service wizard for this parameter
helpContextId -

<!ELEMENT instanceParameter (viewerFilter*)>

<!ATTLIST instanceParameter

modelId CDATA #REQUIRED

typeName CDATA #REQUIRED

selection (single|multiList|multiBag|multiChecked)

allowEmptySelection (true | false)

wizardTitle CDATA #IMPLIED

wizardDescription CDATA #IMPLIED

helpContextId CDATA #IMPLIED>

a parameter for model elements

modelId - the id of the model parameter these instances are part of
typeName - the simple type name (e.g. "MyClass") of instance to select. This type can be abstract, in which case instances of all subtypes will be displayed in the selection wizard.
selection - determines the type of instance selection to perform.
allowEmptySelection - if true, enables the user to run the service without selecting any instance for this parameter.
wizardTitle - the title in the service wizard for this parameter
wizardDescription - the description in the service wizard for this parameter
helpContextId -

<!ELEMENT modelParameter EMPTY>

<!ATTLIST modelParameter

direction (in|out|inout)

modelId CDATA #IMPLIED

metamodel CDATA #IMPLIED

wizardTitle CDATA #IMPLIED

wizardDescription CDATA #IMPLIED

helpContextId CDATA #IMPLIED

restriction (none|editedModel) >

a parameter for Models

direction - determines the model usage (input/output)
modelId - an optional id, required in case an instance parameter is set on this model.
metamodel - the metamodel this model conforms to
wizardTitle - the title in the service wizard for this parameter
wizardDescription - the description in the service wizard for this parameter
helpContextId -
restriction - an optional restriction on the type of model the service can handle. "editedModel" implies the user will be able to select only models that are currently edited in a model editor in the service wizard.

<!ELEMENT fileParameter (fileExtension*)>

<!ATTLIST fileParameter

mode (open|save)

value CDATA #IMPLIED

selectAndReveal (true | false)

activate (true | false)

wizardTitle CDATA #IMPLIED

wizardDescription CDATA #IMPLIED

helpContextId CDATA #IMPLIED>

a parameter for Files (not directories).

mode - determines the file usage
value - the default filename
selectAndReveal - if true, the saved file will be selected in the project explorer (if the file is part of the workspace)
activate - if true, the saved file is opened in an editor
wizardTitle - the title in the service wizard for this parameter
wizardDescription - the description in the service wizard for this parameter
helpContextId -

<!ELEMENT directoryParameter EMPTY>

<!ATTLIST directoryParameter

mode (open|save)

value CDATA #IMPLIED

selectAndReveal (true | false)

wizardTitle CDATA #IMPLIED

wizardDescription CDATA #IMPLIED

helpContextId CDATA #IMPLIED>

a parameter for directory selection.

mode - determines the directory usage
value - the default directory name
selectAndReveal - if true, the directory will be selected in the project explorer (if the folder is part of the workspace)
wizardTitle - the title in the service wizard for this parameter
wizardDescription - the description in the service wizard for this parameter
helpContextId -

<!ELEMENT editableTemplate (description?)>

<!ATTLIST editableTemplate

name CDATA #REQUIRED

path CDATA #REQUIRED

kind (docTemplate|textTemplate) >

defines a template part of the plugin that the user must be able to edit and modify. The user can edit such template starting from the Properties dialog on the service. Note that the plugin must be deployed as a directory, not as a jar.

name - a translatable name that will be used in the UI for this template
path - a relative name of the template
kind - the type of template

<!ELEMENT viewerFilter EMPTY>

<!ATTLIST viewerFilter

class CDATA #REQUIRED>

a filter used to restrict instances the user can select

class - a class that extends org.eclipse.jface.viewers.ViewerFilter

<!ELEMENT fileExtension EMPTY>

<!ATTLIST fileExtension

description CDATA #REQUIRED

extension CDATA #REQUIRED

default (true | false) >

a file extension to add filters on file selection dialog

description - the description of this extension
extension - the file extension (e.g. "xml")
default - if true, this extension is the default filter selected in the file selection dialog. If no default extension is set, the "All Suppported Files" filter is selected.

Examples:

Following is an example of a Rule Service extension:


  <extension
        point="com.sodius.mdw.platform.services.service">
      <ruleService
            id="com.sodius.mdw.services.generate.java"
            name="Java Generation">
         <description>
            Generates a Java class for each Class of a UML 2.1 model
         </description>
         <rule
               evalDirSelection="directory"
               rule="main"
               ruleSet="com.sodius.mdw.samples.java.JavaGeneration">
            <modelParameter
                  direction="in"
                  metamodel="uml21"
                  modelId="model"/>
         </rule>
      </ruleService>
  </extension>
</extension>

Following is an example of a Help Service extension:


  <extension
        point="com.sodius.mdw.platform.services.service">
      <helpService
            href="/com.sodius.mdw.platform.rdt.doc/gettingStarted/overview.html"
            id="com.tests.overviewHelp"
            name="MDWorkbench Overview">
         <description>
            Open MDWorkbench Overview help
         </description>
      </helpService>
  </extension>
</extension>

SODIUS