fr.inria.atlanmod.neoemf.resource

Interface PersistentResource

All Superinterfaces:

AutoCloseable, Closeable, Iterable<PersistentEObject>, org.eclipse.emf.common.notify.Notifier, org.eclipse.emf.ecore.resource.Resource, org.eclipse.emf.ecore.resource.Resource.Internal, Storable

All Known Implementing Classes:

DefaultPersistentResource, PersistentResourceDecorator

@ParametersAreNonnullByDefault
public interface PersistentResource
extends org.eclipse.emf.ecore.resource.Resource, org.eclipse.emf.ecore.resource.Resource.Internal, Storable, Closeable, Iterable<PersistentEObject>

A Resource that provides efficient model-level operations that are not accessible using the standard EMF API.

For example, allInstancesOf(EClass) is a utility method that computes efficiently all the instances of a given type by delegating the operation to the underlying database, that can benefits of its internal optimizations and indices.

Nested Class Summary

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

org.eclipse.emf.ecore.resource.Resource.Diagnostic, org.eclipse.emf.ecore.resource.Resource.Factory, org.eclipse.emf.ecore.resource.Resource.Internal, org.eclipse.emf.ecore.resource.Resource.IOWrappedException

Field Summary

Fields

Modifier and Type	Field and Description
static Id	ROOT_ID The identifier of the root element in a PersistentResource.
static int	ROOT_REFERENCE_ID The name of the property used by the ROOT_ID element to define its content.
static String	ROOT_REFERENCE_NAME The name of the property used by the ROOT_ID element to define its content.

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

Method Summary

Modifier and Type	Method and Description
default <T extends org.eclipse.emf.ecore.EObject> Iterable<T>	allInstancesOf(org.eclipse.emf.ecore.EClass eClass) Computes the set of instances of the given EClass (including its sub-types).
<T extends org.eclipse.emf.ecore.EObject> Iterable<T>	allInstancesOf(org.eclipse.emf.ecore.EClass eClass, boolean strict) Computes the set of instances of the given EClass.
void	close()
static boolean	isPersistent(org.eclipse.emf.ecore.resource.Resource resource) Checks that the resource is persistent.
default Iterator<PersistentEObject>	iterator() Returns an iterator on the direct content of this resource.
void	load(ImmutableConfig config) Loads the resource using the specified configuration.
void	save(ImmutableConfig config) Saves the resource using the specified configuration.

Methods inherited from interface org.eclipse.emf.ecore.resource.Resource.Internal

attached, basicSetResourceSet, detached, isLoading

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

delete, getAllContents, getContents, getEObject, getErrors, getResourceSet, getTimeStamp, getURI, getURIFragment, getWarnings, isLoaded, isModified, isTrackingModification, load, load, save, save, setModified, setTimeStamp, setTrackingModification, setURI, unload

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface fr.inria.atlanmod.neoemf.data.store.Storable

eStore

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

ROOT_ID

@Nonnull
static final Id ROOT_ID

The identifier of the root element in a PersistentResource.

ROOT_REFERENCE_ID

@Nonnegative
static final int ROOT_REFERENCE_ID

The name of the property used by the ROOT_ID element to define its content.

See Also:

Constant Field Values

ROOT_REFERENCE_NAME

@Nonnull
static final String ROOT_REFERENCE_NAME

The name of the property used by the ROOT_ID element to define its content.

See Also:

Constant Field Values

Method Detail

isPersistent

static boolean isPersistent(@Nullable
                            org.eclipse.emf.ecore.resource.Resource resource)

Checks that the resource is persistent.

Parameters:

resource - the resource to test

Returns:

true if the resource is persistent

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

save

void save(ImmutableConfig config)
   throws IOException

Saves the resource using the specified configuration.

Parameters:

config - the save configuration

Throws:

IOException - if an I/O error occurs during saving

See Also:

Resource.save(java.util.Map)

load

void load(ImmutableConfig config)
   throws IOException

Loads the resource using the specified configuration.

Parameters:

config - the load configuration

Throws:

IOException - if an I/O error occurs during loading

See Also:

Resource.load(java.util.Map)

allInstancesOf

@Nonnull
default <T extends org.eclipse.emf.ecore.EObject> Iterable<T> allInstancesOf(org.eclipse.emf.ecore.EClass eClass)

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

This method behaves like: allInstancesOf(EClass, false).

Parameters:

eClass - the EClass for which look for instances

Returns:

all the instances of the given EClass from the resource

See Also:

allInstancesOf(EClass, boolean)

allInstancesOf

@Nonnull
<T extends org.eclipse.emf.ecore.EObject> Iterable<T> allInstancesOf(org.eclipse.emf.ecore.EClass eClass,
                                                                               boolean strict)

Computes the set of instances of the given EClass.

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.

iterator

@Nonnull
default Iterator<PersistentEObject> iterator()

Returns an iterator on the direct content of this resource.

Specified by:

iterator in interface Iterable<PersistentEObject>

Returns:

an iterator

See Also:

Resource.getContents()