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

Class WorkModel

java.lang.Object

de.mid.innovator.m2msdk.model.workspace.WorkModel

All Implemented Interfaces:

WorkModelInterface, Serializable, Remote

public class WorkModel
extends Object
implements WorkModelInterface

Work model of source model. The work model contains the source model for the model transformation. It is separated in initial, active and passive elements. If an element is in active selection, it will be removed from passive selection.

Version:

10.1.1

Author:

jmback

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
WorkModel(SessionInterface iSession, MappingModelRole iRole)
WorkModel(WorkModel original)

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 iDoc)	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 el)	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	setElements(WorkModelInterface modelNew)
void	setMetaModel(String iMetaModel)	Set meta model of work model.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

WorkModel

public WorkModel(SessionInterface iSession,
 MappingModelRole iRole)

WorkModel

public WorkModel(WorkModel original)

Method Details

initialize

public void initialize(MappingModel model)
                throws RemoteException,
M2MException

Specified by:

initialize in interface WorkModelInterface

Throws:

RemoteException

M2MException

initialize

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

Description copied from interface: WorkModelInterface

Initialize the work model based on a given Document.

Specified by:

initialize in interface WorkModelInterface

Parameters:

iDoc - containing the mapping elements

Throws:

RemoteException

M2MException

initialize

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

Description copied from interface: WorkModelInterface

Initialize the work model based on a given Document.

Specified by:

initialize in interface WorkModelInterface

Parameters:

iDoc - containing the mapping elements

store - store to read to

nameElement - name of the element to read

Throws:

RemoteException

M2MException

addElements

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

Description copied from interface: WorkModelInterface

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

Specified by:

addElements in interface WorkModelInterface

Parameters:

iStore - specified store

iList - list of model elements

Throws:

M2MException

getElements

public MappingElementList getElements(ExtensionStore iStore)

Description copied from interface: WorkModelInterface

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

Specified by:

getElements in interface WorkModelInterface

Parameters:

iStore - store within the work model.

Returns:

list of model elements

setElements

public void setElements(ExtensionStore iStore,
 MappingElementList elements)

Specified by:

setElements in interface WorkModelInterface

getDocument

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

Description copied from interface: WorkModelInterface

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

Specified by:

getDocument in interface WorkModelInterface

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:

RemoteException - error in communication with remote server

getElementsAsUri

public String getElementsAsUri(ExtensionStore iStore)

Description copied from interface: WorkModelInterface

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

Specified by:

getElementsAsUri in interface WorkModelInterface

Parameters:

iStore - store within the work model.

Returns:

comma separated list of URIs of all model elements

getMappingModel

public MappingModel getMappingModel()
                             throws M2MException,
RemoteException

Description copied from interface: WorkModelInterface

Get mapping model of this work model.

Specified by:

getMappingModel in interface WorkModelInterface

Returns:

mapping model containing the elements of this work model

Throws:

M2MException

RemoteException

RemoteException - error in communication with remote server

getMetaModel

public MetaModel getMetaModel()

Description copied from interface: WorkModelInterface

Get meta model of work model.

Specified by:

getMetaModel in interface WorkModelInterface

Returns:

meta model

setMetaModel

public void setMetaModel(String iMetaModel)
                  throws RemoteException,
M2MException

Description copied from interface: WorkModelInterface

Set meta model of work model.

Specified by:

setMetaModel in interface WorkModelInterface

Parameters:

iMetaModel - name of meta model

Throws:

RemoteException - error in communication with remote server

M2MException

isPassiveSelectedElement

public boolean isPassiveSelectedElement(MappingElementIF el)

Description copied from interface: WorkModelInterface

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

Specified by:

isPassiveSelectedElement in interface WorkModelInterface

Parameters:

el -

Returns:

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

clearElements

public void clearElements(ExtensionStore iStore)
                   throws M2MException

Description copied from interface: WorkModelInterface

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

Specified by:

clearElements in interface WorkModelInterface

Parameters:

iStore - specified store

Throws:

M2MException

getRole

public MappingModelRole getRole()

Description copied from interface: WorkModelInterface

Get the role of the work model.

Specified by:

getRole in interface WorkModelInterface

Returns:

source or target

toString

public String toString()

Overrides:

toString in class Object

getExtensionStore

public ExtensionStoreElements getExtensionStore()

Specified by:

getExtensionStore in interface WorkModelInterface

getUnique

public MappingElementIF getUnique(MappingElementIF iElement)
                           throws RemoteException,
M2MException

Description copied from interface: WorkModelInterface

Get the unique mapping element by checking its hash code.

Specified by:

getUnique in interface WorkModelInterface

Parameters:

iElement - mapping element to check

Returns:

same mapping element or one with same hash

Throws:

RemoteException

M2MException

setElements

public void setElements(WorkModelInterface modelNew)

removeElements

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

Description copied from interface: WorkModelInterface

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

Specified by:

removeElements in interface WorkModelInterface

Parameters:

iStore - specified store

iList - list of model elements

Throws:

M2MException

RemoteException - error in communication with remote server