Skip to content

Feed aggregator

Human factors in the adoption of model-driven engineering: an educator’s perspective

Software Modeling Blog - Wed, 08/17/2016 - 10:51

After a complete failure in convincing students about the benefits of code generation, we laid out a set of recommendations for instructors and tool vendors to increase the chance of success in the adoption of model-driven engineering

The post Human factors in the adoption of model-driven engineering: an educator’s perspective appeared first on Modeling Languages.

Categories: Blogs

PlantUML – Rendering textual UML diagrams anywhere you want (+ SQL generation)

Software Modeling Blog - Wed, 08/10/2016 - 09:03

PlantUML is a textual UML tool to easily create and embed graphical UML diagrams wherever you need them

The post PlantUML – Rendering textual UML diagrams anywhere you want (+ SQL generation) appeared first on Modeling Languages.

Categories: Blogs

What do their creators think about UML now?

Software Modeling Blog - Fri, 08/05/2016 - 06:09

A collection of UML opinions by the people that was there when the language was created. Check what they think 20 years after the creation of the language

The post What do their creators think about UML now? appeared first on Modeling Languages.

Categories: Blogs

Algorithms to Live By: The Computer Science of Human Decisions (book)

Software Modeling Blog - Tue, 08/02/2016 - 21:47

How can well-known computer science algorithms help us in everyday life? This is the question that this book aims to answer

The post Algorithms to Live By: The Computer Science of Human Decisions (book) appeared first on Modeling Languages.

Categories: Blogs

Experimental feature: reverse-engineering a database schema into a Cloudfier application

abstratt: news from the front - Wed, 07/27/2016 - 20:12

We just released a new version of Cloudfier which sports a long requested feature (in experimental status): reverse engineering a relational database schema as a Cloudfier application. It relies on offline database schema snapshots produced by the SchemaCrawler tool.

Steps
  1. Create a new folder (call it, say, ‘import-test’)
  2. Select the folder you just created, right click it, and choose Import > File or Zip Archive, then pick a database snapshot file created using SchemaCrawler in your computer (feel free to download this example snapshot). When asked whether the file should be unzipped, CHOOSE “NO”.
  3. Select the folder you just created, right click it, and choose Open Related > Shell
  4. type cloudfier init-project .
  5. type cloudfier app-deploy . so the contents of the project are published
  6. type cloudfier import-schema-crawler . offline.db_.zip to import the SchemaCrawler snapshot as TextUML model (provide the proper file name if your snapshot file has a different name)
  7. if you used the sample snapshot, delete the forlint.tuml file before you take the next step.
  8. type cloudfier full-deploy . to deploy the application.

all-steps-import-schema-crawler

Producing an offline database schema with SchemaCrawler
  1. Download and extract SchemaCrawler into your computer.
  2. Open a terminal or command prompt and cd into the _schemacrawer directory inside the location where you extracted SchemaCrawler.
  3. Run SchemaCrawler tool “serialize” command against your database, for instance (for a SQL Server database):
    ./schemacrawler.sh -command=serialize -server=sqlserver -infolevel=standard -password=DB_PASSWORD -user=DB_USER -database=DB_NAME -host=DB_HOST -o=my-offline-schema.zip  
    

More details on running SchemaCrawler here.

Controlling the schema import operation

There are a bunch of options that you can add to your mdd.properties file to customize the importing operation. Some of which are demonstrated in this test class.

Categories: Companies

Round trip engineering for dummies: a proposal

Software Modeling Blog - Tue, 07/26/2016 - 07:23

Some ideas to make round-trip engineering between UML and programming languages easier. Will this be the solution of this major challenge in MDE?

The post Round trip engineering for dummies: a proposal appeared first on Modeling Languages.

Categories: Blogs

Not a programmer / coder, still a Developer

Software Modeling Blog - Mon, 07/18/2016 - 03:23

Are you a programmer or a developer? What's the difference (from our point of view)?

The post Not a programmer / coder, still a Developer appeared first on Modeling Languages.

Categories: Blogs

Ericsson Modeling Days

Software Modeling Blog - Thu, 07/14/2016 - 09:31

A new edition of the Ericsson Modeling days is coming up. A unique opportunity to meet with plenty of companies interested in model-driven engineering

The post Ericsson Modeling Days appeared first on Modeling Languages.

Categories: Blogs

MDA is dead, long live MDE (according to Gartner)

Software Modeling Blog - Mon, 07/11/2016 - 09:04

Model-driven architectures (MDA) became obsolete before reaching full maturity. This a reflection of the market shift to more general, model-driven development approaches.

The post MDA is dead, long live MDE (according to Gartner) appeared first on Modeling Languages.

Categories: Blogs

Shooting hoops and why learning is non-linear

Sander Hoogendoorn - Sun, 04/24/2016 - 11:09
It’s April and the sun is slowly becoming more powerful, warming the people in the green and white deck chairs in Green Park in London. A few minutes ago, I took the tube to travel back to Heathrow Airport, and…
Categories: Blogs

SwanseaCon (Swansea, Wales. September 2016. Closing keynote)

Sander Hoogendoorn - Mon, 03/28/2016 - 15:52
It certainly feels good to return to Swansea for the second edition of SwanseaCon. After delivering one of the more popular talks last year during the first edition of the event, the organizers kindly invited me to perform the closing…
Categories: Blogs

CodeMotion Amsterdam (Amsterdam, Netherlands. May 2016)

Sander Hoogendoorn - Mon, 03/28/2016 - 15:46
After having done a  very successful talk at CodeMotion Madrid some years back, I will return to the CodeMotion circus at CodeMotion Amsterdam 2016, where I will deliver a talk on microservices. See http://amsterdam2016.codemotionworld.com/
Categories: Blogs

GeeCon (Krakow, Poland. May 2016)

Sander Hoogendoorn - Mon, 03/28/2016 - 15:43
GeeCon is a large JVM oriented developer conference, held in the great city of Krakow, Poland. Featuring over 1200 delegates, and 75+ speakers, it is one of the largest developer conferences in Eastern Europe. I will do a talk on…
Categories: Blogs

Techorama (Mechelen, Belgium. May 2016)

Sander Hoogendoorn - Mon, 03/28/2016 - 15:26
Very happy to be on the speakers list of Techorama a technical (mostly Microsoft oriented) conferences in the old city of Mechelen in Belgium ni May 2016. Will do a single talk – mostly on the current state of software…
Categories: Blogs

Borealis IT&S Conference (Maastricht, Netherlands. April 2016. Opening keynote)

Sander Hoogendoorn - Mon, 03/28/2016 - 15:23
I was invited by Borealis to do the opening keynote for their tri-annual in-company IT&S Conference, to be held in Maastricht, Netherlands. I will kick of with a retrospective on agile, lessons learned and right after that I will do…
Categories: Blogs

DevWeek (London, UK. April 2016)

Sander Hoogendoorn - Mon, 03/28/2016 - 14:50
DevWeek is one of the largest developer conferences in the UK, organized in the city center of London, featuring more than 110 breakout sessions and 20 full-day workshops! After having done the opening keynote two years ago I will do…
Categories: Blogs

Rubix ID (Vianen, Netherlands. April 2016. Closing keynote)

Sander Hoogendoorn - Mon, 03/28/2016 - 14:24
Rubix ID is a meetup organized by Rubix, a Dutch middleware company. The event wil have many presentations on big data, continuous delivery, and integration. Well known speaker Thomas Erl will do the opening keynote, I will do the closing…
Categories: Blogs

Software Quality Conference (Ede, Netherlands. March 2016. Keynote)

Sander Hoogendoorn - Mon, 03/28/2016 - 14:12
At the nice Software Quality Conference 2016, organized by Heliview at De Reehorst in Ede, Netherlands, I did the opening keynote, challenging the audience to finally move away from waterfall, but also move away from Scrum, and from projects and…
Categories: Blogs

Generating UML Reports From XMI Files

SDMetrics - UML design quality measurement - Mon, 02/24/2014 - 10:40

Occasionally I receive requests from people looking for a simple way to generate a report from an XMI file. For example, they may need to collect a list of all class attributes that satisfy a certain condition, and write them to some HTML or XML file. Depending on the task at hand, XSLT could work in such situations, especially if it’s a one-off problem to solve, the XMI files are not very large, and come from a single source. Another option is to use the report generation facilities that some UML modeling tools offer.

But what if you’re dealing with huge XMI files, possibly from different sources? Or the report depends on information contained in proprietary XMI extensions that your UML modeling tool does not import? Or you need to evaluate complex conditions or constraints on the UML model elements for the report? That’s what SDMetrics was designed for. However, SDMetrics does not have a report generation facility. You could use SDMetrics’ API and write a Java program to generate the report. That requires Java skills, and the solution must be recompiled and redeployed every time the report needs to be changed. A more flexible solution is to use a Java-based template engine such as Velocity for report generation.

In this post, we will develop a Velocity template for SDMetrics to generate an HTML report for a UML model. The report will list

  • every UML model element in the model, along with the values of its attributes,
  • the metric values for each model element,
  • the contents of the helper sets for each model element (for example, the set of ancestor/descendant elements),
  • the list of rule violations of the model element, if any.

Here’s a preview of what the report will look like. In this form, the report is not yet particularly useful or appealing. However, the main purpose of this post is to demonstrate how to include all the model information in the report using the SDMetrics API. The template we are about to write can thus serve as a starting point for developing customized reports more quickly.

To execute the report generator, we need

We also need a Java compiler or IDE to compile the glue code that hooks up Velocity with the SDMetrics API, and a Java 1.7 runtime for execution. I have prepared a ZIP archive for download that contains the libraries, glue code, and the finished template, ready to compile and run.

Define a report facade

Java template engines provide a scripting language to access Java objects, and invoke methods on these objects to traverse the data structures for the report. In the SDMetrics API, the interesting Java classes for report generation are:

I found it useful to implement a single Java class that serves as facade to the container classes (MetaModel, Model, MetricStore, MetricsEngine, RuleEngine). That way, the report template author does not have to deal with these five objects individually, but can rely on a single class that provides all the data. Let’s call this class ReportFacade. Here’s an excerpt from the class:

import com.sdmetrics.metrics.*;
import com.sdmetrics.model.*;
import java.util.*;

public class ReportFacade {

  private Model model;
  private MetaModel mm;
  private MetricsEngine me;
  private RuleEngine re;

  // Access to the metamodel

  public List<MetaModelElement> getTypes() {
    List<MetaModelElement> typeList = new ArrayList<>();
    for(MetaModelElement mme : mm)
      typeList.add(mme);
    return typeList;
  }
  
  // Access to the model

  public List<ModelElement> getElements(MetaModelElement type) {
    return model.getAcceptedElements(type);
  }
  
  public List<ModelElement> getRootElements() {
    ArrayList<ModelElement> roots=new ArrayList<>();
    for(ModelElement me : model)
      if(me.getOwner()==null)
        roots.add(me);
    return roots;
  }
  
  public boolean isModelElement(Object o) {
    return o instanceof ModelElement;
  }
  
  // Access to metrics and sets
  
  public Collection<Metric> getMetrics(MetaModelElement type) {
    return me.getMetricStore().getMetrics(type);
  }
  
  public Object getMetricValue(ModelElement e, Metric m) {
    return me.getMetricValue(e, m);
  }
  
  ...
  
}

The methods of the facade class mostly just delegate to the respective getter methods of the container classes. Where necessary, objects are filtered or placed into collections so that the report template can access them.

Creating the report structure

Let’s start with the template. The following code snippet generates the overall structure of the report:

<?xml version="1.0" encoding="$encoding"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 

[... skip macro definitions for now ...]

<html>
<head>
<title>$title</title>
<style type="text/css">
table { border-collapse:collapse; }
table,th,td { border: 1px solid black; text-align:left; }
</style></head>
<body>
<h1>Overview of elements</h1>
#writeElementHierarchy($report.getRootElements())
#foreach( $type in $report.getTypes() )
  #set( $elements = $report.getElements($type))
  #if($elements.size() > 0)
    <h1>List of elements of type '$type.getName()' ($elements.size())</h1>
    #foreach($element in $elements)
      <a name="$element.getXMIID()">
      <h2>$type.getName() #escp($element.getFullName())</h2></a>
      #writeAttributes($element)
      #writeMetrics($element)
      #writeSets($element)
      #writeRuleViolations($element)
    #end
  #end
#end
</body>
</html>

The template writes the boiler plate markup for a valid XHTML 1.0 file, with <html> and <head> tags and a little CSS styling. The variable $encoding contains an externally provided string with the character encoding for the output file (for example “UTF-8″). Likewise, variable $title provides the title for the report.

Next is the body of the report. The macro #writeElementHierarchy() recursively writes the nested list of model elements that serves as a “table of contents” of the report. We’ll look at its definition in a moment. Variable $report is an externally provided reference to our ReportFacade instance that holds the UML model. Method getRootElements() obtains a list of all model elements that have no owner. All other elements in the model are directly or indirectly owned by the model elements on this list.

After that, the templates goes into a foreach-loop over all element types in the meta model ($report.getTypes()). The body of the loop creates, for each element type, a list of all model elements for that type ($report.getElements()). For each model element, we write an <h2> tag with the type and name of the model element, and a named anchor to cross-reference model elements within the report using hyperlinks. The XMI IDs of the model elements serve as anchor names. The macros #writeAttributes(), #writeMetrics(), #writeSets(), and #writeRuleViolations then output the detailed information for each model element. So let’s have a look at those macros.

Write the element hierarchy

This is macro #writeElementHierarchy(), along with two little helper macros it requires:

#macro( escp $text )$reportUtils.xmlEncode($text)#end

#macro( writeElementRef $elem )
  #if( $elem )
    <a href="#$elem.getXMIID()">$elem</a>
  #end
#end

#macro( writeElementHierarchy $elements )
  #if($elements && ($elements.size()>0))
    <ul>
    #foreach($element in $elements)
      <li>#escp($element.getType().getName()) #escp($element.getName()) -
        #writeElementRef($element)
        #writeElementHierarchy($element.getOwnedElements())
      </li> 
    #end
    </ul>
  #end
#end

The macro receives a list of model elements as input parameter. The list may be empty or null. The macro produces an unordered HTML list (<ul>) with the type and name for each model element, and a hyperlink to the detailed description of the model element (call to macro #writeElementRef()). If an element owns sub-elements, those elements are written out recursively in a nested, unordered list.

Macro #escp() replaces XML special characters (<, >, & etc) with their predefined entities. For simplicity, we use a little utility class of our own (ReportUtils, not shown here) for that. Velocity comes with an optional tools package (Velocity tools) that also provides this functionality and should be used instead in a production environment.

Write the attribute values

To generate a table with the values of all attributes of a model element, we define macro #writeAttributes() as shown below. It takes the model element to write as input parameter. The macro determines the type of the model element, obtains the list of the attributes for that type, and writes out an HTML table with the attribute names in the first column, and the attribute values in the second column.

#macro( writeElementRefs $elems )
  #if($elems) 
    #foreach($elem in $elems)
      #writeElementRef($elem)#if( $foreach.hasNext ),#end
    #end
   #end
#end

#macro( writeAttributes $elem )
  #set ($elemType = $elem.getType())
  #set ($attributes = $elemType.getAttributeNames())
  <table><tr><th>Attribute</th><th>Value</th></tr>
  #foreach($attribute in $attributes)
    <tr><td title="#escp($type.getAttributeDescription($attribute))">#escp($attribute)</td><td>
    #if($elemType.isSetAttribute($attribute))
      #if($elemType.isRefAttribute($attribute))
        #writeElementRefs($elem.getSetAttribute($attribute))
      #else
        #escp($elem.getSetAttribute($attribute))
      #end
    #else
      #if($elemType.isRefAttribute($attribute))
        #writeElementRef($elem.getRefAttribute($attribute))
      #else
        #escp($elem.getPlainAttribute($attribute))
      #end
    #end
    </td></tr>
  #end
  </table>
#end

Writing the attribute values requires a bit of attention. The SDMetrics meta model distinguishes between data and reference attributes. Data attributes carry string values, reference attributes contain references to other model elements. An attribute can be single-valued or multi-valued.
Multi-valued attributes contain a set of values, single-valued attributes just one. The nested #if-statements in macro #writeAttributes() determine which combination of data/reference and single/multi-valued attribute applies, and obtain the values accordingly. Helper macro #writeElementRefs() is used to generate a comma-separated list of hyperlinks for multi-valued reference attributes.

Write the metric values

Macro #writeMetrics() below creates the table with the metric values for a model element. The macro determines the list of metrics for the element type, and writes out an HTML table with the metric names in the first column, and the metric values in the second column. Metric values can be strings, numbers, or references to other model elements. Helper macro #writeValue() checks if a metric value is a model element reference or not, and either writes a hyperlink to the model element, or just the plain metric value.

#macro( writeValue $value )
  #if($value)
    #if( $report.isModelElement($value) )
      #writeElementRef($value)
    #else 
      #escp($value) 
    #end
  #end
#end

#macro( writeMetrics $elem )
  #set ($elemType = $elem.getType())
  #set ($metrics = $report.getMetrics($elemType))
  #if($metrics.size() > 0)
    <h3>Metrics</h3>
    <table><tr><th>Metric</th><th>Value</th></tr>
    #foreach($metric in $metrics)
      <tr><td title="#escp($metric.getBriefDescription())">#escp($metric.getName())</td>
      <td>#writeValue($report.getMetricValue($elem,$metric))</td></tr>
    #end
    </table>
  #end
#end

Macros #writeSets() and #writeRuleViolations to write the helper sets and rule violations for a model element work in the same fashion and are not shown here.

Give it a spin

To play with the template, the zip archive (1.3 MB) contains a self-contained Java project with everything you need. It is an Eclipse project, but you can also import it in Netbeans or IntelliJ IDEA:

  • The Java source files are in the “src” folder.
  • Make sure the two jar files in the “lib” folder are included in the project’s class path.
  • File “sdmetricstemplate.vm” in the project’s root directory contains the Velocity template.
  • Class com.sdmetrics.velocity.ReportLauncher has a main method that applies the template to the XMI file “sample.xmi” in the project’s root directory.

The support for report generation can be taken further. For example, it is easily possible to define metric or condition expressions directly in the template, have them evaluated on-the-fly by the metrics engine, and include the result in the report. I’ll demonstrate this in a future post.

Categories: Companies

Counting OCL Expressions in UML Classes

SDMetrics - UML design quality measurement - Thu, 01/09/2014 - 14:03

In this post we’ll look at another real-life case study of how to adapt SDMetrics in order to solve a particular measurement problem. An SDMetrics user needed to count the OCL expressions in classes. SDMetrics does not produce this count out of the box, but needs a little tweaking.

In the UML2, an OCL expression is represented by a constraint whose specification is an opaque expression with OCL as its language. The following excerpt from an XMI file shows an OCL expression for a class:

<packagedElement xmi:type="uml:Class" xmi:id="id1" name="Cls1">
  <ownedRule xmi:type="uml:Constraint" xmi:id="id2" name="constr1">
    <specification xmi:type="uml:OpaqueExpression" xmi:id="id3">
      <language>OCL</language>
      <body>self.association().oclIsKindOf(Class)</body>
    </specification>
  </ownedRule>

OCL expressions may not only be defined for the class itself, but also for operations, properties, or other owned elements of the class. All these constraints should be included in the OCL count for the class. Therefore, the general strategy to define this metric in SDMetrics is to count all opaque expressions directly or indirectly owned by the class, where the language is OCL. However, we first need to extend SDMetrics’ XMI import to obtain all the required information from the model.

SDMetrics as shipped does not read the sub-elements of constraints, so the opaque expression elements owned by constraints are ignored by default. To change this, we must set the recurse attribute in the XMI transformation for constraints (cf. bottom of this section in the user manual):

<xmitransformation modelelement="constraint" 
  xmipattern="uml:Constraint" recurse="true"/>

Next, SDMetrics’ simplified UML metamodel does not define the attribute ”language” for opaque expressions. So we simply add it to the metamodel definition file:

<modelelement name="opaqueexpression">
  <attribute name="language" type="data" /> 
</modelelement>

We also have to create an XMI trigger for the new attribute in the XMI transformation file:

<xmitransformation modelelement="opaqueexpression" 
  xmipattern="uml:OpaqueExpression">
    <trigger name="language" 
      type="ctext" src="language" />
</xmitransformation>

This instructs SDMetrics to use the text of the child element “language” in the XMI file as the value for the “language” attribute of opaque expressions.

With these extensions to SDMetrics’ XMI import, we can then define the metric to count all opaque expressions in the class where the language is OCL:

<metric name="OCLExpressions" domain="class" category="Size">
  <description>The number of OCL expressions in the class.</description>
  <subelements target="opaqueexpression" condition="language='OCL'" />
</metric>

And that’s it! Yet another measurement problem for SDMetrics that could be solved with a few lines of XML code. The customization features work as advertised.

Categories: Companies