| <!-- This file was created using the HTML documentation generator. --> |
| <!-- Creation date: Sun Nov 01 10:45:30 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.core.model.requirements_text/model/requirements_text.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="requirementstext"><a href="#requirementstext"><span class="packageName">requirements_text</span> package</a></h1>
|
|
|
| <p>This package describes the classes for storing Structured Requirements text</p>
|
| <div class="">EPackage properties:</div>
|
| <div class="keyValue"><span class="label">Namespace Prefix: </span><span class="teletype">requirements_text</span></div>
|
| <div class="keyValue"><span class="label">Namespace URI: </span><span class="teletype">http://www.eclipse.org/efbt/requirements_text</span></div>
|
| <h2 id="requirementstextAllowedTypes"><a href="#requirementstextAllowedTypes"><a href="#requirementstextAllowedTypes">AllowedTypes</a></a></h2>
|
|
|
| <p>Allowed Types like article, chapter, rulebook</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="requirementstextAllowedTypes.allowedTypes" class="teletype">allowedTypes</div>
|
| </td>
|
| <td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#requirementstextRequirementType">RequirementType</a></span></div>
|
| <div class="label">Cardinality: [0..*]</div>
|
| <div class="label">Containment</div>
|
| </td>
|
| <td> <p>A set of Allowed types, like article, chapter, rulebook</p> |
| </td>
|
| </tr></table>
|
| <a href="#requirements_text.AllowedTypes.ref"></a>
|
| <h2 id="requirementstextRequirementType"><a href="#requirementstextRequirementType"><a href="#requirementstextRequirementType">RequirementType</a></a></h2>
|
|
|
| <p>A requirement type such as Article, Chapter, Rulebook</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="requirementstextRequirementType.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: [1..1]</div>
|
| <div class="label">Identifier</div>
|
| </td> <td><p>the name of the requirement type</p> |
| </td>
|
| </tr></table>
|
| <a href="#requirements_text.RequirementType.attr"></a>
|
| <h2 id="requirementstextRequirementsModule"><a href="#requirementstextRequirementsModule"><a href="#requirementstextRequirementsModule">RequirementsModule</a></a></h2>
|
|
|
| <p>A Module containing a Set of Requirements</p>
|
| <h4><b>Supertype:</b><a href="#modulemanagementModule">Module</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="requirementstextRequirementsModule.allowedtypes" class="teletype">allowedtypes</div>
|
| </td>
|
| <td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#requirementstextAllowedTypes">AllowedTypes</a></span></div>
|
| <div class="label">Cardinality: [0..1]</div>
|
| <div class="label">Containment</div>
|
| </td>
|
| <td> <p>a set of Allowed types, like article, chapter, rulebook</p> |
| </td>
|
| </tr><tr> <td><div id="requirementstextRequirementsModule.rules" class="teletype">rules</div>
|
| </td>
|
| <td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#requirementstextTitledRequirementsSection">TitledRequirementsSection</a></span></div>
|
| <div class="label">Cardinality: [0..*]</div>
|
| <div class="label">Containment</div>
|
| </td>
|
| <td> <p>A set of top level titled requirement sections</p> |
| </td>
|
| </tr></table>
|
| <a href="#requirements_text.RequirementsModule.ref"></a>
|
| <h2 id="requirementstextRequirementsSection"><a href="#requirementstextRequirementsSection"><a href="#requirementstextRequirementsSection">RequirementsSection</a></a></h2>
|
|
|
| <p>A Requirements Section</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="requirementstextRequirementsSection.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 requirements Section</p> |
| </td>
|
| </tr></table>
|
| <a href="#requirements_text.RequirementsSection.attr"></a>
|
| <h2 id="requirementstextRequirementsSectionImage"><a href="#requirementstextRequirementsSectionImage"><a href="#requirementstextRequirementsSectionImage">RequirementsSectionImage</a></a></h2>
|
|
|
| <p>A Requirements Section represented by an image</p>
|
| <h4><b>Supertype:</b><a href="#requirementstextRequirementsSection">RequirementsSection</a></h4><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="requirementstextRequirementsSectionImage.style" class="teletype">style</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 style string including width and height</p> |
| </td>
|
| </tr><tr> <td><div id="requirementstextRequirementsSectionImage.uri" class="teletype">uri</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 location of the image file</p> |
| </td>
|
| </tr></table>
|
| <a href="#requirements_text.RequirementsSectionImage.attr"></a>
|
| <h2 id="requirementstextRequirementsSectionLinkWithText"><a href="#requirementstextRequirementsSectionLinkWithText"><a href="#requirementstextRequirementsSectionLinkWithText">RequirementsSectionLinkWithText</a></a></h2>
|
|
|
| <p>This is similar to the HTML idea of a HyperLink. It contains some text to be shown as part of the Requirement,
|
| and contains a link to another TitledRequirementsSection in the Requirements. This helps natural navigation of
|
| A requirements document which has multiple cross references between sections</p>
|
| <h4><b>Supertype:</b><a href="#requirementstextRequirementsSection">RequirementsSection</a></h4><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="requirementstextRequirementsSectionLinkWithText.linkText" class="teletype">linkText</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 text that refers to the linked RequirementsSection, like "Article 321" </p> |
| </td>
|
| </tr><tr> <td><div id="requirementstextRequirementsSectionLinkWithText.subsection" class="teletype">subsection</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>Other Text</p> |
| </td>
|
| </tr></table>
|
| <a href="#requirements_text.RequirementsSectionLinkWithText.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="requirementstextRequirementsSectionLinkWithText.linkedRuleSection" class="teletype">linkedRuleSection</div>
|
| </td>
|
| <td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#requirementstextTitledRequirementsSection">TitledRequirementsSection</a></span></div>
|
| <div class="label">Cardinality: [0..1]</div>
|
| <div class="keyValue"><span class="label">Op: </span><span class="teletype">referencingSections</span></div>
|
| </td>
|
| <td> <p>The linked titled requirements section</p> |
| </td>
|
| </tr></table>
|
| <a href="#requirements_text.RequirementsSectionLinkWithText.ref"></a>
|
| <h2 id="requirementstextRequirementsSectionText"><a href="#requirementstextRequirementsSectionText"><a href="#requirementstextRequirementsSectionText">RequirementsSectionText</a></a></h2>
|
|
|
| <p>A section of text</p>
|
| <h4><b>Supertype:</b><a href="#requirementstextRequirementsSection">RequirementsSection</a></h4><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="requirementstextRequirementsSectionText.text" class="teletype">text</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 text</p> |
| </td>
|
| </tr></table>
|
| <a href="#requirements_text.RequirementsSectionText.attr"></a>
|
| <h2 id="requirementstextTag"><a href="#requirementstextTag"><a href="#requirementstextTag">Tag</a></a></h2>
|
|
|
| <p>A Tag for linking things to Requirements, This is Subclassed per thing , e.g. ScenarioTag will link a Scenario to requirements.</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="requirementstextTag.displayName" class="teletype">displayName</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 tags display name.</p> |
| </td>
|
| </tr><tr> <td><div id="requirementstextTag.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>
|
| </td> <td><p>the tags name, which is also its unique id</p> |
| </td>
|
| </tr></table>
|
| <a href="#requirements_text.Tag.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="requirementstextTag.requirements" class="teletype">requirements</div>
|
| </td>
|
| <td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#requirementstextTitledRequirementsSection">TitledRequirementsSection</a></span></div>
|
| <div class="label">Cardinality: [0..*]</div>
|
| </td>
|
| <td> <p>the tags name, which is also its unique id</p> |
| </td>
|
| </tr></table>
|
| <a href="#requirements_text.Tag.ref"></a>
|
| <h2 id="requirementstextTagGroup"><a href="#requirementstextTagGroup"><a href="#requirementstextTagGroup">TagGroup</a></a></h2>
|
|
|
| <p>A group of Tags</p>
|
| <h4><b>Supertype:</b><a href="#modulemanagementModule">Module</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="requirementstextTagGroup.tags" class="teletype">tags</div>
|
| </td>
|
| <td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#requirementstextTag">Tag</a></span></div>
|
| <div class="label">Cardinality: [0..*]</div>
|
| <div class="label">Containment</div>
|
| </td>
|
| <td> <p>the tags</p> |
| </td>
|
| </tr></table>
|
| <a href="#requirements_text.TagGroup.ref"></a>
|
| <h2 id="requirementstextTitledRequirementsSection"><a href="#requirementstextTitledRequirementsSection"><a href="#requirementstextTitledRequirementsSection">TitledRequirementsSection</a></a></h2>
|
|
|
| <p>A Requirements Section which has a title, such as an Article 321 or Chapter 5.
|
| Note that this contains other requirements sections, which could in turn be other TitledRequirementsSections </p>
|
| <h4><b>Supertype:</b><a href="#requirementstextRequirementsSection">RequirementsSection</a></h4><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="requirementstextTitledRequirementsSection.title" class="teletype">title</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 title of the requirements section</p> |
| </td>
|
| </tr></table>
|
| <a href="#requirements_text.TitledRequirementsSection.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="requirementstextTitledRequirementsSection.referencingSections" class="teletype">referencingSections</div>
|
| </td>
|
| <td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#requirementstextRequirementsSectionLinkWithText">RequirementsSectionLinkWithText</a></span></div>
|
| <div class="label">Cardinality: [0..1]</div>
|
| <div class="keyValue"><span class="label">Op: </span><span class="teletype">linkedRuleSection</span></div>
|
| </td>
|
| <td> <p>other requirement sections that link to this one (Optional)</p> |
| </td>
|
| </tr><tr> <td><div id="requirementstextTitledRequirementsSection.requirementsType" class="teletype">requirementsType</div>
|
| </td>
|
| <td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#requirementstextRequirementType">RequirementType</a></span></div>
|
| <div class="label">Cardinality: [1..1]</div>
|
| </td>
|
| <td> <p>The type, from allowed types, such as Article, Chapter,Rulebook etc</p> |
| </td>
|
| </tr><tr> <td><div id="requirementstextTitledRequirementsSection.sections" class="teletype">sections</div>
|
| </td>
|
| <td><div class="keyValue"><span class="label">T: </span><span class="teletype"><a href="#requirementstextRequirementsSection">RequirementsSection</a></span></div>
|
| <div class="label">Cardinality: [0..*]</div>
|
| <div class="label">Containment</div>
|
| </td>
|
| <td> <p>The sections contained in the titled section</p> |
| </td>
|
| </tr></table>
|
| <a href="#requirements_text.TitledRequirementsSection.ref"></a>
|
| </body>
|
| </html>
|