blob: 175ed1b71408ef929a85992bc29d54c8cd39d981 [file] [log] [blame]
<!-- This file was created using the HTML documentation generator. -->
<!-- Creation date: Mon Sep 21 17:09:31 BST 2020-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Metamodel Documentation (platform:/resource/org.eclipse.efbt.cocamo.core.model.module_management/model/module_management.ecore)</title>
<script type="text/javascript">
//<![CDATA[
// TOC script based on code taken from http://www.quirksmode.org/dom/toc.html
function makeTOC() {
var toc = document.createElement('div')
toc.id = "toc";
toc.innerHTML = "Table of Contents"
document.body.appendChild(toc);
var innertocDiv = createTOC()
toc.appendChild(innertocDiv);
}
function createTOC() {
var y = document.createElement('div');
y.id = 'innertoc';
//var a = y.appendChild(document.createElement('span'));
//a.onclick = showhideTOC;
//a.id = 'contentheader';
//a.innerHTML = 'Show Table of Contents';
var z = y.appendChild(document.createElement('div'));
//z.onclick = showhideTOC;
var toBeTOCced = getElementsByTagNames('h1,h2,h3');
if (toBeTOCced.length < 2) return false;
var hCount = 0;
var hhCount = 0;
var hhhCount = 0;
for (var i=0;i<toBeTOCced.length;i++) {
var tmp = document.createElement('a');
tmp.className = 'page';
var text;
var textPre;
if (toBeTOCced[i].nodeName == 'h2'){
tmp.className += ' indent';
textPre = hCount + "."+ ++hhCount + ". ";
}
else if (toBeTOCced[i].nodeName == 'h3'){
tmp.className += ' extraindent';
textPre = hCount + "."+ hhCount + "."+ ++hhhCount +". ";
}
else {
textPre = ++hCount + ". ";
hhCount = 0;
hhhCount = 0;
}
text = textPre + toBeTOCced[i].textContent;
toBeTOCced[i].innerHTML = textPre + toBeTOCced[i].innerHTML;
tmp.innerHTML = text;
z.appendChild(tmp);
var headerId = toBeTOCced[i].id || 'link' + i;
tmp.href = '#' + headerId;
toBeTOCced[i].id = headerId;
}
return y;
}
function getElementsByTagNames(list,obj) {
if (!obj) var obj = document;
var tagNames = list.split(',');
var resultArray = new Array();
for (var i=0;i<tagNames.length;i++) {
var tags = obj.getElementsByTagName(tagNames[i]);
for (var j=0;j<tags.length;j++) {
resultArray.push(tags[j]);
}
}
var testNode = resultArray[0];
if (!testNode) return [];
if (testNode.sourceIndex) {
resultArray.sort(function (a,b) {
return a.sourceIndex - b.sourceIndex;
});
}
else if (testNode.compareDocumentPosition) {
resultArray.sort(function (a,b) {
return 3 - (a.compareDocumentPosition(b) & 6);
});
}
return resultArray;
}
//]]>
</script>
<link rel="stylesheet" type="text/css" href="https://raw.github.com/necolas/normalize.css/master/normalize.css" />
<style>
#toc {
position: fixed;
right: 0;
top: 0;
background-color:#eee;
overflow: scroll;
border: 1px dashed;
}
#toc #innertoc {
display: none;
height: 500px;
} /* Hide the full TOC by default */
#toc:hover #innertoc{
display: block; /* Show it on hover */
}
td {
border: 1px solid;
}
.page{
display:table-row;
}
.indent {
text-indent:12pt;
}
.extraindent {
text-indent:14pt;
}
</style>
<link rel="stylesheet" type="text/css" href="css/style.css" />
</head>
<body onload="makeTOC();">
<h1 id="modulemanagement"><a href="#modulemanagement"><span class="packageName">module_management</span> package</a></h1>
<p>This package describes Module Management classes.
These classes allow items to be grouped together and given a version. For example a FunctionSpecModule will contain a group of FunctionSpecs.
Modules can also state which other modules they depend upon, allowing for fine grained dependencies between groups of items.</p>
<div class="">EPackage properties:</div>
<div class="keyValue"><span class="label">Namespace Prefix: </span><span class="teletype">module_management</span></div>
<div class="keyValue"><span class="label">Namespace URI: </span><span class="teletype">http://www.eclipse.org/efbt/module_management</span></div>
<h2 id="modulemanagementModule"><a href="#modulemanagementModule"><a href="#modulemanagementModule">Module</a></a></h2>
<p>A grouping of related artifacts, persisted as a resource, with a version number, and a description, and a description of which Modules it depends upon (and importantly which version of those Modules).</p>
<div class="eclassProps">EClass properties:<div class="eclassPropList"><span class="label">Abstract</span></div></div><table>
<tr>
<th colspan="3"><div class="tableHeader">Attributes</div></th>
</tr>
<tr>
<th><div class="columnHeader">Name</div></th>
<th><div class="columnHeader">Properties</div></th>
<th><div class="columnHeader">Documentation</div></th>
</tr>
<tr> <td><div id="modulemanagementModule.license" class="teletype">license</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype">EString</span></div>
<div class="label">Cardinality: [0..1]</div>
</td> <td><p>The license under which this module is distributed.</p>
</td>
</tr><tr> <td><div id="modulemanagementModule.name" class="teletype">name</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype">EString</span></div>
<div class="label">Cardinality: [0..1]</div>
<div class="label">Identifier</div>
</td> <td><p>The name of the module. This name acts as the modules identifier.</p>
</td>
</tr><tr> <td><div id="modulemanagementModule.theDescription" class="teletype">theDescription</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype">EString</span></div>
<div class="label">Cardinality: [0..1]</div>
</td> <td><p>The description of the module</p>
</td>
</tr><tr> <td><div id="modulemanagementModule.version" class="teletype">version</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype">EString</span></div>
<div class="label">Cardinality: [0..1]</div>
</td> <td><p>The version number of the module</p>
</td>
</tr></table>
<a href="#module_management.Module.attr"></a>
<table>
<tr>
<th colspan="3"><div class="tableHeader">References</div></th>
</tr>
<tr>
<th><div class="columnHeader">Name</div></th>
<th><div class="columnHeader">Properties</div></th>
<th><div class="columnHeader">Documentation</div></th>
</tr>
<tr> <td><div id="modulemanagementModule.dependencies" class="teletype">dependencies</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#modulemanagementModuleDependencies">ModuleDependencies</a></span></div>
<div class="label">Cardinality: [0..1]</div>
<div class="label">Containment</div>
</td>
<td> <p>These are the modules (and their version numbers) upon which this module is dependent.</p>
</td>
</tr><tr> <td><div id="modulemanagementModule.longName" class="teletype">longName</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#modulemanagementModuleLongName">ModuleLongName</a></span></div>
<div class="label">Cardinality: [0..1]</div>
<div class="label">Containment</div>
</td>
<td> <p>The long name associated with the module.</p>
</td>
</tr></table>
<a href="#module_management.Module.ref"></a>
<h2 id="modulemanagementModuleDependencies"><a href="#modulemanagementModuleDependencies"><a href="#modulemanagementModuleDependencies">ModuleDependencies</a></a></h2>
<p>a list of module dependencies</p>
<table>
<tr>
<th colspan="3"><div class="tableHeader">References</div></th>
</tr>
<tr>
<th><div class="columnHeader">Name</div></th>
<th><div class="columnHeader">Properties</div></th>
<th><div class="columnHeader">Documentation</div></th>
</tr>
<tr> <td><div id="modulemanagementModuleDependencies.theModules" class="teletype">theModules</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#modulemanagementModuleDependency">ModuleDependency</a></span></div>
<div class="label">Cardinality: [0..*]</div>
<div class="label">Containment</div>
</td>
<td> <p>The dependent Modules</p>
</td>
</tr></table>
<a href="#module_management.ModuleDependencies.ref"></a>
<h2 id="modulemanagementModuleDependency"><a href="#modulemanagementModuleDependency"><a href="#modulemanagementModuleDependency">ModuleDependency</a></a></h2>
<p>A module dependency, including its version number and its long name</p>
<table>
<tr>
<th colspan="3"><div class="tableHeader">Attributes</div></th>
</tr>
<tr>
<th><div class="columnHeader">Name</div></th>
<th><div class="columnHeader">Properties</div></th>
<th><div class="columnHeader">Documentation</div></th>
</tr>
<tr> <td><div id="modulemanagementModuleDependency.moduleName" class="teletype">moduleName</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype">EString</span></div>
<div class="label">Cardinality: [0..1]</div>
</td> <td><p>The name of the dependant Module</p>
</td>
</tr><tr> <td><div id="modulemanagementModuleDependency.moduleVersion" class="teletype">moduleVersion</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype">EString</span></div>
<div class="label">Cardinality: [0..1]</div>
</td> <td><p>The version of the dependent Module</p>
</td>
</tr></table>
<a href="#module_management.ModuleDependency.attr"></a>
<table>
<tr>
<th colspan="3"><div class="tableHeader">References</div></th>
</tr>
<tr>
<th><div class="columnHeader">Name</div></th>
<th><div class="columnHeader">Properties</div></th>
<th><div class="columnHeader">Documentation</div></th>
</tr>
<tr> <td><div id="modulemanagementModuleDependency.longName" class="teletype">longName</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#modulemanagementModuleLongName">ModuleLongName</a></span></div>
<div class="label">Cardinality: [0..1]</div>
</td>
<td> <p>The dependent Module</p>
</td>
</tr><tr> <td><div id="modulemanagementModuleDependency.theModule" class="teletype">theModule</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#modulemanagementModule">Module</a></span></div>
<div class="label">Cardinality: [0..1]</div>
</td>
<td> <p>The dependent Module</p>
</td>
</tr></table>
<a href="#module_management.ModuleDependency.ref"></a>
<h2 id="modulemanagementModuleLongName"><a href="#modulemanagementModuleLongName"><a href="#modulemanagementModuleLongName">ModuleLongName</a></a></h2>
<p>A long name associated with a module</p>
<table>
<tr>
<th colspan="3"><div class="tableHeader">Attributes</div></th>
</tr>
<tr>
<th><div class="columnHeader">Name</div></th>
<th><div class="columnHeader">Properties</div></th>
<th><div class="columnHeader">Documentation</div></th>
</tr>
<tr> <td><div id="modulemanagementModuleLongName.name" class="teletype">name</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype">EString</span></div>
<div class="label">Cardinality: [0..1]</div>
<div class="label">Identifier</div>
</td> <td></td>
</tr></table>
<a href="#module_management.ModuleLongName.attr"></a>
</body>
</html>