1.0.0-beta.3 • Published 6 years ago

ocl2 v1.0.0-beta.3

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

OCL.js

The Object Constraint Language (OCL) is a language for describing rules that apply to MOF conform modelling languages like UML. The OCL is a text based language that provides constraint and object query expressions that cannot be expressed by a meta modelling language.

Build Status devDependency Status license npm (scoped)

Example Page

To illustrate the usage of this library, an example web page has been set up here.

Installation

npm

npm install --save @stekoe/ocl.js

Quick-Start

Usage

import {OclEngine} from '@stekoe/ocl.js'

const oclEngine = OclEngine.create()
    .addOclExpression(`
        context Person
            inv: self.name->isNotEmpty()
    `);

const validate = oclEngine.evaluate(anObject)
    .getResult();

API

OclEngine

addOclExpression(oclExpression)

Register a new OCL expression to the given OCL instance.

Arguments

  • oclExpression (String): The OCL expression to register.

evaluate(object)

Evaluate the given object wether it does not violate any of the registered OCL expressions.

Arguments

  • object (Object): The object / instance to test against the registered OCL expressions.

LICENSE

MIT License

Copyright (c) 2018 Stephan Köninger

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.