blob: 961c9462b4630aa13a45d42173c3111f38cd1e81 [file] [log] [blame]
<!-- This file was created using the HTML documentation generator. -->
<!-- Creation date: Sun Nov 01 10:49:41 GMT 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.smcubes.model.program/model/cocamo.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="style.css" />
</head>
<body onload="makeTOC();">
<h1 id="cocamo"><a href="#cocamo"><span class="packageName">cocamo</span> package</a></h1>
<p>This Package describes the grouping of artifacts for CoCaMo for SMCubes into a Program.
A program relates to the group of artifacts, and we allow the contents of Programs to reference other programs.</p>
<div class="">EPackage properties:</div>
<div class="keyValue"><span class="label">Namespace Prefix: </span><span class="teletype">cocamo</span></div>
<div class="keyValue"><span class="label">Namespace URI: </span><span class="teletype">http://www.eclipse.org/efbt/cocamo</span></div>
<h2 id="cocamoProgram"><a href="#cocamoProgram"><a href="#cocamoProgram">Program</a></a></h2>
<p>A program relates to the group of artifacts, and we allow the contents of Programs to reference other programs.</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="cocamoProgram.functionalityModules" class="teletype">functionalityModules</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#functionalitymoduleFunctionalityModuleModule">FunctionalityModuleModule</a></span></div>
<div class="label">Cardinality: [0..1]</div>
<div class="label">Containment</div>
</td>
<td> <p>The FunctionaltyModules associated with the program, these will be refrence by FunctionalityModules</p>
</td>
</tr><tr> <td><div id="cocamoProgram.requirements" class="teletype">requirements</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#requirementstextRequirementsModule">RequirementsModule</a></span></div>
<div class="label">Cardinality: [0..1]</div>
<div class="label">Containment</div>
</td>
<td> <p>The requirements associated with the program, these will be refrence by FunctionalityModules</p>
</td>
</tr><tr> <td><div id="cocamoProgram.smCubesModel" class="teletype">smCubesModel</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#smcubesmodelSmcubesModel">SmcubesModel</a></span></div>
<div class="label">Cardinality: [0..1]</div>
<div class="label">Containment</div>
</td>
<td> <p>The SMCubes Model associated with the Program</p>
</td>
</tr><tr> <td><div id="cocamoProgram.testConstriants" class="teletype">testConstriants</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#testdefinitionTestContraints">TestContraints</a></span></div>
<div class="label">Cardinality: [0..1]</div>
<div class="label">Containment</div>
</td>
<td> <p>The TestConstraints associated with the program, these will be refrence by FunctionalityModules</p>
</td>
</tr><tr> <td><div id="cocamoProgram.testDefinitions" class="teletype">testDefinitions</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#testdefinitionTestDefinitionModule">TestDefinitionModule</a></span></div>
<div class="label">Cardinality: [0..1]</div>
<div class="label">Containment</div>
</td>
<td> <p>The TestDefinitions associated with the program, these will be refrence by FunctionalityModules</p>
</td>
</tr><tr> <td><div id="cocamoProgram.testTemplates" class="teletype">testTemplates</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#testdefinitionTestTemplateModule">TestTemplateModule</a></span></div>
<div class="label">Cardinality: [0..1]</div>
<div class="label">Containment</div>
</td>
<td> <p>The TestTemplates associated with the program, these will be refrence by FunctionalityModules</p>
</td>
</tr><tr> <td><div id="cocamoProgram.tests" class="teletype">tests</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#cocamoSMCubesTestModule">SMCubesTestModule</a></span></div>
<div class="label">Cardinality: [0..1]</div>
<div class="label">Containment</div>
</td>
<td> <p>The Tests associated with the program, these will be refrence by FunctionalityModules</p>
</td>
</tr></table>
<a href="#cocamo.Program.ref"></a>
<h2 id="cocamoSMCubesReportResults"><a href="#cocamoSMCubesReportResults"><a href="#cocamoSMCubesReportResults">SMCubesReportResults</a></a></h2>
<p>Expected results which follwo the way that SMCubes represents Report Celss (As COMBINATIONs)</p>
<h4><b>Supertype:</b><a href="#testResult">Result</a></h4><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="cocamoSMCubesReportResults.reportCells" class="teletype">reportCells</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#reportsReportCellValue">ReportCellValue</a></span></div>
<div class="label">Cardinality: [0..*]</div>
<div class="label">Containment</div>
</td>
<td> <p>The value of a ReportCell</p>
</td>
</tr></table>
<a href="#cocamo.SMCubesReportResults.ref"></a>
<h2 id="cocamoSMCubesTest"><a href="#cocamoSMCubesTest"><a href="#cocamoSMCubesTest">SMCubesTest</a></a></h2>
<p>A test specific to the SMCubes methodolgy of describing Input Data structures and Output DataStructures (As cubes of typically COMBINATIONS representing report cells)</p>
<h4><b>Supertype:</b><a href="#testE2ETest">E2ETest</a></h4><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="cocamoSMCubesTest.expectedResults" class="teletype">expectedResults</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#cocamoSMCubesReportResults">SMCubesReportResults</a></span></div>
<div class="label">Cardinality: [0..1]</div>
</td>
<td> <p>The expected results</p>
</td>
</tr><tr> <td><div id="cocamoSMCubesTest.inputData" class="teletype">inputData</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#cocamoSMCubesTestInputData">SMCubesTestInputData</a></span></div>
<div class="label">Cardinality: [0..1]</div>
<div class="label">Containment</div>
</td>
<td> <p>The input data</p>
</td>
</tr></table>
<a href="#cocamo.SMCubesTest.ref"></a>
<h2 id="cocamoSMCubesTestInputData"><a href="#cocamoSMCubesTestInputData"><a href="#cocamoSMCubesTestInputData">SMCubesTestInputData</a></a></h2>
<p>InputData for that represents instances of SMCubesModels, they are set of rws of data meeting the cube structure of an associated cube</p>
<h4><b>Supertype:</b><a href="#testinputdataTestInputData">TestInputData</a></h4><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="cocamoSMCubesTestInputData.smcubes_inputdata" class="teletype">smcubes_inputdata</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#basecolumnstructureddataBaseColumnStructuredData">BaseColumnStructuredData</a></span></div>
<div class="label">Cardinality: [0..*]</div>
<div class="label">Containment</div>
</td>
<td> <p>The input data</p>
</td>
</tr></table>
<a href="#cocamo.SMCubesTestInputData.ref"></a>
<h2 id="cocamoSMCubesTestModule"><a href="#cocamoSMCubesTestModule"><a href="#cocamoSMCubesTestModule">SMCubesTestModule</a></a></h2>
<p>A module containing a set of SMCubesTests</p>
<h4><b>Supertype:</b><a href="#testTestModule">TestModule</a></h4><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="cocamoSMCubesTestModule.tests" class="teletype">tests</div>
</td>
<td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#cocamoSMCubesTest">SMCubesTest</a></span></div>
<div class="label">Cardinality: [0..*]</div>
<div class="label">Containment</div>
</td>
<td> <p>The tests</p>
</td>
</tr></table>
<a href="#cocamo.SMCubesTestModule.ref"></a>
</body>
</html>