jsondiscoverer

Class JsonAdvancedDiscoverer

java.lang.Object

jsondiscoverer.JsonAdvancedDiscoverer

public class JsonAdvancedDiscoverer
extends java.lang.Object

Performs a discovery process among several JsonSources (i.e., receiving a JsonSourceSet as input). The resulting metamodels are combined to obtain a general one.

In the context of the JSON discoverer, the JsonAdvancedDiscoverer is used to discover the metamodel out of a set of JSON-based Web services of the same API.

Note that this process is actually a metamodel composition process, where metamodels discovered from a set of JsonSources are analyzed to create a new one covering all of them.

Thus, the advanced discovery process follows these steps:

1. Receive a set of JsonSources (as JsonSourceSet
2. Discover the metamodel for each JsonSource
3. Analyze the discovered metamodels and create a new one covering them
4. As a result, a metamodel plus a set of CoverageCreators are returned

This implementation does not depend on Xtext

Author:

Javier Canovas (me@jlcanovas.es)

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.HashMap<org.eclipse.emf.ecore.EAttribute,java.util.List<java.lang.Object>>	cacheValues Values for discovered values
(package private) static double	CLASS_MATCHING_THRESHOLD Threshold to consider when two metamodel classes are similar.
private java.util.HashMap<JsonSource,CoverageCreator>	coverageCreators Map with the coverage for each JsonSource
private static java.lang.String	DEFAULT_NS_PREFIX Default NS URI for the discovered metamodel
private static java.lang.String	DEFAULT_NS_URI Default prefix for the discovered metamodel
private static java.util.logging.Logger	LOGGER Used to log all the activity
private java.util.HashMap<java.lang.String,org.eclipse.emf.ecore.EClass>	registry Map with the set of EClasses discovered in the resulting metamodel
private JsonSourceSet	sourceSet The set of JsonSources to use in the discovery process

Constructor Summary

Constructors

Constructor and Description
JsonAdvancedDiscoverer(JsonSourceSet sourceSet) Constructs a new JsonAdvancedDiscoverer with a set of JsonSourceSet elements

Method Summary

Modifier and Type	Method and Description
private void	composeAttributes(org.eclipse.emf.ecore.EClass existingClass, org.eclipse.emf.ecore.EClass otherClass, CoverageCreator coverageCreator) Compose the attributes of two EClasses.
private void	composeEClass(org.eclipse.emf.ecore.EClass existingClass, org.eclipse.emf.ecore.EClass otherClass, CoverageCreator coverageCreator) Composes two EClasses
private void	composeReferences(org.eclipse.emf.ecore.EClass existingClass, org.eclipse.emf.ecore.EClass otherClass, CoverageCreator coverageCreator) Compose the references of two EClasses.
private java.lang.String	digestId(java.lang.String id) Disgests an identifier (changes the first letter to uppercase and removes the possible trailing "s")
org.eclipse.emf.ecore.EPackage	discover() Launches the advanced discover process
org.eclipse.emf.ecore.EPackage	discover(java.io.File resultPath) Launches the advanced discover process
private org.eclipse.emf.ecore.EAttribute	duplicateAttribute(org.eclipse.emf.ecore.EAttribute otherAttribute) Creates a new EAttribute and initializes it with basic information coming from another one
private org.eclipse.emf.ecore.EClass	duplicateEClass(org.eclipse.emf.ecore.EClass otherClass, CoverageCreator coverageCreator) Duplicates a Class having into consideration its structural features.
private org.eclipse.emf.ecore.EReference	duplicateReference(org.eclipse.emf.ecore.EReference otherReference) Creates a new EReference and initializes it with basic information coming from another one
private java.util.List<java.lang.Object>	getJSONValues(org.eclipse.emf.ecore.EAttribute eAttribute, java.lang.String sourceName) Gets the values for a particular key
private org.eclipse.emf.ecore.EAttribute	lookForSimilarAttribute(org.eclipse.emf.ecore.EClass existingClass, org.eclipse.emf.ecore.EAttribute otherAttribute, CoverageCreator coverageCreator) Looks for a similar attribute in an existing EClass.
private org.eclipse.emf.ecore.EClass	lookForSimilarEClass(org.eclipse.emf.ecore.EClass existingClass) Looks for a potential already discovered EClass which may match with the one given as input.
void	saveCoverage(java.util.List<java.io.File> resultPaths) Saves the coverage information

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NS_URI

private static final java.lang.String DEFAULT_NS_URI

Default prefix for the discovered metamodel

See Also:

Constant Field Values

DEFAULT_NS_PREFIX

private static final java.lang.String DEFAULT_NS_PREFIX

Default NS URI for the discovered metamodel

See Also:

Constant Field Values

LOGGER

private static final java.util.logging.Logger LOGGER

Used to log all the activity

CLASS_MATCHING_THRESHOLD

static final double CLASS_MATCHING_THRESHOLD

Threshold to consider when two metamodel classes are similar.

To calculate the ratio, the number of matching attributes/refereces in the two metamodel classes are compared. Thus, two metamodel classes with matching attributes/references will give a ratio of 1

See Also:

Constant Field Values

sourceSet

private JsonSourceSet sourceSet

The set of JsonSources to use in the discovery process

registry

private java.util.HashMap<java.lang.String,org.eclipse.emf.ecore.EClass> registry

Map with the set of EClasses discovered in the resulting metamodel

coverageCreators

private java.util.HashMap<JsonSource,CoverageCreator> coverageCreators

Map with the coverage for each JsonSource

cacheValues

java.util.HashMap<org.eclipse.emf.ecore.EAttribute,java.util.List<java.lang.Object>> cacheValues

Values for discovered values

Constructor Detail

JsonAdvancedDiscoverer

public JsonAdvancedDiscoverer(JsonSourceSet sourceSet)

Constructs a new JsonAdvancedDiscoverer with a set of JsonSourceSet elements

Parameters:

sourceSet - A JsonSourceSet to represent a set of JSON documents

Method Detail

saveCoverage

public void saveCoverage(java.util.List<java.io.File> resultPaths)

Saves the coverage information

Parameters:

resultPaths - The path where the coverage information will be saved

discover

public org.eclipse.emf.ecore.EPackage discover(java.io.File resultPath)
                                        throws java.io.FileNotFoundException

Launches the advanced discover process

Parameters:

resultPath - The path where the resulting metamodel will be stored

Returns:

The resulting metamodel as EPackage

Throws:

java.io.FileNotFoundException - There is no file to read from

discover

public org.eclipse.emf.ecore.EPackage discover()

Launches the advanced discover process

Returns:

The resulting metamodel as EPackage

composeAttributes

private void composeAttributes(org.eclipse.emf.ecore.EClass existingClass,
                               org.eclipse.emf.ecore.EClass otherClass,
                               CoverageCreator coverageCreator)

Compose the attributes of two EClasses.

Parameters:

existingClass - Discovered EClass

otherClass - EClass coming from previously discovered process, to compose with the existing one

coverageCreator - Coverage manager to track changes

composeReferences

private void composeReferences(org.eclipse.emf.ecore.EClass existingClass,
                               org.eclipse.emf.ecore.EClass otherClass,
                               CoverageCreator coverageCreator)

Compose the references of two EClasses.

Parameters:

existingClass - Discovered EClass

otherClass - EClass coming from previously discovered process, to compose with the existing one

coverageCreator - Coverage manager to track changes

duplicateAttribute

private org.eclipse.emf.ecore.EAttribute duplicateAttribute(org.eclipse.emf.ecore.EAttribute otherAttribute)

Creates a new EAttribute and initializes it with basic information coming from another one

Parameters:

otherAttribute - Attribute to duplicate

Returns:

Duplicated attribute

duplicateReference

private org.eclipse.emf.ecore.EReference duplicateReference(org.eclipse.emf.ecore.EReference otherReference)

Creates a new EReference and initializes it with basic information coming from another one

Parameters:

otherReference - Reference to duplicate

Returns:

Duplicated reference

duplicateEClass

private org.eclipse.emf.ecore.EClass duplicateEClass(org.eclipse.emf.ecore.EClass otherClass,
                                                     CoverageCreator coverageCreator)

Duplicates a Class having into consideration its structural features.

Parameters:

otherClass - Class to duplicate

coverageCreator - Coverage manage to track changes

Returns:

Duplicated class

composeEClass

private void composeEClass(org.eclipse.emf.ecore.EClass existingClass,
                           org.eclipse.emf.ecore.EClass otherClass,
                           CoverageCreator coverageCreator)

Composes two EClasses

Parameters:

existingClass - Discovered EClass

otherClass - EClass coming from previously discovered process, to compose with the existing one

coverageCreator - Coverage manager to track changes

lookForSimilarEClass

private org.eclipse.emf.ecore.EClass lookForSimilarEClass(org.eclipse.emf.ecore.EClass existingClass)

Looks for a potential already discovered EClass which may match with the one given as input. First, a class with the same name is searched in the set of discovered classes. If not found, a class with a ratio of same structural features (same name) higher than CLASS_MATCHING_THRESHOLD is searched. If not found, returns null. Input elements (represented as EClasses named "Input") are not considered

Parameters:

existingClass - EClass to check with already discovered EClasses

Returns:

The similar class (as EClass)

lookForSimilarAttribute

private org.eclipse.emf.ecore.EAttribute lookForSimilarAttribute(org.eclipse.emf.ecore.EClass existingClass,
                                                                 org.eclipse.emf.ecore.EAttribute otherAttribute,
                                                                 CoverageCreator coverageCreator)

Looks for a similar attribute in an existing EClass. Only names are considered.

Parameters:

existingClass - Class in which the attribute is search

otherAttribute - The attribute to compare

coverageCreator - The coverage manage to track changes

Returns:

The similar attribute (null if not found)

getJSONValues

private java.util.List<java.lang.Object> getJSONValues(org.eclipse.emf.ecore.EAttribute eAttribute,
                                                       java.lang.String sourceName)

Gets the values for a particular key

Parameters:

eAttribute - The contained attribute

sourceName - The name acting as key

Returns:

The list of matching values

digestId

private java.lang.String digestId(java.lang.String id)

Disgests an identifier (changes the first letter to uppercase and removes the possible trailing "s")

Parameters:

id - Identifier to digest

Returns:

Digested identifier