Abstract
This plug-in provides the modeling and maintenance of OpenSAGA applications.
Table of Contents
First please make sure that the following requirenments are satisfied:
Eclipse IDE Version 3.3+
JDK (Java Development Kit) version 1.5+
Installation Instructions for Eclipse Galileo:
Go to: Help -> Install new software.
Click on "Add.." and paste the OpenSAGA update site URL http://www.opensaga.org/osclipse/updates into.
Choose "OpenSAGA Feature".
Click "Next" and follow the prompts.
Restart the IDE.
Go to: File -> New -> Dynamic Web Project.
Choose your server runtime, "Dynamic web module version" 2.5 and "OpenSAGA Project" facet under "Configuration".
Click "Next" and follow the prompts.
On the last page of wizard specify the OpenSAGA sources path and the OpenSAGA extensions to use (optional).
Click "Finish".
Choose New -> "OpenSAGA extension" from the project context menu (right-click inside the project in Extension Explorer view) or click extension icon in the Eclipse toolbar.
Specify the name and container for new extension and click "Finish".
Choose New -> "OpenSAGA model" from the extension context menu (right-click inside the extension in Extension Explorer view) or click model icon in the Eclipse toolbar.
Specify the model type, container and name. The model ID will be generated automatically, if checkbox "Generate" is selected.
Click "Finish" to create a new OpenSAGA model.
Choose OpenSAGA -> "Duplicate model" from the model context menu (right-click inside the OpenSAGA model in Extension Explorer view) .
Specify the ID, name and container for a new model and click "Finish".
This editor extends the Eclipse WST editor for XML. The OpenSAGA models will be detected by XSD and opened with OpenSAGA editor. The following features are available:
Reference attribute value completion. The completion dialog can be opened by CTRL+BLANK. The set of completion proposals contains the model IDs can be specified for given reference attribute.
Detecting references. The referenced models can be open in editor by CTRL + click.
Model validation. The correctness of model constraints will be checked automatically by editing the model. Therefore the "Batch-Validation" can be invoked by choosing "Validate" from the context menu in editor or in the Extension Explorer view (right-click inside the resource).
In the current version of plug-in the following validation rules are implemented:
Checking existence of specified model references. If the referenced model doesn't exist, you can create this by clicking CTRL+1 and using the following quick fix:
Validating uniqueness of specified model IDs.
Checking type safety of defined model references.
Validating (required) reference value exists.
Checking of OpenSAGA naming conventions for model IDs.
Model ID Refactoring can be invoked by clicking CTRL+1 and choosing "Refactor this ID" from the quick fix.
Specify new ID:
It is possible to update all references to this ID, if the checkbox "update references" is selected. By clicking "Finish" the model ID value (optional: references) will be changed.
To open the "OpenSAGA Perspective" go to Window -> Open Perspective -> OpenSAGA or use the context menu of the "Open Perspective" toolbar button.
This view represents the OpenSAGA modeling artefacts - projects, extensions, models - and shows the structure of OpenSAGA modeling projects. A project also contains extensions, the extensions contains models, where will be logical grouping by specified modeling artefacts (f.e. domain types or processes). Therefore toggling button "Filter unused extensions" on the view toolbar hides unused project extensions.
This view shows the OpenSAGA modeling problems detected by validation. The problem description contains the case, location, model resource and the OpenSAGA extension of this resource. By double-clicking the problem entry the OpenSAGA editor automatically opens associated model resource to the relevant line.
The "OpenSAGA Model Handler" component is an eclipse workspace job for analyzing the OpenSAGA models. If the automatical model handling is enabled (see preferences) the intern plug-in datasets will be automatically updated. Otherwise (f.e. after subversion checkout) it is recommended to use the manual models build process by choosing "Clean and build OpenSAGA models" from the project context menu (right-click inside the project) in Extension Explorer view.
Go to Window -> Preferences -> OpenSAGA to configure the following plug-in preferences:
The "base source path" will be used to define the default OpenSAGA framework sources path for plug-in.
In the "Model Handling" preference page the automatical build and validation processes can be enabled and the model validators selected.
In the "Templates" page the model templates can be configured, where will be used to create new OpenSAGA models.
