org.eclipse.emf.ecore.util
Class EcoreUtil.ExternalCrossReferencer

java.lang.Object
  extended byjava.util.AbstractMap
      extended byjava.util.HashMap
          extended byorg.eclipse.emf.ecore.util.EcoreUtil.CrossReferencer
              extended byorg.eclipse.emf.ecore.util.EcoreUtil.ExternalCrossReferencer
All Implemented Interfaces:
Cloneable, Map, Serializable
Enclosing class:
EcoreUtil

public static class EcoreUtil.ExternalCrossReferencer
extends EcoreUtil.CrossReferencer

A cross referencer that finds all references that are not contained within the content trees.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.eclipse.emf.ecore.util.EcoreUtil.CrossReferencer
emfObjects
 
Constructor Summary
protected EcoreUtil.ExternalCrossReferencer(Collection emfObjects)
          Creates an instance for the given collection of objects.
protected EcoreUtil.ExternalCrossReferencer(EObject eObject)
          Creates an instance for the given object.
protected EcoreUtil.ExternalCrossReferencer(Resource resource)
          Creates an instance for the given resource.
protected EcoreUtil.ExternalCrossReferencer(ResourceSet resourceSet)
          Creates an instance for the given resource set.
 
Method Summary
protected  boolean crossReference(EObject eObject, EReference eReference, EObject crossReferencedEObject)
          Return true if the specified eReference from eObject to crossReferencedEObject should be considiered a cross reference by this cross referencer.
static Map find(Collection emfObjectsToSearch)
          Returns a map of all external cross references from the combined content trees of the specified collection of objects.
static Map find(EObject eObject)
          Returns a map of all external cross references from the specified content tree.
static Map find(Resource resource)
          Returns a map of all external cross references from the specified content tree.
static Map find(ResourceSet resourceSet)
          Returns a map of all external cross references from the specified content tree.
protected  Map findExternalCrossReferences()
          Returns the map of external cross references for this cross referencer.
 
Methods inherited from class org.eclipse.emf.ecore.util.EcoreUtil.CrossReferencer
add, containment, crossReference, done, getCollection, getCrossReferences, handleCrossReference, newCollection, newContentsIterator, print, print, resolve, toString
 
Methods inherited from class java.util.HashMap
clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from class java.util.AbstractMap
equals, hashCode
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Constructor Detail

EcoreUtil.ExternalCrossReferencer

protected EcoreUtil.ExternalCrossReferencer(Collection emfObjects)
Creates an instance for the given collection of objects.

Parameters:
emfObjects - the collection of objects to cross reference.

EcoreUtil.ExternalCrossReferencer

protected EcoreUtil.ExternalCrossReferencer(EObject eObject)
Creates an instance for the given object.

Parameters:
eObject - the object to cross reference.

EcoreUtil.ExternalCrossReferencer

protected EcoreUtil.ExternalCrossReferencer(Resource resource)
Creates an instance for the given resource.

Parameters:
resource - the resource to cross reference.

EcoreUtil.ExternalCrossReferencer

protected EcoreUtil.ExternalCrossReferencer(ResourceSet resourceSet)
Creates an instance for the given resource set.

Parameters:
resourceSet - the resource set to cross reference.
Method Detail

crossReference

protected boolean crossReference(EObject eObject,
                                 EReference eReference,
                                 EObject crossReferencedEObject)
Return true if the specified eReference from eObject to crossReferencedEObject should be considiered a cross reference by this cross referencer.

Overrides:
crossReference in class EcoreUtil.CrossReferencer
Parameters:
eObject - an object in the cross referencer's content tree.
eReference - a reference from the object.
crossReferencedEObject - the target of the specified reference.
Returns:
if the cross referencer should consider the specified reference a cross reference.

findExternalCrossReferences

protected Map findExternalCrossReferences()
Returns the map of external cross references for this cross referencer.

Returns:
a map of cross references.

find

public static Map find(EObject eObject)
Returns a map of all external cross references from the specified content tree.

Parameters:
eObject - an object whose content trees should be considered.
Returns:
a map of cross references.

find

public static Map find(Resource resource)
Returns a map of all external cross references from the specified content tree.

Parameters:
resource - a resource whose content tree should be considered.
Returns:
a map of cross references.

find

public static Map find(ResourceSet resourceSet)
Returns a map of all external cross references from the specified content tree.

Parameters:
resourceSet - a resourceSet whose content tree should be considered.
Returns:
a map of cross references.

find

public static Map find(Collection emfObjectsToSearch)
Returns a map of all external cross references from the combined content trees of the specified collection of objects.

Parameters:
emfObjectsToSearch - a collection of objects whose combined content trees should be considered.
Returns:
a map of cross references.

Copyright 2001-2006 IBM Corporation and others.
All Rights Reserved.