jsondiscoverer

Class CoreographyBuilder

java.lang.Object

jsondiscoverer.CoreographyBuilder

public class CoreographyBuilder
extends java.lang.Object

This class generates a sequence diagram describing how two JSON-based Web APIs can be composed.

The main entry method is calculate(EClass, EClass), which performs the following actions:

1. Calculate the shortest path between each node in the model (see DijkstraSolver)
2. Retrieve the shortest path for a given source/target nodes
3. Generate the String representing the sequence diagram

pñ'- The sequence diagram is represented as a String to be transformed into a picture by means of the tool js-sequene-diagrams

Author:

Javier Canovas (me@jlcanovas.es)

Field Summary

Fields

Modifier and Type	Field and Description
private org.eclipse.emf.ecore.EPackage	domain The general APIs domain discovered

Constructor Summary

Constructors

Constructor and Description
CoreographyBuilder(org.eclipse.emf.ecore.EPackage ePackage) Constructs a new CoreographyBuilder element given a metamodel (as EPackage

Method Summary

Modifier and Type	Method and Description
java.lang.String	calculate(org.eclipse.emf.ecore.EClass source, org.eclipse.emf.ecore.EClass target) Searches for a possible path between two metamodel classes (as EClass elements), if exists, a sequence diagram is returned as String.
java.lang.String	discoverMapping(org.eclipse.emf.ecore.EClass source, org.eclipse.emf.ecore.EClass target) Searches for mappings between two metamodel class (as EClass elements) Attributes of each metamodel class are traversed and, if they are similar (calculated with method isSimilar(EAttribute, EAttribute)) a mapping between such attributes is created.
private boolean	isSimilar(org.eclipse.emf.ecore.EAttribute source, org.eclipse.emf.ecore.EAttribute target) Calculates if two attributes (as EAttribute elements) are similar.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

domain

private org.eclipse.emf.ecore.EPackage domain

The general APIs domain discovered

Constructor Detail

CoreographyBuilder

public CoreographyBuilder(org.eclipse.emf.ecore.EPackage ePackage)

Constructs a new CoreographyBuilder element given a metamodel (as EPackage

Parameters:

ePackage - The metamodel (as EPackage

Method Detail

calculate

public java.lang.String calculate(org.eclipse.emf.ecore.EClass source,
                                  org.eclipse.emf.ecore.EClass target)

Searches for a possible path between two metamodel classes (as EClass elements), if exists, a sequence diagram is returned as String.

This method applies first the Dijsktra algorithm to calculate all the possible shortest path for a given source node (see DijkstraSolver). Then, the shortest path with regard to a target node is retrieve (if exists) and finally the sequence diagram is generated.

The sequence diagram is represented as a String to be transformed into a picture by means of the tool js-sequene-diagrams

Parameters:

source - The source node (as EClass)

target - The target node (as EClass)

Returns:

The path between the nodes represented as a sequence diagram

discoverMapping

public java.lang.String discoverMapping(org.eclipse.emf.ecore.EClass source,
                                        org.eclipse.emf.ecore.EClass target)

Searches for mappings between two metamodel class (as EClass elements)

Attributes of each metamodel class are traversed and, if they are similar (calculated with method isSimilar(EAttribute, EAttribute)) a mapping between such attributes is created.

Mappings are currently represented as Strings following the pattern:

[source attribute name] -> [target attribute name]

If several mappings are located, the resulting String is a comma-separated result

Parameters:

source - The source metamodel class (as EClass)

target - The target metamodel class (as EClass)

Returns:

A comma-separated String with the discovered mappings

isSimilar

private boolean isSimilar(org.eclipse.emf.ecore.EAttribute source,
                          org.eclipse.emf.ecore.EAttribute target)

Calculates if two attributes (as EAttribute elements) are similar.

The similarity is checked according to number of matching characters between the two given Strings. Currently the threshold to be considered similar is 0.25.

Parameters:

source - The source EAttribute

target - The target EAttribute

Returns:

True if the two EAttribute are considered similar