ontouml-js

OntoUML JS

Javascript library utility for manipulating OntoUML models.

Getting Start

npm install ontouml-js --save

// yarn users
yarn add ontouml-js

Usage

This package is designed to support manipulating OntoUML models, such as the one above, serialized in ontouml-schema JSON format.

import { ModelManager } from 'ontouml-js';

const modelManager = new ModelManager(ontoULMSchemaModel);

const rootPackage = modelManager.rootPackage; // ontoULMSchemaModel root package
rootPackage.getAllContents() // returns elements recursively contained within the executing package
rootPackage.getAllContentsByType([ OntoUMLType.GENERALIZATION_TYPE, OntoUMLType.PROPERTY_TYPE ]) // returns elements contained within in the package selected by type
rootPackage.getContentById('elementId') // returns the element bearering the given id

const student = rootPackage.getAllContents().find(element => element.name === 'Student'); // Student role class
student.stereotypes; // [ 'role' ]
student.getParents(); // [ Person kind class ]
student.getAncestors(); // [ Person kind class, Agent category class ]
student.getChildren(); // [ Privately Enrolled role class, Privately Enrolled role class ]
student.getDescendants(); // [ Privately Enrolled role class, Privately Enrolled role class ]

const enrollmentDate = rootPackage.getAllContents().find(element => element.name === 'Enrollment Date'); // Enrollment Date mode class
enrollmentDate.properties[0]; // date property representing the class's attibute
enrollmentDate.getRootPackage; // returns rootPackage

About

If you are interested to know more, feel free to open an issue to provide feedback on the project or reach our team members for more specific cases:

• Claudenir M. Fonseca
• Tiago Prince Sales
• Lucas Bassetti
• Victor Viola