ResourceSetModel

```
public interface ResourceSetModel
```
A ResourceSetModel holds EObject instances contained in a ResourceSet.
It is worth nothing instances part of the underlying ResourceSet are computed only once, to guarantee decent performances. The drawback is the instances indexing will not be updated if the ResourceSet content is modified. This interface is thus designed to be used in read-only use cases.

This interface is not intended to be implemented by clients.

Since:

3.4.0

See Also:

Metamodel.readResourceSet(String, String, Map), Metamodel.createResourceSet(ResourceSet)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`<T extends EObject> MDWList<T>`	`getInstances()` Returns all model elements attached to this model.
`<T extends EObject> MDWList<T>`	`getInstances(EClass type)` Returns all model elements of the specified type attached to this model.
`<T extends EObject> MDWList<T>`	`getInstances(EClass type, boolean includeSubTypes)` Returns all model elements of the specified type, or one of its sub types, attached to this model.
`<T extends EObject> MDWList<T>`	`getInstances(String typeName)` Returns all model elements of the specified type attached to this model.
`<T extends EObject> MDWList<T>`	`getInstances(String typeName, boolean includeSubTypes)` Returns all model elements of the specified type, or one of its sub types, attached to this model.
`Metamodel`	`getMetamodel()` Returns the metamodel this model is based on.
`<T extends EObject> MDWList<T>`	`getProfiledInstances(EClass type, String profileName)` Returns model elements of the specified type attached to this model, which match the specified profile name.
`<T extends EObject> MDWList<T>`	`getProfiledInstances(EClass type, String profileName, boolean includeSubTypes)` Returns all model elements of the specified type, or one of its sub types, attached to this model, which match the specified profile name.
`<T extends EObject> MDWList<T>`	`getProfiledInstances(String typeName, String profileName)` Returns model elements of the specified type attached to this model, which match the specified profile name.
`<T extends EObject> MDWList<T>`	`getProfiledInstances(String typeName, String profileName, boolean includeSubTypes)` Returns all model elements of the specified type, or one of its sub types, attached to this model, which match the specified profile name.
`ConnectorDescriptor`	`getReader()` Returns the last connector used to read this model.
`String`	`getReadURI()` Returns the last uri used to read this model.
`ResourceSet`	`getResourceSet()` Returns the underlying resource set.
`void`	`read(String readerName, String uri, Map<String,?> options)` Reload the model using the specified connector information.

- Method Detail
  - getMetamodel
```
Metamodel getMetamodel()
```
    Returns the metamodel this model is based on.
    
    Returns:
    
    the metamodel.
  - getResourceSet
```
ResourceSet getResourceSet()
```
    Returns the underlying resource set.
    
    Returns:
    
    the resource set.
  - read
```
void read(String readerName,
          String uri,
          Map<String,?> options)
   throws CoreException
```
    Reload the model using the specified connector information.
    The reader name must match a connector registered on the related metamodel. The uri is used to locate a resource from where the connector should read information. If the connector expects a file, the uri must be a valid file path. Otherwise, it can be any connector specific resource locator, including null when the connector does not expect any uri.
    Parameters:
    
    readerName - the connector name to be used.
    
    uri - an additional resource locator used by the connector to read the model (can be null)
    
    options - properties to configure the model reader (can be null).
    
    Throws:
    CoreException - if the model could not be loaded. Reasons include:
    
    The reader name does not match any registered connector.
    
    The uri is not valid.
    
    The connector failed to read the resource located by the uri.
    See Also:
    
    Metamodel.getResourceSetReaderDescriptors(), ConnectorDescriptor.getKind()
  - getReader
```
ConnectorDescriptor getReader()
```
    Returns the last connector used to read this model.
    
    Returns:
    
    the last connector used to read this model.
  - getReadURI
```
String getReadURI()
```
    Returns the last uri used to read this model.
    
    Returns:
    
    the last connector used to read this model, null if the uri used was null.
  - getInstances
```
<T extends EObject> MDWList<T> getInstances()
```
    Returns all model elements attached to this model.
    The returned list is a MDWList so you can directly invoke scripts on the model elements. This list has no predictable order.
    
    Type Parameters:
    
    T - the type of the instance to retrieve.
    
    Returns:
    
    an unmodifiable list of EObject contained in this model.
  - getInstances
```
<T extends EObject> MDWList<T> getInstances(String typeName)
```
    Returns all model elements of the specified type attached to this model. This method does not consider sub types of the specified type.
    The specified type name can be a fully qualified class ("com.sodius.mdw.metamodel.uml21.Class" for example), or a simple name ( "Class"), if this name is unique in the metamodel.
    
    The returned list is a MDWList so you can directly invoke scripts on the model elements. These elements are ordered the way they were created and added to this model.
    
    Type Parameters:
    
    T - the type of the instance to retrieve.
    
    Parameters:
    
    typeName - the type name of model elements to retrieve.
    
    Returns:
    
    an unmodifiable list of EObject contained in this model that matches the specified type.
    
    See Also:
    
    getInstances(String, boolean)
  - getInstances
```
<T extends EObject> MDWList<T> getInstances(String typeName,
                                            boolean includeSubTypes)
```
    Returns all model elements of the specified type, or one of its sub types, attached to this model.
    The specified type name can be a fully qualified class ("com.sodius.mdw.metamodel.uml21.Classifier" for example), or a simple name ("Classifier"), if this name is unique in the metamodel.
    
    The returned list is a MDWList so you can directly invoke scripts on the model elements. This list has no predictable order.
    
    Type Parameters:
    
    T - the type of the instance to retrieve.
    
    Parameters:
    
    typeName - the type name of model elements to retrieve.
    
    includeSubTypes - determines whether to retrieve elements based on sub types.
    
    Returns:
    
    an unmodifiable list of EObject contained in this model that matches the specified type, or one of its sub types.
    
    See Also:
    
    getInstances(String)
  - getInstances
```
<T extends EObject> MDWList<T> getInstances(EClass type)
```
    Returns all model elements of the specified type attached to this model. This method does not consider sub types of the specified type.
    The returned list is a MDWList so you can directly invoke scripts on the model elements. These elements are ordered the way they were created and added to this model.
    
    Type Parameters:
    
    T - the type of the instance to retrieve.
    
    Parameters:
    
    type - the type of model elements to retrieve.
    
    Returns:
    
    an unmodifiable list of EObject contained in this model that matches the specified type.
    
    See Also:
    
    getInstances(EClass, boolean)
  - getInstances
```
<T extends EObject> MDWList<T> getInstances(EClass type,
                                            boolean includeSubTypes)
```
    Returns all model elements of the specified type, or one of its sub types, attached to this model.
    The returned list is a MDWList so you can directly invoke scripts on the model elements. This list has no predictable order.
    
    Type Parameters:
    
    T - the type of the instance to retrieve.
    
    Parameters:
    
    type - the type of model elements to retrieve.
    
    includeSubTypes - determines to retrieve elements based on sub types.
    
    Returns:
    
    an unmodifiable list of EObject contained in this model that matches the specified type, or one of its sub types.
    
    See Also:
    
    getInstances(String)
  - getProfiledInstances
```
<T extends EObject> MDWList<T> getProfiledInstances(String typeName,
                                                    String profileName)
```
    Returns model elements of the specified type attached to this model, which match the specified profile name. This method does not consider sub types of the specified type.
    The specified type name can be a fully qualified class ("com.sodius.mdw.metamodel.uml21.Class" for example), or a simple name ( "Class"), if this name is unique in the metamodel.
    
    The returned list is a MDWList so you can directly invoke scripts on the model elements. These elements are ordered the way they were created and added to this model.
    
    Type Parameters:
    
    T - the type of the instance to retrieve.
    
    Parameters:
    
    typeName - the type name of model elements to retrieve.
    
    profileName - the name of the profile type the instances must match.
    
    Returns:
    
    an unmodifiable list of EObject contained in this model that matches the specified type.
    
    Throws:
    
    InvalidCallException - if this API is not called during an MDWorkbench evaluation.
    
    See Also:
    
    getProfiledInstances(String, String, boolean)
  - getProfiledInstances
```
<T extends EObject> MDWList<T> getProfiledInstances(String typeName,
                                                    String profileName,
                                                    boolean includeSubTypes)
```
    Returns all model elements of the specified type, or one of its sub types, attached to this model, which match the specified profile name.
    The specified type name can be a fully qualified class ("com.sodius.mdw.metamodel.uml21.Classifier" for example), or a simple name ("Classifier"), if this name is unique in the metamodel.
    
    The returned list is a MDWList so you can directly invoke scripts on the model elements. This list has no predictable order.
    
    Type Parameters:
    
    T - the type of the instance to retrieve.
    
    Parameters:
    
    typeName - the type name of model elements to retrieve.
    
    profileName - the name of the profile type the instances must match.
    
    includeSubTypes - determines to retrieve elements based on sub types.
    
    Returns:
    
    an unmodifiable list of EObject contained in this model that matches the specified type, or one of its sub types.
    
    Throws:
    
    InvalidCallException - if this API is not called during an MDWorkbench evaluation.
    
    See Also:
    
    getProfiledInstances(String, String)
  - getProfiledInstances
```
<T extends EObject> MDWList<T> getProfiledInstances(EClass type,
                                                    String profileName)
```
    Returns model elements of the specified type attached to this model, which match the specified profile name. This method does not consider sub types of the specified type.
    The returned list is a MDWList so you can directly invoke scripts on the model elements. These elements are ordered the way they were created and added to this model.
    
    Type Parameters:
    
    T - the type of the instance to retrieve.
    
    Parameters:
    
    type - the type of model elements to retrieve.
    
    profileName - the name of the profile type the instances must match.
    
    Returns:
    
    an unmodifiable list of EObject contained in this model that matches the specified type.
    
    Throws:
    
    InvalidCallException - if this API is not called during an MDWorkbench evaluation.
    
    See Also:
    
    getProfiledInstances(EClass, String, boolean)
  - getProfiledInstances
```
<T extends EObject> MDWList<T> getProfiledInstances(EClass type,
                                                    String profileName,
                                                    boolean includeSubTypes)
```
    Returns all model elements of the specified type, or one of its sub types, attached to this model, which match the specified profile name.
    The returned list is a MDWList so you can directly invoke scripts on the model elements. This list has no predictable order.
    
    Type Parameters:
    
    T - the type of the instance to retrieve.
    
    Parameters:
    
    type - the type of model elements to retrieve.
    
    profileName - the name of the profile type the instances must match.
    
    includeSubTypes - determines to retrieve elements based on sub types.
    
    Returns:
    
    an unmodifiable list of EObject contained in this model that matches the specified type, or one of its sub types.
    
    Throws:
    
    InvalidCallException - if this API is not called during an MDWorkbench evaluation.
    
    See Also:
    
    getProfiledInstances(EClass, String)

Interface ResourceSetModel

Method Summary

Method Detail

getMetamodel

getResourceSet

read

getReader

getReadURI

getInstances

getInstances

getInstances

getInstances

getInstances

getProfiledInstances

getProfiledInstances

getProfiledInstances

getProfiledInstances