fr.inria.atlanmod.neoemf.resource

Class PersistentResourceDecorator

java.lang.Object

fr.inria.atlanmod.neoemf.resource.PersistentResourceDecorator

All Implemented Interfaces:

PersistentResource, Closeable, AutoCloseable, Notifier, Resource, Resource.Internal

public class PersistentResourceDecorator
extends Object
implements PersistentResource

A PersistentResource wrapper that delegates all method calls to the decorated resource.

This class can be extended by external tools to add behavior to an existing PersistentResource.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.emf.ecore.resource.Resource

Resource.Diagnostic, Resource.Factory, Resource.Internal, Resource.IOWrappedException

Field Summary

Fields

Modifier and Type	Field and Description
protected PersistentResource	resource The underlying resource.

Fields inherited from interface org.eclipse.emf.ecore.resource.Resource

OPTION_CIPHER, OPTION_LINE_DELIMITER, OPTION_LINE_DELIMITER_UNSPECIFIED, OPTION_SAVE_ONLY_IF_CHANGED, OPTION_SAVE_ONLY_IF_CHANGED_FILE_BUFFER, OPTION_SAVE_ONLY_IF_CHANGED_MEMORY_BUFFER, OPTION_ZIP, RESOURCE__CONTENTS, RESOURCE__ERRORS, RESOURCE__IS_LOADED, RESOURCE__IS_MODIFIED, RESOURCE__IS_TRACKING_MODIFICATION, RESOURCE__RESOURCE_SET, RESOURCE__TIME_STAMP, RESOURCE__URI, RESOURCE__WARNINGS

Constructor Summary

Constructors

Constructor and Description
PersistentResourceDecorator(PersistentResource resource) Constructs a PersistentResourceDecorator on the given resource.

Method Summary

Modifier and Type	Method and Description
void	attached(EObject eObject) Called when the object is attached to this resource, i.e., when it's eResource changes to be this one.
NotificationChain	basicSetResourceSet(ResourceSet resourceSet, NotificationChain notifications) Sets the resource to be contained by the given resource set, and returns the notifications this produces.
void	close()
void	delete(Map<?,?> options) deletes the resource using the specified options, unloads it, and then removes it from the containing resource set.
void	detached(EObject eObject) Called when the object is detached from this resource, i.e., when it's eResource changes to no longer be this one.
EList<Adapter>	eAdapters() Returns list of the adapters associated with this notifier.
boolean	eDeliver() Returns whether this notifier will deliver notifications to the adapters.
void	eNotify(Notification notification) Notifies a change to a feature of this notifier as described by the notification.
void	eSetDeliver(boolean deliver) Sets whether this notifier will deliver notifications to the adapters.
InternalEObject.EStore	eStore() Returns the InternalEObject.EStore used to store the model.
TreeIterator<EObject>	getAllContents() Returns a tree iterator that iterates over all the direct contents and indirect contents of this resource.
EList<EObject>	getAllInstances(EClass eClass) Computes the set of instances of the given EClass (including its sub-types).
EList<EObject>	getAllInstances(EClass eClass, boolean strict) Computes the set of instances of the given EClass.
EList<EObject>	getContents() Returns the list of the direct content objects; each is of type EObject.
EObject	getEObject(String uriFragment) Returns the resolved object for the given URI fragment.
EList<Resource.Diagnostic>	getErrors() Returns a list of the errors in the resource; each error will be of type Resource.Diagnostic.
ResourceSet	getResourceSet() Returns the containing resource set.
long	getTimeStamp() Returns the cached value of the time stamp when this resource was last loaded or saved, or NULL_TIME_STAMP if the resource is not loaded and the time stamp has not been set.
URI	getURI() Returns the URI of this resource.
String	getURIFragment(EObject eObject) Returns the URI fragment that, when passed to getEObject will return the given object.
EList<Resource.Diagnostic>	getWarnings() Returns a list of the warnings and informational messages in the resource; each warning will be of type Resource.Diagnostic.
boolean	isLoaded() Returns whether the resource is loaded.
boolean	isLoading() Indicates whether the resource is currently being loaded.
boolean	isModified() Returns whether this resource has been modified.
boolean	isTrackingModification() Returns whether modification tracking is enabled.
void	load(InputStream inputStream, Map<?,?> options) Loads the resource from the input stream using the specified options.
void	load(Map<?,?> options) Loads the resource using the specified options.
void	save(Map<?,?> options) Saves the resource using the specified options.
void	save(OutputStream outputStream, Map<?,?> options) Saves the resource to the output stream using the specified options.
void	setModified(boolean isModified) Sets whether this resource has been modified.
void	setTimeStamp(long timeStamp) Sets the value of the time stamp.
void	setTrackingModification(boolean isTrackingModification) Sets whether modification tracking is enabled.
void	setURI(URI uri) Sets the URI of this resource.
void	unload() Clears the contents, errors, and warnings of the resource and marks it as unloaded.

Methods inherited from class java.lang.Object

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

Field Detail

resource

protected final PersistentResource resource

The underlying resource.

Constructor Detail

PersistentResourceDecorator

public PersistentResourceDecorator(PersistentResource resource)

Constructs a PersistentResourceDecorator on the given resource.

Parameters:

resource - the underlying resource

Method Detail

getResourceSet

public ResourceSet getResourceSet()

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Returns the containing resource set. A resource is contained by a resource set if it appears in the resources, i.e., the contents, of that resource set. This reference can only be modified by altering the contents of the resource set directly.

Specified by:

getResourceSet in interface Resource

Returns:

the containing resource set, or null if there isn't one.

See Also:

EObject.eContainer(), EObject.eResource(), ResourceSet.getResources()

getURI

public URI getURI()

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Returns the URI of this resource. The URI is normally expected to be absolute and hierarchical; document-relative references will not be serialized and will not be resolved, if this is not the case.

Specified by:

getURI in interface Resource

Returns:

the URI of this resource, or null if there isn't one.

See Also:

Resource.setURI(URI), URI.isRelative(), URI.isHierarchical()

setURI

public void setURI(URI uri)

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Sets the URI of this resource.

Specified by:

setURI in interface Resource

Parameters:

uri - the new URI.

See Also:

Resource.getURI()

getTimeStamp

public long getTimeStamp()

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Returns the cached value of the time stamp when this resource was last loaded or saved, or NULL_TIME_STAMP if the resource is not loaded and the time stamp has not been set. The return value is represented as the number of milliseconds since the epoch (00:00:00 GMT, January 1, 1970). The returned value may not be the same as the actual time stamp if the resource has been modified via external means since the last load or save.

Specified by:

getTimeStamp in interface Resource

See Also:

Resource.setTimeStamp(long)

setTimeStamp

public void setTimeStamp(long timeStamp)

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Sets the value of the time stamp. The time stamp is typically set indirectly via other operations on the resource such as loading and saving.

Specified by:

setTimeStamp in interface Resource

Parameters:

timeStamp - the new value of the time stamp.

See Also:

Resource.getTimeStamp(), Resource.RESOURCE__TIME_STAMP

getContents

public EList<EObject> getContents()

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Returns the list of the direct content objects; each is of type EObject.

The contents may be directly modified. Removing an object will have the same effect as EcoreUtil.remove(EObject). Adding an object will remove it from the previous container; it's container will be null and it's resource will the this.

Specified by:

getContents in interface Resource

Returns:

the direct content objects.

getAllContents

public TreeIterator<EObject> getAllContents()

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Returns a tree iterator that iterates over all the direct contents and indirect contents of this resource.

Specified by:

getAllContents in interface Resource

Returns:

a tree iterator that iterates over all contents.

See Also:

EObject.eAllContents(), ResourceSet.getAllContents(), EcoreUtil.getAllContents(Resource, boolean)

getURIFragment

public String getURIFragment(EObject eObject)

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Returns the URI fragment that, when passed to getEObject will return the given object.

In other words, the following is true for any object contained by a resource:

   Resource resource = eObject.eResource();
   eObject == resource.getEObject(resource.getURIFragment(eObject))

An implementation may choose to use IDs or to use structured URI fragments, as supported by eURIFragmentSegment.

Specified by:

getURIFragment in interface Resource

Parameters:

eObject - the object to identify.

Returns:

the URI fragment for the object.

See Also:

Resource.getEObject(String), InternalEObject.eURIFragmentSegment(org.eclipse.emf.ecore.EStructuralFeature, EObject)

getEObject

public EObject getEObject(String uriFragment)

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Returns the resolved object for the given URI fragment.

The fragment encoding will typically be that produced by getURIFragment.

Specified by:

getEObject in interface Resource

Parameters:

uriFragment - the fragment to resolve.

Returns:

the resolved object for the given fragment, or null if it can't be resolved.

See Also:

Resource.getURIFragment(EObject), ResourceSet.getEObject(URI, boolean), EcoreUtil.resolve(EObject, ResourceSet), InternalEObject.eObjectForURIFragmentSegment(String)

save

public void save(Map<?,?> options)
          throws IOException

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Saves the resource using the specified options.

Options are handled generically as feature-to-setting entries; the resource will ignore options it doesn't recognize. The options could even include things like an Eclipse progress monitor...

An implementation typically uses the URI converter of the containing resource set to create an output stream, and then delegates to save(OutputStream, Map).

Specified by:

save in interface Resource

Parameters:

options - the save options.

Throws:

IOException

See Also:

Resource.save(OutputStream, Map)

load

public void load(Map<?,?> options)
          throws IOException

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Loads the resource using the specified options.

Options are handled generically as feature-to-setting entries; the resource will ignore options it doesn't recognize. The options could even include things like an Eclipse progress monitor...

An implementation typically uses the URI converter of the containing resource set to create an input stream, and then delegates to load(InputStream, Map).

When the load completes, the errors and warnings can be consulted. An implementation will typically deserialize as much of a document as possible while producing diagnostics for any problems that are encountered.

Specified by:

load in interface Resource

Parameters:

options - the load options.

Throws:

IOException

See Also:

Resource.load(InputStream, Map)

save

public void save(OutputStream outputStream,
                 Map<?,?> options)
          throws IOException

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Saves the resource to the output stream using the specified options.

Usually, save(Map) is called directly and it calls this.

Specified by:

save in interface Resource

Parameters:

outputStream - the stream

options - the save options.

Throws:

IOException

See Also:

Resource.save(Map), Resource.load(InputStream, Map)

load

public void load(InputStream inputStream,
                 Map<?,?> options)
          throws IOException

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Loads the resource from the input stream using the specified options.

Usually, load(Map) is called directly and it calls this.

Specified by:

load in interface Resource

Parameters:

inputStream - the stream

options - the load options.

Throws:

IOException

See Also:

Resource.load(Map), Resource.save(OutputStream, Map)

isTrackingModification

public boolean isTrackingModification()

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Returns whether modification tracking is enabled.

If modification tracking is enabled, each object of the resource must be adapted in order to listen for changes. This will make the processing of attached and detached significantly more expensive. as well as all model editing, in general.

Specified by:

isTrackingModification in interface Resource

Returns:

whether modification tracking is enabled.

setTrackingModification

public void setTrackingModification(boolean isTrackingModification)

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Sets whether modification tracking is enabled.

Calling this method is expensive because it walks the content tree to add or remove adapters.

Specified by:

setTrackingModification in interface Resource

Parameters:

isTrackingModification - whether modification tracking is to be enabled.

isModified

public boolean isModified()

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Returns whether this resource has been modified.

A resource is set to be unmodified after it is loaded or saved. Automatic modification tracking is supported, but it is expensive. Moreover, it is a poor fit for a model that supports undoable commands, since an undo looks like a change when it's really exactly the opposite.

Specified by:

isModified in interface Resource

Returns:

whether this resource has been modified.

See Also:

Resource.setModified(boolean)

setModified

public void setModified(boolean isModified)

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Sets whether this resource has been modified.

A resource is automatically set to be unmodified after it is loaded or saved. Automatic modification tracking typically calls this directly.

Specified by:

setModified in interface Resource

Parameters:

isModified - whether this resource has been modified.

See Also:

Resource.isModified()

isLoaded

public boolean isLoaded()

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Returns whether the resource is loaded.

This will be false when the resource is first created and will be set to false, when the resource is unloaded. It will be set to true when the resource is loaded and when contents are first added to a resource that isn't loaded. Calling clear for the contents of a resource that isn't loaded, will set the resource to be loaded; this is the simplest way to create an empty resource that's considered loaded.

Specified by:

isLoaded in interface Resource

Returns:

whether the resource is loaded.

unload

public void unload()

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Clears the contents, errors, and warnings of the resource and marks it as unloaded.

It walks the content tree, and sets each content object to be a proxy. The resource will remain in the resource set, and can be subsequently reloaded.

Specified by:

unload in interface Resource

delete

public void delete(Map<?,?> options)
            throws IOException

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

deletes the resource using the specified options, unloads it, and then removes it from the containing resource set.

Options are handled generically as feature-to-setting entries; the resource will ignore options it doesn't recognize. The options could even include things like an Eclipse progress monitor...

An implementation typically uses the URI converter of the containing resource set to URIConverter.delete(URI, Map) the resource's URI.

Specified by:

delete in interface Resource

Throws:

IOException

getErrors

public EList<Resource.Diagnostic> getErrors()

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Returns a list of the errors in the resource; each error will be of type Resource.Diagnostic.

These will typically be produced as the resource is loaded.

Specified by:

getErrors in interface Resource

Returns:

a list of the errors in the resource.

See Also:

Resource.load(Map)

getWarnings

public EList<Resource.Diagnostic> getWarnings()

Description copied from interface: org.eclipse.emf.ecore.resource.Resource

Returns a list of the warnings and informational messages in the resource; each warning will be of type Resource.Diagnostic.

These will typically be produced as the resource is loaded.

Specified by:

getWarnings in interface Resource

Returns:

a list of the warnings in the resource.

See Also:

Resource.load(Map)

eAdapters

public EList<Adapter> eAdapters()

Description copied from interface: org.eclipse.emf.common.notify.Notifier

Returns list of the adapters associated with this notifier.

Specified by:

eAdapters in interface Notifier

Returns:

the adapters associated with this notifier.

eDeliver

public boolean eDeliver()

Description copied from interface: org.eclipse.emf.common.notify.Notifier

Returns whether this notifier will deliver notifications to the adapters.

Specified by:

eDeliver in interface Notifier

Returns:

whether notifications will be delivered.

See Also:

Notifier.eSetDeliver(boolean)

eSetDeliver

public void eSetDeliver(boolean deliver)

Description copied from interface: org.eclipse.emf.common.notify.Notifier

Sets whether this notifier will deliver notifications to the adapters.

Specified by:

eSetDeliver in interface Notifier

Parameters:

deliver - whether or not to deliver.

See Also:

Notifier.eDeliver()

eNotify

public void eNotify(Notification notification)

Description copied from interface: org.eclipse.emf.common.notify.Notifier

Notifies a change to a feature of this notifier as described by the notification. The notifications will generally be delivered to the adapters via Adapter.notifyChanged.

Specified by:

eNotify in interface Notifier

Parameters:

notification - a description of the change.

attached

public void attached(EObject eObject)

Description copied from interface: org.eclipse.emf.ecore.resource.Resource.Internal

Called when the object is attached to this resource, i.e., when it's eResource changes to be this one.

An implementation that resolves based on IDs will need to walk the tree of this object in order to tabulate an index. An implementation that needs to track modification will also need to walk the tree in order to add the necessary adapter. In either of these cases, editing of containment relations will be significantly more expensive.

Specified by:

attached in interface Resource.Internal

Parameters:

eObject - the attached object.

See Also:

Resource.Internal.detached(EObject)

detached

public void detached(EObject eObject)

Description copied from interface: org.eclipse.emf.ecore.resource.Resource.Internal

Called when the object is detached from this resource, i.e., when it's eResource changes to no longer be this one.

An implementation that resolves based on IDs will need to walk the tree of this object in order clean up it's index. An implementation that needs to track modification will also need to walk the tree in order to remove the added adapter. In either of these cases, editing of containment relations will be significantly more expensive.

Specified by:

detached in interface Resource.Internal

Parameters:

eObject - the attached object.

See Also:

Resource.Internal.attached(EObject)

basicSetResourceSet

public NotificationChain basicSetResourceSet(ResourceSet resourceSet,
                                             NotificationChain notifications)

Description copied from interface: org.eclipse.emf.ecore.resource.Resource.Internal

Sets the resource to be contained by the given resource set, and returns the notifications this produces.

If it was previously contained by a resource set, it will have been removed.

Specified by:

basicSetResourceSet in interface Resource.Internal

Returns:

the notifications produced, or null if there aren't any.

isLoading

public boolean isLoading()

Description copied from interface: org.eclipse.emf.ecore.resource.Resource.Internal

Indicates whether the resource is currently being loaded.

This will be true during a call to load(InputStream, Map), before notifications are dispatched.

Specified by:

isLoading in interface Resource.Internal

Returns:

whether this resource is currently being loaded.

close

public final void close()

Specified by:

close in interface PersistentResource

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

eStore

public InternalEObject.EStore eStore()

Description copied from interface: PersistentResource

Returns the InternalEObject.EStore used to store the model.

Specified by:

eStore in interface PersistentResource

Returns:

the InternalEObject.EStore

getAllInstances

public EList<EObject> getAllInstances(EClass eClass)

Description copied from interface: PersistentResource

Computes the set of instances of the given EClass (including its sub-types).

This method is similar to PersistentResource.getAllInstances(EClass, boolean) with strict=false.

Specified by:

getAllInstances in interface PersistentResource

Parameters:

eClass - the EClass for which look for instances

Returns:

all the instances of the given EClass from the resource

getAllInstances

public EList<EObject> getAllInstances(EClass eClass,
                                      boolean strict)

Description copied from interface: PersistentResource

Computes the set of instances of the given EClass.

Specified by:

getAllInstances in interface PersistentResource

Parameters:

eClass - the EClass for which look for instances

strict - true if the lookup searches for strict instances

Returns:

if true then the method returns only the strict instances of the given EClass, otherwise it also returns the instances of the sub-types of eClass.