public interface IComparisonScope
The scope will be called on all three root Notifiers in order to determine the range of a given comparison; only those Notifiers will be matched by EMF Compare.
An implementation using Predicates to filter out the children lists can be sub-classed instead, see
FilterComparisonScope
.
AbstractComparisonScope
,
FilterComparisonScope
Modifier and Type | Method and Description |
---|---|
Iterator<? extends EObject> |
getChildren(EObject eObject)
This will be used by EMF Compare in order to know which EObjects should be considered to be part of the
comparison scope when it is launched on the given EObject.
|
Iterator<? extends EObject> |
getCoveredEObjects(Resource resource)
This will be used by EMF Compare in order to determine the EObjects that it should iterate over.
|
Iterator<? extends Resource> |
getCoveredResources(ResourceSet resourceSet)
This will be used by EMF Compare in order to determine the Resources that should be considered part of
the comparison when it is launched on the given resource set.
|
Notifier |
getLeft()
This will be used by EMF Compare in order to retrieve the left "root" Notifier of this comparison; i.e
the first object to be considered by the match engine, and from which the iteration over children
should start.
|
Set<String> |
getNsURIs()
This will be used by EMF Compare in order to retrieve the namespace uris detected in the scope.
|
Notifier |
getOrigin()
If EMF Compare should consider a Notifier as being the common ancestor of the "left" and "right"
objects to compare, it should be returned from here.
|
Set<String> |
getResourceURIs()
This will be used by EMF Compare in order to retrieve the resource uris detected in the scope.
|
Notifier |
getRight()
This will be used by EMF Compare in order to retrieve the right "root" Notifier of this comparison; i.e
the first object to be considered by the match engine, and from which the iteration over children
should start.
|
Notifier getLeft()
null
.Notifier getRight()
null
.Notifier getOrigin()
null
.Iterator<? extends Resource> getCoveredResources(ResourceSet resourceSet)
Do note that this will only be called once per Resource. We will retrieve the set of EMF resources to
include in the comparison, match them, then use getCoveredEObjects(Resource)
in order to
determine the actual EObjects to cover during that comparison.
resourceSet
- The resource set for which we need to know all resources spanned by the comparison.Resource
s which are part of this scope.Iterator<? extends EObject> getCoveredEObjects(Resource resource)
Do note that this will only be called once per comparison. EMF Compare expects this to return the whole set of EObjects that should be covered by the comparison when launched on the given Resource.
resource
- The resource for which we need to determine all EObjects spanned by the comparison.EObject
s which are part of this scope.Iterator<? extends EObject> getChildren(EObject eObject)
Do note that this will only be called once per comparison on EObjects, and never for comparisons
launched on ResourceSet
s or Resource
s. EMF Compare expects the whole set of EObject
that should be covered by the comparison to be returned by this.
eObject
- The EObject for which we need to determine the comparison scope.EObject
s which are part of this scope.Set<String> getNsURIs()
Copyright (c) 2006, 2014 Obeo and others. All rights reserved.