blob: 9d6137a28d76b04925aa48e395aad5ceb202bcd2 [file] [log] [blame]
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="icon" href="../../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.5">
<title>EVL-EMF Validation Integration - Epsilon</title>
<link rel="stylesheet" href="../../../assets/stylesheets/main.bde7dde4.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css">
<meta name="theme-color" content="#000000">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
<style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../../assets/stylesheets/mermaid.css">
<link rel="stylesheet" href="../../../assets/javascript/google-code-prettify/prettify.css">
<link rel="stylesheet" href="https://unpkg.com/mermaid@8.5.1/dist/mermaid.css">
<link rel="stylesheet" href="../../../assets/stylesheets/slick.css">
<link rel="stylesheet" href="../../../assets/stylesheets/slick-theme.css">
<link rel="stylesheet" href="../../../assets/stylesheets/extra.css">
<script>
window.ga = window.ga || function() {
(ga.q = ga.q || []).push(arguments)
}
ga.l = +new Date
/* Setup integration and send page view */
ga("create", "UA-184785655-1", "auto")
ga("set", "anonymizeIp", true)
ga("send", "pageview")
/* Register handler to log search on blur */
document.addEventListener("DOMContentLoaded", () => {
if (document.forms.search) {
var query = document.forms.search.query
query.addEventListener("blur", function() {
if (this.value) {
var path = document.location.pathname;
ga("send", "pageview", path + "?q=" + this.value)
}
})
}
})
</script>
<script async src="https://www.google-analytics.com/analytics.js"></script>
</head>
<body dir="ltr" data-md-color-scheme="" data-md-color-primary="black" data-md-color-accent="orange">
<script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#evl-emf-validation-integration" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../../.." title="Epsilon" class="md-header__button md-logo" aria-label="Epsilon" data-md-component="logo">
<img src="../../../assets/images/epsilon-white-background.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Epsilon
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
EVL-EMF Validation Integration
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</label>
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
</button>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://git.eclipse.org/c/epsilon/org.eclipse.epsilon.git/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
Git repository @ Eclipse
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../../.." title="Epsilon" class="md-nav__button md-logo" aria-label="Epsilon" data-md-component="logo">
<img src="../../../assets/images/epsilon-white-background.png" alt="logo">
</a>
Epsilon
</label>
<div class="md-nav__source">
<a href="https://git.eclipse.org/c/epsilon/org.eclipse.epsilon.git/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
Git repository @ Eclipse
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
Home
</a>
</li>
<li class="md-nav__item">
<a href="../../../download/" class="md-nav__link">
Download
</a>
</li>
<li class="md-nav__item">
<a href="../../../getting-started/" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../../live" class="md-nav__link">
Playground
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5">
Documentation
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Documentation" data-md-level="1">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Documentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../../emc/" class="md-nav__link">
Model Connectivity
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
<label class="md-nav__link" for="__nav_5_3">
Languages
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Languages" data-md-level="2">
<label class="md-nav__title" for="__nav_5_3">
<span class="md-nav__icon md-icon"></span>
Languages
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../eol/" class="md-nav__link">
Object Language (EOL)
</a>
</li>
<li class="md-nav__item">
<a href="../../egl/" class="md-nav__link">
Code Generation (EGL)
</a>
</li>
<li class="md-nav__item">
<a href="../../evl/" class="md-nav__link">
Model Validation (EVL)
</a>
</li>
<li class="md-nav__item">
<a href="../../etl/" class="md-nav__link">
Model Transformation (ETL)
</a>
</li>
<li class="md-nav__item">
<a href="../../ecl/" class="md-nav__link">
Model Comparison (ECL)
</a>
</li>
<li class="md-nav__item">
<a href="../../eml/" class="md-nav__link">
Model Merging (EML)
</a>
</li>
<li class="md-nav__item">
<a href="../../epl/" class="md-nav__link">
Pattern Matching (EPL)
</a>
</li>
<li class="md-nav__item">
<a href="../../flock/" class="md-nav__link">
Model Migration (Flock)
</a>
</li>
<li class="md-nav__item">
<a href="../../emg/" class="md-nav__link">
Model Generation (EMG)
</a>
</li>
<li class="md-nav__item">
<a href="../../eunit/" class="md-nav__link">
Unit Testing (EUnit)
</a>
</li>
<li class="md-nav__item">
<a href="../../pinset/" class="md-nav__link">
Dataset Extraction (Pinset)
</a>
</li>
<li class="md-nav__item">
<a href="../../ewl/" class="md-nav__link">
Wizard Language (EWL)
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
<label class="md-nav__link" for="__nav_5_4">
Tools
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Tools" data-md-level="2">
<label class="md-nav__title" for="__nav_5_4">
<span class="md-nav__icon md-icon"></span>
Tools
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../picto/" class="md-nav__link">
Picto
</a>
</li>
<li class="md-nav__item">
<a href="../../flexmi/" class="md-nav__link">
Flexmi
</a>
</li>
<li class="md-nav__item">
<a href="../../eugenia/" class="md-nav__link">
Eugenia
</a>
</li>
<li class="md-nav__item">
<a href="../../exeed/" class="md-nav__link">
Exeed
</a>
</li>
<li class="md-nav__item">
<a href="../../modelink/" class="md-nav__link">
Modelink
</a>
</li>
<li class="md-nav__item">
<a href="../../hutn/" class="md-nav__link">
HUTN
</a>
</li>
<li class="md-nav__item">
<a href="../../workflow/" class="md-nav__link">
Workflow (Ant tasks)
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
Articles
</a>
</li>
<li class="md-nav__item">
<a href="../../../examples/" class="md-nav__link">
Examples
</a>
</li>
<li class="md-nav__item">
<a href="https://www.youtube.com/epsilondevs" class="md-nav__link">
Screencasts
</a>
</li>
<li class="md-nav__item">
<a href="https://www.youtube.com/playlist?list=PLRwHao6Ue0YUecg7vEUQTrtySIWwrd_mI" class="md-nav__link">
Lectures
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
<label class="md-nav__link" for="__nav_5_9">
Javadoc
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Javadoc" data-md-level="2">
<label class="md-nav__title" for="__nav_5_9">
<span class="md-nav__icon md-icon"></span>
Javadoc
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="https://download.eclipse.org/epsilon/stable-javadoc/" class="md-nav__link">
Stable
</a>
</li>
<li class="md-nav__item">
<a href="https://download.eclipse.org/epsilon/interim-javadoc/" class="md-nav__link">
Interim
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6">
Issues
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Issues" data-md-level="1">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Issues
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="https://bugs.eclipse.org/bugs/enter_bug.cgi?product=epsilon" class="md-nav__link">
Report a new issue
</a>
</li>
<li class="md-nav__item">
<a href="https://bugs.eclipse.org/bugs/buglist.cgi?product=epsilon&cmdtype=doit&order=Reuse+same+sort+as+last+time&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial" class="md-nav__link">
View open bugs
</a>
</li>
<li class="md-nav__item">
<a href="https://bugs.eclipse.org/bugs/buglist.cgi?product=epsilon&cmdtype=doit&order=Reuse+same+sort+as+last+time&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_severity=enhancement" class="md-nav__link">
View enhancement requests
</a>
</li>
<li class="md-nav__item">
<a href="https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=RESOLVED&list_id=17694438&product=epsilon&query_format=advanced" class="md-nav__link">
View issues resolved since the last stable release
</a>
</li>
<li class="md-nav__item">
<a href="https://bugs.eclipse.org/bugs/buglist.cgi?product=epsilon&cmdtype=doit&order=Reuse+same+sort+as+last+time" class="md-nav__link">
View all issues
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7">
Community
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Community" data-md-level="1">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Community
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
<label class="md-nav__link" for="__nav_7_1">
Who is using Epsilon?
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Who is using Epsilon?" data-md-level="2">
<label class="md-nav__title" for="__nav_7_1">
<span class="md-nav__icon md-icon"></span>
Who is using Epsilon?
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../users/" class="md-nav__link">
Industry
</a>
</li>
<li class="md-nav__item">
<a href="../../../users/education/" class="md-nav__link">
Education
</a>
</li>
<li class="md-nav__item">
<a href="../../../users/open-source/" class="md-nav__link">
Open-source Projects
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="https://projects.eclipse.org/projects/modeling.epsilon/who" class="md-nav__link">
Who is developing Epsilon?
</a>
</li>
<li class="md-nav__item">
<a href="https://www.eclipse.org/forums/index.php/f/22/" class="md-nav__link">
Forum
</a>
</li>
<li class="md-nav__item">
<a href="../../../professional-services" class="md-nav__link">
Professional Services
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_5" type="checkbox" id="__nav_7_5" >
<label class="md-nav__link" for="__nav_7_5">
Social Media
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Social Media" data-md-level="2">
<label class="md-nav__title" for="__nav_7_5">
<span class="md-nav__icon md-icon"></span>
Social Media
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="https://twitter.com/eclipseepsilon" class="md-nav__link">
Twitter
</a>
</li>
<li class="md-nav__item">
<a href="https://youtube.com/epsilondevs" class="md-nav__link">
YouTube
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../../labs/" class="md-nav__link">
Epsilon Labs
</a>
</li>
<li class="md-nav__item">
<a href="../../../faq/" class="md-nav__link">
Frequently Asked Questions
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../../branding/" class="md-nav__link">
Branding
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">Table of contents</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#the-evlvalidator-class" class="md-nav__link">
The EvlValidator Class
</a>
</li>
<li class="md-nav__item">
<a href="#registering-evl-constraints" class="md-nav__link">
Registering EVL Constraints
</a>
<nav class="md-nav" aria-label="Registering EVL Constraints">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#programmatically" class="md-nav__link">
Programmatically
</a>
</li>
<li class="md-nav__item">
<a href="#via-the-extension-point" class="md-nav__link">
Via the Extension Point
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#runtime-adjustments" class="md-nav__link">
Runtime Adjustments
</a>
<nav class="md-nav" aria-label="Runtime Adjustments">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#error-dialogs" class="md-nav__link">
Error Dialogs
</a>
</li>
<li class="md-nav__item">
<a href="#logging" class="md-nav__link">
Logging
</a>
</li>
<li class="md-nav__item">
<a href="#validation-progress-and-cancellation" class="md-nav__link">
Validation progress and cancellation
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="evl-emf-validation-integration">EVL-EMF Validation Integration<a class="headerlink" href="#evl-emf-validation-integration" title="Permanent link">&para;</a></h1>
<p>The Eclipse Modeling Framework (EMF) provides an extensible model validation service via the <a href="https://download.eclipse.org/modeling/emf/emf/javadoc/2.4.3/org/eclipse/emf/ecore/EValidator.html">EValidator</a> API. The API allows contributing additional validators for Ecore metamodels via the <code>EValidator.Registry</code> class. In this way, you can provide additional validation constraints for metamodels that will be invoked when models conforming to these metamodels are validated by EMF (e.g. through the <code>Model</code> &rarr; <code>Right-click</code> &rarr; <code>Validate</code> menu in EMF's built-in reflective).</p>
<h2 id="the-evlvalidator-class">The EvlValidator Class<a class="headerlink" href="#the-evlvalidator-class" title="Permanent link">&para;</a></h2>
<p>Epsilon provides an implementation of EMF's <code>EValidator</code> interface (<a href="https://archive.eclipse.org/epsilon/2.2/javadoc/org/eclipse/epsilon/evl/emf/validation/EvlValidator.html"><code>EvlValidator</code></a>) that can execute EVL constraints against EMF models.</p>
<h2 id="registering-evl-constraints">Registering EVL Constraints<a class="headerlink" href="#registering-evl-constraints" title="Permanent link">&para;</a></h2>
<p>There are two ways to register your EVL constraints for an Ecore metamodel (<code>EPackage</code>): programmatically or via an extension point.</p>
<h3 id="programmatically">Programmatically<a class="headerlink" href="#programmatically" title="Permanent link">&para;</a></h3>
<p>For this you need to create a new instance of an <code>EvlValidator</code> and then add it to the <code>EValidatorRegistry</code>. Note that if there are existing validators registered for the metamodel, you should not remove/overwrite them; instead you should combine them in a <code>CompositeEValidator</code>.</p>
<p>The following snippet outlines the general idea (you need to make your own provisions if you need to validate multiple <code>EPackages</code> with the same validator (e.g. use the <code>EvlValidator#addAdditionalPackage</code> method)).</p>
<div class="highlight"><pre><span></span><code><span class="c1">// Assuming you have generated the metamodel code</span>
<span class="n">EPackage</span> <span class="n">ePackage</span> <span class="o">=</span> <span class="n">YourPackage</span><span class="p">.</span><span class="na">eINSTANCE</span><span class="p">;</span>
<span class="c1">// Pass a model name if your script uses it</span>
<span class="c1">// Pass a valid bundle ID as it used for reporting (if not in a plugin use your project name or similar)</span>
<span class="n">EvlValidator</span> <span class="n">evlValidator</span> <span class="o">=</span> <span class="k">new</span> <span class="n">EvlValidator</span><span class="p">(</span>
<span class="n">evlScriptURI</span><span class="p">,</span> <span class="n">modelName</span><span class="p">,</span> <span class="n">ePackage</span><span class="p">.</span><span class="na">nsUri</span><span class="p">(),</span> <span class="n">bundleId</span><span class="p">);</span>
<span class="n">EValidator</span> <span class="n">existingValidator</span> <span class="o">=</span> <span class="n">EValidator</span><span class="p">.</span><span class="na">Registry</span><span class="p">.</span><span class="na">INSTANCE</span><span class="p">.</span><span class="na">getEValidator</span><span class="p">(</span><span class="n">ePackage</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="n">existingValidator</span> <span class="k">instanceof</span> <span class="n">CompositeEValidator</span><span class="p">)</span> <span class="p">{</span>
<span class="p">((</span><span class="n">CompositeEValidator</span><span class="p">)</span> <span class="n">existingValidator</span><span class="p">).</span><span class="na">getDelegates</span><span class="p">().</span><span class="na">add</span><span class="p">(</span><span class="n">evlValidator</span><span class="p">);</span>
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="n">existingValidator</span> <span class="o">==</span> <span class="kc">null</span><span class="p">)</span> <span class="p">{</span>
<span class="n">existingValidator</span> <span class="o">=</span> <span class="n">EObjectValidator</span><span class="p">.</span><span class="na">INSTANCE</span><span class="p">;</span>
<span class="p">}</span>
<span class="n">CompositeEValidator</span> <span class="n">newValidator</span> <span class="o">=</span> <span class="k">new</span> <span class="n">CompositeEValidator</span><span class="p">();</span>
<span class="n">newValidator</span><span class="p">.</span><span class="na">getDelegates</span><span class="p">().</span><span class="na">add</span><span class="p">(</span><span class="n">existingValidator</span><span class="p">);</span>
<span class="n">newValidator</span><span class="p">.</span><span class="na">getDelegates</span><span class="p">().</span><span class="na">add</span><span class="p">(</span><span class="n">evlValidator</span><span class="p">);</span>
<span class="n">EValidator</span><span class="p">.</span><span class="na">Registry</span><span class="p">.</span><span class="na">INSTANCE</span><span class="p">.</span><span class="na">put</span><span class="p">(</span><span class="n">ePackage</span><span class="p">,</span> <span class="n">newValidator</span><span class="p">);</span>
<span class="p">}</span>
</code></pre></div>
<h3 id="via-the-extension-point">Via the Extension Point<a class="headerlink" href="#via-the-extension-point" title="Permanent link">&para;</a></h3>
<p>Epsilon provides the <code>org.eclipse.epsilon.evl.emf.validation</code> extension point for registering EVL constraints against <code>EPackages</code> in Eclipse. The extension point will handle the <code>EvlValidator</code> instantiation and registration for you.</p>
<div class="highlight"><pre><span></span><code><span class="nt">&lt;plugin&gt;</span>
...
<span class="nt">&lt;extension</span>
<span class="na">point=</span><span class="s">&quot;org.eclipse.epsilon.evl.emf.validation&quot;</span><span class="nt">&gt;</span>
<span class="nt">&lt;constraintsBinding</span>
<span class="na">compose=</span><span class="s">&quot;true&quot;</span>
<span class="na">constraints=</span><span class="s">&quot;src/test.evl&quot;</span>
<span class="na">namespaceURI=</span><span class="s">&quot;http://your.package.uri&quot;</span>
<span class="na">validator=</span><span class="s">&quot;my.project.evl.EvlExtendedValidator&quot;</span><span class="nt">&gt;</span>
<span class="nt">&lt;additionalNamespaceURI</span>
<span class="na">namespaceURI=</span><span class="s">&quot;http://some.other.pacakge.uri&quot;</span><span class="nt">&gt;</span>
<span class="nt">&lt;/additionalNamespaceURI&gt;</span>
<span class="nt">&lt;/constraintsBinding&gt;</span>
<span class="nt">&lt;/extension&gt;</span>
<span class="nt">&lt;/plugin&gt;</span>
</code></pre></div>
<p>We recommend setting the <code>compose</code> attribute to <code>true</code>, else you will overwrite existing validators. You can also specify additional metamodels to be accessed by this validator using the <code>additionalNamespaceURI</code> entries. Note that you can also provide your own validator implementation. If omitted, the default <code>EvlValidator</code> will be used (should be sufficient for most cases).</p>
<h2 id="runtime-adjustments">Runtime Adjustments<a class="headerlink" href="#runtime-adjustments" title="Permanent link">&para;</a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The following adjustments are only possible if you control invocation of the validation, i.e. you are calling it programatically and not via the EMF/Eclipse right-click menu.</p>
</div>
<p>There are three important runtime aspects to be taken into consideration when using the EVL-EMF integration.</p>
<h3 id="error-dialogs">Error Dialogs<a class="headerlink" href="#error-dialogs" title="Permanent link">&para;</a></h3>
<p>Within Eclipse, Epsilon reports errors via Eclipse's JFace <code>MessageDialog</code> API. This is appropriate when checking constraints via the <code>Model</code> &rarr; <code>Right-click</code> &rarr; <code>Validate</code> menu in EMF's built-in tree-based editor, but can be cumbersome when the validation is integrated into other parts of your UI. To disable error reporting via message dialogs you can use use the <a href="https://archive.eclipse.org/epsilon/2.2/javadoc/org/eclipse/epsilon/evl/emf/validation/EvlValidator.html#setShowErrorDialog(boolean)">EvlValidator#setShowErrorDialog</a> function. You can either call this on you instance or override the <code>isShowErrorDialog()</code> if you extend the <code>EvlValidator</code> class.</p>
<h3 id="logging">Logging<a class="headerlink" href="#logging" title="Permanent link">&para;</a></h3>
<p>Epsilon logs errors in the console. As with the dialogs, this can be enabled/disabled. For this, you can use use the <a href="https://archive.eclipse.org/epsilon/2.2/javadoc/org/eclipse/epsilon/evl/emf/validation/EvlValidator.html#setLogErrors(boolean)">EvlValidator#setLogErrors</a> method. Similarly, the <code>isLogErrors()</code> can be overridden.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The dialogs are part of the logging, so disabling logging will disable the dialogs too.</p>
</div>
<h3 id="validation-progress-and-cancellation">Validation progress and cancellation<a class="headerlink" href="#validation-progress-and-cancellation" title="Permanent link">&para;</a></h3>
<p>Within Eclipse it is important to allow uses to cancel a running validation. To do so, we need to pass an <code>IProgressMonitor</code> to the EvlValidator. For this, you need to provide your own <a href="https://download.eclipse.org/modeling/emf/emf/javadoc/2.4.3/org/eclipse/emf/ecore/util/Diagnostician.html">Diagnostician</a>.</p>
<div class="highlight"><pre><span></span><code><span class="kd">public</span> <span class="kd">class</span> <span class="nc">MyDiagnostician</span> <span class="kd">extends</span> <span class="n">Diagnostician</span> <span class="p">{</span>
<span class="kd">public</span> <span class="n">Diagnostic</span> <span class="nf">validate</span><span class="p">(</span><span class="n">EObject</span> <span class="n">eObject</span><span class="p">,</span> <span class="n">IProgressMonitor</span> <span class="n">monitor</span><span class="p">)</span> <span class="p">{</span>
<span class="n">BasicDiagnostic</span> <span class="n">diagnostics</span> <span class="o">=</span> <span class="n">createDefaultDiagnostic</span><span class="p">(</span><span class="n">eObject</span><span class="p">);</span>
<span class="n">validate</span><span class="p">(</span><span class="n">eObject</span><span class="p">,</span> <span class="n">diagnostics</span><span class="p">,</span> <span class="n">createDefaultContext</span><span class="p">(</span><span class="n">monitor</span><span class="p">),</span> <span class="n">monitor</span><span class="p">);</span>
<span class="k">return</span> <span class="n">diagnostics</span><span class="p">;</span>
<span class="p">}</span>
<span class="c1">// Overload the Diagnostician implementation to inject the monitor into the context</span>
<span class="kd">public</span> <span class="n">Map</span><span class="o">&lt;</span><span class="n">Object</span><span class="p">,</span> <span class="n">Object</span><span class="o">&gt;</span> <span class="nf">createDefaultContext</span><span class="p">(</span><span class="n">IProgressMonitor</span> <span class="n">monitor</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">final</span> <span class="n">Map</span><span class="o">&lt;</span><span class="n">Object</span><span class="p">,</span> <span class="n">Object</span><span class="o">&gt;</span> <span class="n">defaultContext</span> <span class="o">=</span> <span class="kd">super</span><span class="p">.</span><span class="na">createDefaultContext</span><span class="p">();</span>
<span class="n">defaultContext</span><span class="p">.</span><span class="na">put</span><span class="p">(</span><span class="n">EvlValidator</span><span class="p">.</span><span class="na">VALIDATION_MONITOR</span><span class="p">,</span> <span class="n">monitor</span><span class="p">);</span>
<span class="k">return</span> <span class="n">defaultContext</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
<p>And then in your code (e.g. command handler):</p>
<div class="highlight"><pre><span></span><code><span class="nd">@Override</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">run</span><span class="p">(</span><span class="n">IProgressMonitor</span> <span class="n">monitor</span><span class="p">)</span> <span class="kd">throws</span> <span class="n">CoreException</span> <span class="p">{</span>
<span class="n">myDgnstc</span> <span class="o">=</span> <span class="k">new</span> <span class="n">MyDiagnostician</span><span class="p">();</span>
<span class="n">Diagnostic</span> <span class="n">dgnstc</span> <span class="o">=</span> <span class="n">rnblDgnstc</span><span class="p">.</span><span class="na">validate</span><span class="p">(</span><span class="n">model</span><span class="p">.</span><span class="na">getContents</span><span class="p">().</span><span class="na">get</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span> <span class="n">monitor</span><span class="p">);</span>
<span class="p">...</span>
</code></pre></div>
<p>The extended diagnostician can also be used to configure any <code>EvlValidators</code> provided via extension points, e.g. to disable logging or dialogs. In this case we assume that all <code>EvlValidators</code> are within <code>CompositeEValidators</code> (adjust if not using them). This implementation uses a <em>brute force</em> approach; ideally you should search for a specific <code>EPackage</code> instead.</p>
<div class="highlight"><pre><span></span><code><span class="kd">public</span> <span class="kd">class</span> <span class="nc">MyDiagnostician</span> <span class="kd">extends</span> <span class="n">Diagnostician</span> <span class="p">{</span>
<span class="kd">public</span> <span class="nf">MyDiagnostician</span><span class="p">()</span> <span class="p">{</span>
<span class="kd">super</span><span class="p">();</span>
<span class="k">for</span><span class="p">(</span><span class="n">Object</span> <span class="n">validator</span> <span class="p">:</span> <span class="n">eValidatorRegistry</span><span class="p">.</span><span class="na">values</span><span class="p">())</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="n">validator</span> <span class="k">instanceof</span> <span class="n">CompositeEValidator</span><span class="p">)</span> <span class="p">{</span>
<span class="n">CompositeEValidator</span> <span class="n">cmpsVal</span> <span class="o">=</span> <span class="p">(</span><span class="n">CompositeEValidator</span><span class="p">)</span> <span class="n">validator</span><span class="p">;</span>
<span class="n">findEvlValidators</span><span class="p">(</span><span class="n">cmpsVal</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="kd">public</span> <span class="n">Diagnostic</span> <span class="nf">validate</span><span class="p">(</span><span class="n">EObject</span> <span class="n">eObject</span><span class="p">,</span> <span class="n">IProgressMonitor</span> <span class="n">monitor</span><span class="p">)</span> <span class="p">{</span>
<span class="n">BasicDiagnostic</span> <span class="n">diagnostics</span> <span class="o">=</span> <span class="n">createDefaultDiagnostic</span><span class="p">(</span><span class="n">eObject</span><span class="p">);</span>
<span class="n">validate</span><span class="p">(</span><span class="n">eObject</span><span class="p">,</span> <span class="n">diagnostics</span><span class="p">,</span> <span class="n">createDefaultContext</span><span class="p">(</span><span class="n">monitor</span><span class="p">),</span> <span class="n">monitor</span><span class="p">);</span>
<span class="k">return</span> <span class="n">diagnostics</span><span class="p">;</span>
<span class="p">}</span>
<span class="c1">// Overload the Diagnostician implementation to inject the monitor into the context</span>
<span class="kd">public</span> <span class="n">Map</span><span class="o">&lt;</span><span class="n">Object</span><span class="p">,</span> <span class="n">Object</span><span class="o">&gt;</span> <span class="nf">createDefaultContext</span><span class="p">(</span><span class="n">IProgressMonitor</span> <span class="n">monitor</span><span class="p">)</span> <span class="p">{</span>
<span class="kd">final</span> <span class="n">Map</span><span class="o">&lt;</span><span class="n">Object</span><span class="p">,</span> <span class="n">Object</span><span class="o">&gt;</span> <span class="n">defaultContext</span> <span class="o">=</span> <span class="kd">super</span><span class="p">.</span><span class="na">createDefaultContext</span><span class="p">();</span>
<span class="n">defaultContext</span><span class="p">.</span><span class="na">put</span><span class="p">(</span><span class="n">EvlValidator</span><span class="p">.</span><span class="na">VALIDATION_MONITOR</span><span class="p">,</span> <span class="n">monitor</span><span class="p">);</span>
<span class="k">return</span> <span class="n">defaultContext</span><span class="p">;</span>
<span class="p">}</span>
<span class="cm">/**</span>
<span class="cm"> * Find all {@link EVlValidator}s and configure them.</span>
<span class="cm"> * @param cmpsVal</span>
<span class="cm"> * @return</span>
<span class="cm"> */</span>
<span class="kd">private</span> <span class="kt">void</span> <span class="nf">findEvlValidators</span><span class="p">(</span><span class="n">CompositeEValidator</span> <span class="n">cmpsVal</span><span class="p">)</span> <span class="p">{</span>
<span class="k">for</span> <span class="p">(</span><span class="n">EValidator</span> <span class="n">nstdVal</span> <span class="p">:</span> <span class="n">cmpsVal</span><span class="p">.</span><span class="na">getDelegates</span><span class="p">())</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="n">nstdVal</span> <span class="k">instanceof</span> <span class="n">EVlValidator</span><span class="p">)</span> <span class="p">{</span>
<span class="n">EVlValidator</span> <span class="n">evlVal</span> <span class="o">=</span> <span class="p">(</span><span class="n">EVlValidator</span><span class="p">)</span> <span class="n">nstdVal</span><span class="p">;</span>
<span class="n">evlVal</span><span class="p">.</span><span class="na">setShowErrorDialog</span><span class="p">(</span><span class="kc">false</span><span class="p">);</span>
<span class="c1">// Other settings or hook error listeners</span>
<span class="c1">// evlVal.addValidationProblemListener(this);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-footer-copyright">
<div class="md-footer-copyright__highlight">
Copyright © Eclipse Foundation, Inc. All Rights Reserved.
</div>
powered by
<a href="https://www.mkdocs.org">MkDocs</a>
and
<a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a>
</div>
<div class="md-footer-copyright epsilon-eclipse-links">
<ul>
<li><a href="https://www.eclipse.org/legal/privacy.php">Privacy Policy</a></li>
<li><a href="https://www.eclipse.org/legal/termsofuse.php">Terms of Use</a></li>
<li><a href="https://www.eclipse.org/legal/copyright.php">Copyright Agent</a></li>
</ul>
</div>
<div class="md-footer-social">
<a href="https://twitter.com/eclipseepsilon" target="_blank" rel="noopener" title="twitter.com" class="md-footer-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg>
</a>
<a href="https://youtube.com/epsilondevs" target="_blank" rel="noopener" title="youtube.com" class="md-footer-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M549.655 124.083c-6.281-23.65-24.787-42.276-48.284-48.597C458.781 64 288 64 288 64S117.22 64 74.629 75.486c-23.497 6.322-42.003 24.947-48.284 48.597-11.412 42.867-11.412 132.305-11.412 132.305s0 89.438 11.412 132.305c6.281 23.65 24.787 41.5 48.284 47.821C117.22 448 288 448 288 448s170.78 0 213.371-11.486c23.497-6.321 42.003-24.171 48.284-47.821 11.412-42.867 11.412-132.305 11.412-132.305s0-89.438-11.412-132.305zm-317.51 213.508V175.185l142.739 81.205-142.739 81.201z"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../../assets/javascripts/workers/search.d351de03.min.js", "version": null}</script>
<script src="../../../assets/javascripts/bundle.a1609d9a.min.js"></script>
<script src="https://unpkg.com/mermaid@8.5.1/dist/mermaid.min.js"></script>
<script src="../../../assets/javascript/mermaid.js"></script>
<script src="../../../assets/javascript/jquery.js"></script>
<script src="../../../assets/javascript/slick.min.js"></script>
<script src="../../../assets/javascript/google-code-prettify/prettify.js"></script>
<script src="../../../assets/javascript/google-code-prettify/lang-emfatic.js"></script>
<script src="../../../assets/javascript/google-code-prettify/lang-epsilon.js"></script>
<script src="../../../assets/javascript/google-code-prettify/prettyprint.js"></script>
<script src="../../../assets/javascript/extra.js"></script>
<script src="https://w.appzi.io/w.js?token=jlv6W"></script>
</body>
</html>