Package de.mid.innovator.m2msdk.model.workspace

Interface WorkModelInterface

All Superinterfaces:

Remote, Serializable

All Known Implementing Classes:

WorkModel

public interface WorkModelInterface
extends Serializable, Remote

Interface for work models. A work model is a part of the source or the target model. It is separated in stores.

Version:

11.2.1

Author:

jmback

Method Summary

Modifier and Type	Method	Description
void	addElements(ExtensionStore iStore, MappingElementList iList)	Add uniquely the elements to this work model in the given store.
void	clearElements(ExtensionStore iStore)	Clear the elements in this work model in the given store.
org.jdom2.Document	getDocument(ExtensionStore iStore, int iChunk)	Get all model elements that are in this work model and in the specified store.
MappingElementList	getElements(ExtensionStore iStore)	Get all model elements that are in this work model and in the specified store.
String	getElementsAsUri(ExtensionStore iStore)	Get all model elements that are in this work model and in the specified store.
ExtensionStoreElements	getExtensionStore()
MappingModel	getMappingModel()	Get mapping model of this work model.
MetaModel	getMetaModel()	Get meta model of work model.
MappingModelRole	getRole()	Get the role of the work model.
MappingElementIF	getUnique(MappingElementIF iElement)	Get the unique mapping element by checking its hash code.
void	initialize(MappingModel model)
void	initialize(org.jdom2.Document document)	Initialize the work model based on a given Document.
void	initialize(org.jdom2.Document iDoc, ExtensionStore store, String nameElement)	Initialize the work model based on a given Document.
boolean	isPassiveSelectedElement(MappingElementIF iElement)	Is the element in the passive selection of this work model.
void	removeElements(ExtensionStore iStore, MappingElementList iList)	Remove the elements from this work model in the given store.
void	setElements(ExtensionStore iStore, MappingElementList elements)
void	setMetaModel(String iMetaModel)	Set meta model of work model.

Method Details

initialize

void initialize(org.jdom2.Document document)
         throws M2MException,
RemoteException

Initialize the work model based on a given Document.

Parameters:

document - containing the mapping elements

Throws:

AbortException

M2MException

RemoteException

initialize

void initialize(org.jdom2.Document iDoc,
 ExtensionStore store,
 String nameElement)
         throws M2MException,
RemoteException

Initialize the work model based on a given Document.

Parameters:

iDoc - containing the mapping elements

store - store to read to

nameElement - name of the element to read

Throws:

M2MException

RemoteException

getDocument

org.jdom2.Document getDocument(ExtensionStore iStore,
 int iChunk)
                        throws M2MException,
RemoteException

Get all model elements that are in this work model and in the specified store.

Parameters:

iStore - store within the work model. If no store is specified, all elements are returned.

iChunk - chunk number to get a specific chunk. Use zero (0) to get all model elements in chunks and minus one (-1) to get all model elements not chunked.

Returns:

XML with URI of all model elements. If the number of model elements is to large, you will get chunks instead.

Throws:

M2MException

RemoteException - error in communication with remote server

getElements

MappingElementList getElements(ExtensionStore iStore)
                        throws M2MException,
RemoteException

Get all model elements that are in this work model and in the specified store.

Parameters:

iStore - store within the work model.

Returns:

list of model elements

Throws:

M2MException

RemoteException - error in communication with remote server

getElementsAsUri

String getElementsAsUri(ExtensionStore iStore)
                 throws M2MException,
RemoteException

Get all model elements that are in this work model and in the specified store.

Parameters:

iStore - store within the work model.

Returns:

comma separated list of URIs of all model elements

Throws:

M2MException

RemoteException - error in communication with remote server

addElements

void addElements(ExtensionStore iStore,
 MappingElementList iList)
          throws M2MException,
RemoteException

Add uniquely the elements to this work model in the given store.

Parameters:

iStore - specified store

iList - list of model elements

Throws:

M2MException

RemoteException - error in communication with remote server

removeElements

void removeElements(ExtensionStore iStore,
 MappingElementList iList)
             throws M2MException,
RemoteException

Remove the elements from this work model in the given store.

Parameters:

iStore - specified store

iList - list of model elements

Throws:

M2MException

RemoteException - error in communication with remote server

clearElements

void clearElements(ExtensionStore iStore)
            throws M2MException,
RemoteException

Clear the elements in this work model in the given store.

Parameters:

iStore - specified store

Throws:

M2MException

RemoteException

getMetaModel

MetaModel getMetaModel()
                throws RemoteException

Get meta model of work model.

Returns:

meta model

Throws:

RemoteException - error in communication with remote server

setMetaModel

void setMetaModel(String iMetaModel)
           throws RemoteException,
M2MException

Set meta model of work model.

Parameters:

iMetaModel - name of meta model

Throws:

RemoteException - error in communication with remote server

M2MException

getMappingModel

MappingModel getMappingModel()
                      throws M2MException,
RemoteException

Get mapping model of this work model.

Returns:

mapping model containing the elements of this work model

Throws:

AbortException - critical error

M2MException

RemoteException

RemoteException - error in communication with remote server

isPassiveSelectedElement

boolean isPassiveSelectedElement(MappingElementIF iElement)
                          throws RemoteException

Is the element in the passive selection of this work model.

Parameters:

iElement -

Returns:

true, if the element is in passive, but not in active selection.

Throws:

RemoteException

getRole

MappingModelRole getRole()
                  throws RemoteException

Get the role of the work model.

Returns:

source or target

Throws:

RemoteException

setElements

void setElements(ExtensionStore iStore,
 MappingElementList elements)

getExtensionStore

ExtensionStoreElements getExtensionStore()

initialize

void initialize(MappingModel model)
         throws RemoteException,
M2MException

Throws:

RemoteException

M2MException

getUnique

MappingElementIF getUnique(MappingElementIF iElement)
                    throws RemoteException,
M2MException

Get the unique mapping element by checking its hash code.

Parameters:

iElement - mapping element to check

Returns:

same mapping element or one with same hash

Throws:

RemoteException

M2MException