Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "MoDisco/KDMSourceDiscoverer"

(First version)
 
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
The goal of KDM Source Discoverer plugin is to allow practical extractions of KDM Source models from the file hierarchy of an application.
+
#REDIRECT [[MoDisco/Components/KDM/Documentation/0.7#KDM_Source_Discoverer]]
 
+
== Details ==
+
 
+
This plugin aims at analysing the file system hierarchy of an application and providing a model describing the information found, conforming to KDM Source sub package. (see next Figure)
+
 
+
[[Image:MoDisco-Kdm Source metamodel.png|frame|center|KDM Source Metamodel]]
+
 
+
The Source package defines a set of meta-model elements whose purpose is to represent the physical artifacts of the
+
existing system, such as source files, images, configuration files, resource descriptions, etc.
+
 
+
For an input folder, the KDM source discoverer visit each folder and file. For each file, it creates the appropriate sub class of InventoryItem using the [[Resources|Resources]] content type API. This plugin defines its own content types to properly classify file types.
+
 
+
== Requirements ==
+
 
+
To use the plug-in you need:
+
* JDK 1.5 or above
+
* a version of Eclipse 3.3 or above with the following set of plugins installed
+
:* [[EMF|EMF]] 2.3.0 or higher
+
:* [[MoDisco/KDM|KDM metamodel]]
+
 
+
== Team ==
+
 
+
Fabien Giquel ([http://www.mia-software.com Mia-Software])
+
 
+
== Install ==
+
 
+
You will find a version of this plug-in attached in [https://bugs.eclipse.org/bugs/show_bug.cgi?id=266356 following bug].
+
 
+
As IP review of this plugin is not finished, here is installation instructions :
+
 
+
* Extract archive file in your Eclipse workspace, then use "import" menu to import this project.
+
* 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.
+
* re-start your Eclipse to take in account this plug-in
+
 
+
== 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.
+
 
+
[[Image:MoDisco-Kdm Source popup menu.png|frame|center|Menus in Eclipse to create KDM Source model]]
+
 
+
A progress bar will appear at the bottom of the window as soon as the operation begins. Depending on the size of your application, the reverse engineering might take some time to complete (see next Figure).
+
+
[[Image:MoDisco-JavaDiscoverer progress bar.jpg|frame|center|Progress bar during models creation]]
+
 
+
At the end of the process, the newly created model files are added at the root of your project and are automatically opened in the default editor (see next Figure).
+
 
+
[[Image:MoDisco-Kdm Source model.png|frame|center|KDM Source model in the package explorer]]
+
 
+
.kdm files could be opened in the Sample Reflexive Ecore Model Editor (see next Figure).
+
 
+
[[Image:MoDisco-KDM Source model in EMF browser.png|frame|center|KDM Source model viewed with EMF browser]]
+
 
+
They could also be opened in MoDisco model browser (see next Figure) which brings some graphical improvements.
+
 
+
[[Image:MoDisco-Kdm Source model in MoDisco browser.png|frame|center|KDM Source model viewed with MoDisco browser]]
+

Latest revision as of 06:50, 7 September 2010

Back to the top