org.eclipse.epsilon.concordance.model

Interface IConcordanceModel

All Known Implementing Classes:

ConcordanceModel, ConcordanceModelBase

public interface IConcordanceModel

Interface is used by Concordance to specify the model and its operations Clients can implement this interface to provide a (client) specific way how a model is being implemented.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(String modelElementFragment)
Collection<org.eclipse.emf.ecore.EObject>	getAllContents(boolean resolve) Get all contents of the model.
Iterator<org.eclipse.emf.ecore.EObject>	getAllContentsIterator(boolean resolve) Get all contents of the model.
Set<CrossReference>	getAllCrossReferences()
Set<IConcordanceModel>	getAllReferencedModels()
org.eclipse.emf.ecore.resource.Resource	getEmfResource(boolean resolve) Gets the EMF resource belonging to the model.
String	getNsUri()
org.eclipse.core.resources.IResource	getResource()
org.eclipse.emf.common.util.URI	getUri()
boolean	isInstance(String nsUri)
void	reconcileCrossReferences(IConcordanceModel original, IConcordanceModel moved)

Method Detail

getResource

org.eclipse.core.resources.IResource getResource()

Returns:

the workspace resource/location of the model or null if the model is not a platform resource

getUri

org.eclipse.emf.common.util.URI getUri()

Returns:

the URI/location of the model

getNsUri

String getNsUri()

Returns:

the namespace uri of the model

contains

boolean contains(String modelElementFragment)

isInstance

boolean isInstance(String nsUri)

Returns:

true if the model namespace is the same as the given nsUri

getEmfResource

org.eclipse.emf.ecore.resource.Resource getEmfResource(boolean resolve)
                                                       throws IOException

Gets the EMF resource belonging to the model. The resource may need to get loaded each time this method is called, or obtained from memory (cache).

Parameters:

resolve - when true all model proxies are resolved

Returns:

the EMF resource belonging to the model

Throws:

IOException - when the model could not get loaded

getAllContentsIterator

Iterator<org.eclipse.emf.ecore.EObject> getAllContentsIterator(boolean resolve)
                                                               throws IOException

Get all contents of the model. Note this method might call getEmfResource(boolean)

Parameters:

resolve - when true all model proxies are resolved

Returns:

an iterator that will iterate over all model contents

Throws:

IOException - when the model could not get loaded

See Also:

getAllContents(boolean)

getAllContents

Collection<org.eclipse.emf.ecore.EObject> getAllContents(boolean resolve)
                                                         throws IOException

Get all contents of the model. Note this method might call getEmfResource(boolean)

As this method creates a new list containing all contents, it might be better to use getAllContentsIterator(boolean), if result is just used to find some element for example.

Parameters:

resolve - when true all model proxies are resolved

Returns:

a copied list of all contents belonging to the model

Throws:

IOException - when the model could not get loaded

See Also:

getAllContentsIterator(boolean)

getAllCrossReferences

Set<CrossReference> getAllCrossReferences()

getAllReferencedModels

Set<IConcordanceModel> getAllReferencedModels()

reconcileCrossReferences

void reconcileCrossReferences(IConcordanceModel original,
                            IConcordanceModel moved)