net.mdatools.modelant.core.operation.model

Class CompareModels

java.lang.Object

net.mdatools.modelant.core.operation.model.CompareModels

All Implemented Interfaces:

Function<javax.jmi.reflect.RefPackage,ModelComparisonResult>

public class CompareModels
extends Object
implements Function<javax.jmi.reflect.RefPackage,ModelComparisonResult>

Identify structural differences between two models loaded in separate extents in the current repository. They are treated as different versions of a common model, so one of them is referred as old, whereas the other is referred as new. The comparison is done according explicitly provided:

• matching criteria stating for each metamodel class what attributes and associations to compare bound to an instance in the old object and to an instance in the new model, in order to treat both instances as corresponding.
• changeDetectionCriteria relaxing the matching criteria, so that any not matching objects, due to the matching criteria, but matching due to this one are considered as moved or changed elements.

A model elements from the "new" model is treated as equal to a model element from the "old" model, if:

• both they have equal (primitive) values of the attributes
• AND they refer equal objects through associations

Model elements, for which there are no criteria (attributes or associations) specified for their class are treated as NOT EQUAL.

Author:

Rusi Popov (popovr@mdatools.net)

Field Summary

Fields inherited from interface net.mdatools.modelant.core.api.Function

IDENTITY

Constructor Summary

Constructors

Constructor and Description
CompareModels(MatchingCriteria exactMatchCriteria, MatchingCriteria exceptionMatchCriteria, List<ConsideredEqual> bindings, javax.jmi.reflect.RefPackage sourceModelExtent) Use the same exact match and relaxed match criteria, this way treating as not identical the elements, that are different according to the matching criteria.

Method Summary

Modifier and Type	Method and Description
ModelComparisonResult	execute(javax.jmi.reflect.RefPackage targetModelExtent)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.mdatools.modelant.core.api.Function

toString

Constructor Detail

CompareModels

public CompareModels(MatchingCriteria exactMatchCriteria,
                     MatchingCriteria exceptionMatchCriteria,
                     List<ConsideredEqual> bindings,
                     javax.jmi.reflect.RefPackage sourceModelExtent)

Use the same exact match and relaxed match criteria, this way treating as not identical the elements, that are different according to the matching criteria.

Parameters:

exactMatchCriteria - not null criteria stating for each metamodel class what attributes and associations to compare bound to an instance in the old object and to an instance in the new model, in order to treat both instances as corresponding. Thus, elements that match according to this criteria are treated as equal / same, whereas any other elements are treated as added or deleted.

exceptionMatchCriteria - non null criteria which attributes and associations to skip in the identification of elements differences.

bindings - non null list defines explicitly listed objects as equals (even though they are not equal in the sense of exactMatchCriteria). These are model elements that should be treated as a-priori equal.

sourceModelExtent - not null extent holding the model, treated as "old"

See Also:

CompareModels(MatchingCriteria, MatchingCriteria, List, RefPackage)

Method Detail

execute

public ModelComparisonResult execute(javax.jmi.reflect.RefPackage targetModelExtent)
                              throws IllegalArgumentException

Specified by:

execute in interface Function<javax.jmi.reflect.RefPackage,ModelComparisonResult>

Parameters:

targetModelExtent - The extent where the new model is loaded

Returns:

a non-null result of comparison of newRootPackage treated as a "new version" of a model and oldRootPackage, treated as its "old version". The result describes the changes happened in the old vresion in order to produce the new one. result.getEquals() != null The ADDED/DELETED model elements are ordered by LEVEL descending, metaclass ascending, values ascending

Throws:

IllegalArgumentException