jsondiscoverer

Class AnnotationHelper

java.lang.Object

jsondiscoverer.AnnotationHelper

public class AnnotationHelper
extends java.lang.Object

This class provides some helper methods to fill in the metadata in the discovered models.

Author:

Javier Canovas (me@jlcanovas.es)

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	AKA_TAG Tag used for the annotation of the a.k.a. found elements This annotation allows tracking the set of names used for an attribute/reference/class
private static java.lang.String	COVERAGE_TAG Tag used for referring to the coverage The value indicates the number of clases including such attribute/reference
private static java.lang.String	FOUND_IN_TAG Tag used to keep track on where an elements has been found
static AnnotationHelper	INSTANCE AnnotationHelper is used as singleton, this is the instance
private static java.lang.String	RATIO_TOTAL_FOUND_TAG Tag used for the annotation related to the ratio of total found This value is the ratio version of the TOTAL_FOUND_TAG
private static java.lang.String	SOURCE_NAME_TAG Tag used to keep track of which source the element has been found
private static java.lang.String	TOTAL_FOUND_TAG Tag used for the total number of found elements Added to each attribute/reference to count the times it has been found

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AnnotationHelper() Constructor.

Method Summary

Modifier and Type	Method and Description
void	calculateCoverage(org.eclipse.emf.ecore.EPackage ePackage) Calculate the value for the annotation RATIO_TOTAL_FOUND_TAG.
org.eclipse.emf.ecore.EPackage	cleanAnnotations(org.eclipse.emf.ecore.EPackage ePackage) Remove all the annotations.
java.util.List<java.lang.String>	getAka(org.eclipse.emf.ecore.EModelElement modelElement) Obtains the list of Strings with all the a.k.a. values for a EModelElement
org.eclipse.emf.ecore.EAnnotation	getAkaAnnotation(org.eclipse.emf.ecore.EModelElement modelElement) Access to the annotation for AKA_TAG.
org.eclipse.emf.ecore.EAnnotation	getCoverageAnnotation(org.eclipse.emf.ecore.EModelElement modelElement) Access to the annotation for COVERAGE_TAG.
org.eclipse.emf.ecore.EAnnotation	getFoundInAnnotation(org.eclipse.emf.ecore.EModelElement modelElement) Access to the annotation for FOUND_IN_TAG.
double	getRatioTotalFound(org.eclipse.emf.ecore.EModelElement modelElement) Access to the annotation for RATIO_TOTAL_FOUND_TAG.
java.lang.String	getSourceName(org.eclipse.emf.ecore.EClass modelElement) Obtains the value of the SOURCE_NAME_TAG tag, which keeps track of the name of the JSON source
int	getTotalFound(org.eclipse.emf.ecore.EModelElement modelElement) Access to the annotation for TOTAL_FOUND_TAG.
void	increaseTotalFound(org.eclipse.emf.ecore.EModelElement modelElement) Accesses to the annotation for TOTAL_FOUND_TAG and increases it.
void	registerInclusion(org.eclipse.emf.ecore.EModelElement modelElement, java.lang.String name) Keeps track of where an attribute/reference has been found This situation arises when two classes have been merged and therefore their attributes as well.
void	registerName(org.eclipse.emf.ecore.EModelElement modelElement, java.lang.String name) Register a new name for a EModelElement.
void	registerSourceName(org.eclipse.emf.ecore.EClass modelElement, java.lang.String name) Set the value for the SOURCE_NAME_TAG tag, which keeps track of the name of the JSON source

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static AnnotationHelper INSTANCE

AnnotationHelper is used as singleton, this is the instance

TOTAL_FOUND_TAG

private static final java.lang.String TOTAL_FOUND_TAG

Tag used for the total number of found elements

Added to each attribute/reference to count the times it has been found

See Also:

Constant Field Values

COVERAGE_TAG

private static final java.lang.String COVERAGE_TAG

Tag used for referring to the coverage

The value indicates the number of clases including such attribute/reference

See Also:

Constant Field Values

RATIO_TOTAL_FOUND_TAG

private static final java.lang.String RATIO_TOTAL_FOUND_TAG

Tag used for the annotation related to the ratio of total found

This value is the ratio version of the TOTAL_FOUND_TAG

See Also:

Constant Field Values

AKA_TAG

private static final java.lang.String AKA_TAG

Tag used for the annotation of the a.k.a. found elements

This annotation allows tracking the set of names used for an attribute/reference/class

See Also:

Constant Field Values

FOUND_IN_TAG

private static final java.lang.String FOUND_IN_TAG

Tag used to keep track on where an elements has been found

See Also:

Constant Field Values

SOURCE_NAME_TAG

private static final java.lang.String SOURCE_NAME_TAG

Tag used to keep track of which source the element has been found

See Also:

Constant Field Values

Constructor Detail

AnnotationHelper

private AnnotationHelper()

Constructor. As this class is singleton, no need to be public.

Method Detail

getCoverageAnnotation

public org.eclipse.emf.ecore.EAnnotation getCoverageAnnotation(org.eclipse.emf.ecore.EModelElement modelElement)

Access to the annotation for COVERAGE_TAG. To be edited afterwards.

Parameters:

modelElement - The model element from which the annotation has to be retrieved

Returns:

The EAnnotation element

getFoundInAnnotation

public org.eclipse.emf.ecore.EAnnotation getFoundInAnnotation(org.eclipse.emf.ecore.EModelElement modelElement)

Access to the annotation for FOUND_IN_TAG. To be edited afterwards.

Parameters:

modelElement - The model element from which the annotation has to be retrieved

Returns:

The EAnnotation element

getAkaAnnotation

public org.eclipse.emf.ecore.EAnnotation getAkaAnnotation(org.eclipse.emf.ecore.EModelElement modelElement)

Access to the annotation for AKA_TAG. To be edited afterwards.

Parameters:

modelElement - The model element from which the annotation has to be retrieved

Returns:

The EAnnotation element

increaseTotalFound

public void increaseTotalFound(org.eclipse.emf.ecore.EModelElement modelElement)

Accesses to the annotation for TOTAL_FOUND_TAG and increases it.

Parameters:

modelElement - The model element from which the annotation has to be retrieved

calculateCoverage

public void calculateCoverage(org.eclipse.emf.ecore.EPackage ePackage)

Calculate the value for the annotation RATIO_TOTAL_FOUND_TAG.

Parameters:

ePackage - The model element from which the annotation has to be retrieved

registerInclusion

public void registerInclusion(org.eclipse.emf.ecore.EModelElement modelElement,
                              java.lang.String name)

Keeps track of where an attribute/reference has been found

This situation arises when two classes have been merged and therefore their attributes as well. To keep track of from where each atribute is coming, the tag indicates the name of the origin class

Parameters:

modelElement - The model element from which the annotation has to be retrieved

name - The name of the containing class

registerName

public void registerName(org.eclipse.emf.ecore.EModelElement modelElement,
                         java.lang.String name)

Register a new name for a EModelElement.

This is used when, in a discovery process, two clases/attributes/references are considered similar and merged. This tag helps keeping track of all the names of the model element.

Parameters:

modelElement - The model element from which the annotation has to be retrieved

name - The extra name of the element

getTotalFound

public int getTotalFound(org.eclipse.emf.ecore.EModelElement modelElement)

Access to the annotation for TOTAL_FOUND_TAG. To be edited afterwards.

Parameters:

modelElement - The model element from which the annotation has to be retrieved

Returns:

The EAnnotation element

getRatioTotalFound

public double getRatioTotalFound(org.eclipse.emf.ecore.EModelElement modelElement)

Access to the annotation for RATIO_TOTAL_FOUND_TAG. To be edited afterwards.

Parameters:

modelElement - The model element from which the annotation has to be retrieved

Returns:

The EAnnotation element

getAka

public java.util.List<java.lang.String> getAka(org.eclipse.emf.ecore.EModelElement modelElement)

Obtains the list of Strings with all the a.k.a. values for a EModelElement

Parameters:

modelElement - The model element to query

Returns:

The list of Strings

registerSourceName

public void registerSourceName(org.eclipse.emf.ecore.EClass modelElement,
                               java.lang.String name)

Set the value for the SOURCE_NAME_TAG tag, which keeps track of the name of the JSON source

Parameters:

modelElement - The model element to set

name - The name of the JSON source

getSourceName

public java.lang.String getSourceName(org.eclipse.emf.ecore.EClass modelElement)

Obtains the value of the SOURCE_NAME_TAG tag, which keeps track of the name of the JSON source

Parameters:

modelElement - The model element to set

Returns:

The value of the SOURCE_NAME_TAG tag

cleanAnnotations

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

Remove all the annotations. Be careful, the method returns the same epackage.

Parameters:

ePackage - The metamodel to clean (as EPackage

Returns:

The cleaned metamodel (as EPackage