Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "MoDisco/XMLDiscoverer"
(→Discovering and serializing from Java) |
(→Discovering and serializing from Java) |
||
| Line 42: | Line 42: | ||
The plugin exposes a discover class which allows to launch the discovering of XML model from a file (within the workspace or not), and get the resulting model. | The plugin exposes a discover class which allows to launch the discovering of XML model from a file (within the workspace or not), and get the resulting model. | ||
| − | Some options can be set for | + | Some options can be set for discovering operation : |
* OPTION_IGNORE_WHITESPACES : a parameter for indicating to ignore white spaces in text portions. | * OPTION_IGNORE_WHITESPACES : a parameter for indicating to ignore white spaces in text portions. | ||
| Line 48: | Line 48: | ||
* OPTION_SILENT_MODE : a parameter to indicate if a browser should be opened on model after discovering. | * OPTION_SILENT_MODE : a parameter to indicate if a browser should be opened on model after discovering. | ||
| + | |||
| + | The XML content can be serialized back since the model elements are contained in a dedicated org.eclipse.emf.ecore.resource.Resource implementation. | ||
For more details see java documentation on DiscoverXMLModel class. | For more details see java documentation on DiscoverXMLModel class. | ||
Revision as of 13:20, 14 August 2009
The goal of Generic XML Discoverer plugin is to allow generic extractions of XML information from a XML file, without the need of a metamodel dedicated to a conforming Document Type Definition(DTD) or XML Schema Description (XSD).
Contents
Details
Considering XML files conforming to DTD or XSD, it will be more convenient to have some dedicated metamodels to manipulate information. However, Generic XML Discoverer is an alternative for miscellaneous XML files (none or uncommon DTD/XSD).
This plugin aims at analysing any XML file providing a model describing the information found, conforming to Generic XML metamodel. Moreover, it allows to serialize back the xml file from the model. Thus, some m2m transformation might be used jointly to upgrade some xml files.
Since the metamodel is a subset of W3C XML concepts, the end user should be aware of limits to the serialization for advanced XML contents.
Requirements
To use the plug-in you need:
- JDK 1.5 or above
- a version of Eclipse 3.5 or above with the following set of plugins installed
- EMF 2.5.0 or higher
- Discoverers Manager
- Generic XML metamodel
Team
Fabien Giquel (Mia-Software)
User manual
The plugin provides the user with a contextual menu to easily create models.
By right-clicking on a container (folder or project) in the Eclipse Package Explorer view, you can quickly create the KDM Source model of your application (see next Figure). Each of these models can then be used with any other tool compliant with the corresponding metamodel.
A progress bar will appear at the bottom of the window as soon as the operation begins. At the end of the process, the newly created model is automatically opened in the MoDisco model browser, if installed, or in default editor (see next Figure).
Discovering and serializing from Java
The plugin exposes a discover class which allows to launch the discovering of XML model from a file (within the workspace or not), and get the resulting model. Some options can be set for discovering operation :
- OPTION_IGNORE_WHITESPACES : a parameter for indicating to ignore white spaces in text portions.
- OPTION_LIGHTWEIGHT_MODEL : to minimize the memory size of obtained model. If set to true : comments are ignored, text portions with only spaces and line delimiters are ignored.
- OPTION_SILENT_MODE : a parameter to indicate if a browser should be opened on model after discovering.
The XML content can be serialized back since the model elements are contained in a dedicated org.eclipse.emf.ecore.resource.Resource implementation.
For more details see java documentation on DiscoverXMLModel class.
Install
Install from SVN
- connect to the SVN repository with anonymous access :
URL = https://dev.eclipse.org/svnroot/modeling/org.eclipse.gmt.modisco
- navigate in repository following 'plugins/trunk' path.
- check-out the project named 'org.eclipse.gmt.modisco.infra.xml.discoverer' .
- Use "export" menu to export this project as a plugin (Deployable plugins and fragments) in your Eclipse installation. Don't forget to choose "Package plug-ins as individual jar archives" option.
- restart Eclipse to take in account this plug-in