org.eclipse.gmf.runtime.emf.core.util
Class CrossReferenceAdapter

java.lang.Object
  org.eclipse.emf.ecore.util.ECrossReferenceAdapter
      org.eclipse.gmf.runtime.emf.core.util.CrossReferenceAdapter

All Implemented Interfaces:

Adapter, Adapter.Internal

public class CrossReferenceAdapter

extends ECrossReferenceAdapter

An adapter that maintains itself as an adapter for all contained objects. It can be installed for an EObject, a Resource, or a ResourceSet.

This adapter maintain information on inverse references, resource imports, and resource exports.

Nested Class Summary

Nested classes inherited from class org.eclipse.emf.ecore.util.ECrossReferenceAdapter

ECrossReferenceAdapter.InverseCrossReferencer

Nested classes inherited from class org.eclipse.emf.common.notify.Adapter

Adapter.Internal

Field Summary

Fields inherited from class org.eclipse.emf.ecore.util.ECrossReferenceAdapter

inverseCrossReferencer, unloadedResources

Constructor Summary

CrossReferenceAdapter()
Initializes me.

CrossReferenceAdapter(boolean resolve)
Initializes me.

Method Summary

protected void	exportAdded(Resource referenced, Resource referencer) Hook to be implemented by subclasses upon the establishment of a new export of the referenced resource to the referencer.
protected void	exportRemoved(Resource referenced, Resource referencer) Hook to be implemented by subclasses upon the elimination of an export of the referenced resource to the referencer.
static CrossReferenceAdapter	getCrossReferenceAdapter(ResourceSet resourceSet) Obtains the cross-reference adapter for the specified resource set, if necessary creating it and attaching it.
static CrossReferenceAdapter	getExistingCrossReferenceAdapter(Notifier notifier) Searches the adapter list of the given Notifier for a CrossReferenceAdapter.
java.util.Set	getExports(Resource referenced) Gets the exports of a resource.
java.util.Set	getImports(Resource referencer) Gets the imports of a resource.
java.util.Set	getInverseReferencers(EObject referenced, EReference reference, EClass type) Returns a Set of EObjects that reference the given EObject.
java.util.Collection	getInverseReferences(EObject eObject, boolean resolve)
java.util.Set	getNonNavigableInverseReferencers(EObject referenced, EReference reference, EClass type) Returns a Set of EObjects that reference the given EObject through a uni directional EReferences.
protected void	handleContainment(Notification notification) Extends the superclass method to handle the removal cases of containment, to tear down aggregate (resource-level) cross-references.
protected void	importAdded(Resource referencer, Resource referenced) Hook to be implemented by subclasses upon the establishment of a new import of the referenced resource by the referencer.
protected void	importRemoved(Resource referencer, Resource referenced) Hook to be implemented by subclasses upon the elimination of an import of the referenced resource by the referencer.
protected boolean	resolve()
void	selfAdapt(Notification notification) Updates imports and exports maps.
void	setTarget(Notifier target)
void	unsetTarget(Notifier notifier)
void	updateImportsAndExports(Resource resource, EObject value, boolean register) Updates the imports and exports map for the specified eObject
void	updateImportsAndExportsForContents(Resource resource, EObject value, boolean register) Updates the imports and exports map for the contents of the specified eObject

Methods inherited from class org.eclipse.emf.ecore.util.ECrossReferenceAdapter

addAdapter, createInverseCrossReferencer, dump, getCrossReferenceAdapter, getInverseReferences, getNonNavigableInverseReferences, getNonNavigableInverseReferences, getTarget, handleCrossReference, isAdapterForType, isIncluded, notifyChanged, removeAdapter, resolveAll, setTarget, setTarget, setTarget, unsetTarget, unsetTarget, unsetTarget

Methods inherited from class java.lang.Object

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

Constructor Detail

CrossReferenceAdapter

public CrossReferenceAdapter()

Initializes me.

CrossReferenceAdapter

public CrossReferenceAdapter(boolean resolve)

Initializes me.

Parameters:

resolve - flag to determine if the proxies need to be resolved

Method Detail

selfAdapt

public void selfAdapt(Notification notification)

Updates imports and exports maps.

Parameters:

notification - the event notification

handleContainment

protected void handleContainment(Notification notification)

Extends the superclass method to handle the removal cases of containment, to tear down aggregate (resource-level) cross-references.

updateImportsAndExports

public void updateImportsAndExports(Resource resource,
                                    EObject value,
                                    boolean register)

Updates the imports and exports map for the specified eObject

Parameters:

resource - a resource

register - boolean flag to indicate whether to register imports or unregister imports

updateImportsAndExportsForContents

public void updateImportsAndExportsForContents(Resource resource,
                                               EObject value,
                                               boolean register)

Updates the imports and exports map for the contents of the specified eObject

Parameters:

resource - a resource

register - boolean flag to indicate whether to register imports or unregister imports

setTarget

public void setTarget(Notifier target)

See Also:

ECrossReferenceAdapter.setTarget(org.eclipse.emf.common.notify.Notifier)

unsetTarget

public void unsetTarget(Notifier notifier)

See Also:

ECrossReferenceAdapter.unsetTarget(org.eclipse.emf.common.notify.Notifier)

getImports

public java.util.Set getImports(Resource referencer)

Gets the imports of a resource.

Parameters:

referencer - the resource to retrieve imports for

Returns:

a Set of resource imports

getExports

public java.util.Set getExports(Resource referenced)

Gets the exports of a resource.

Parameters:

referenced - the resource to retrieve exports for

Returns:

a Set of resource exports

importAdded

protected void importAdded(Resource referencer,
                           Resource referenced)

Hook to be implemented by subclasses upon the establishment of a new import of the referenced resource by the referencer. This implementation does nothing; subclasses need not call super.

Parameters:

referencer - the referencing resource (doing the importing)

referenced - the resource that it references

importRemoved

protected void importRemoved(Resource referencer,
                             Resource referenced)

Hook to be implemented by subclasses upon the elimination of an import of the referenced resource by the referencer. This implementation does nothing; subclasses need not call super.

Parameters:

referencer - the formerly referencing resource (doing the importing)

referenced - the resource that it had referenced

exportAdded

protected void exportAdded(Resource referenced,
                           Resource referencer)

Hook to be implemented by subclasses upon the establishment of a new export of the referenced resource to the referencer. This implementation does nothing; subclasses need not call super.

Parameters:

referenced - the resource being referenced (doing the exporting)

referencer - the referencing resource

exportRemoved

protected void exportRemoved(Resource referenced,
                             Resource referencer)

Hook to be implemented by subclasses upon the elimination of an export of the referenced resource to the referencer. This implementation does nothing; subclasses need not call super.

Parameters:

referenced - the resource formerly being referenced (doing the exporting)

referencer - the formerly referencing resource

getInverseReferencers

public java.util.Set getInverseReferencers(EObject referenced,
                                           EReference reference,
                                           EClass type)

Returns a Set of EObjects that reference the given EObject. If an EReference is specified, the scope of the search is limited only to that EReference. To include all references specify a value of null. If an EClass type is specified, the returned Set will only include those referencers that match the given type. To include all types specify a value of null.

Parameters:

referenced - the referenced EObject

reference - the reference to find referencers on, null for any reference

type - the type of the referencers, use null for any type

Returns:

a Set of referencers

getNonNavigableInverseReferencers

public java.util.Set getNonNavigableInverseReferencers(EObject referenced,
                                                       EReference reference,
                                                       EClass type)

Returns a Set of EObjects that reference the given EObject through a uni directional EReferences. If an EReference is specified, the scope of the search is limited only to that EReference. To include all references specify a value of null. If an EClass type is specified, the returned Set will only include those referencers that match the given type. To include all types specify a value of null.

Parameters:

referenced - the referenced EObject

reference - the reference to find referencers on, null for any reference

type - the type of the referencers, use null for any type

Returns:

a Set of referencers

getExistingCrossReferenceAdapter

public static CrossReferenceAdapter getExistingCrossReferenceAdapter(Notifier notifier)

Searches the adapter list of the given Notifier for a CrossReferenceAdapter. If not found, returns null.

Parameters:

notifier - the notifier to search

Returns:

the CrossReferenceAdapter if found, otherwise null

getCrossReferenceAdapter

public static CrossReferenceAdapter getCrossReferenceAdapter(ResourceSet resourceSet)

Obtains the cross-reference adapter for the specified resource set, if necessary creating it and attaching it.

Parameters:

resourceSet - the resource set

Returns:

the resourceSet's cross-reference adapter

resolve

protected boolean resolve()

getInverseReferences

public java.util.Collection getInverseReferences(EObject eObject,
                                                 boolean resolve)