Package de.mid.innovator.m2msdk.model.transformation.interfaces

Interface ModelTransformationStepIF

All Superinterfaces:

ConfigurableItemIF, IdentifierAble, Serializable

All Known Implementing Classes:

ModelTransformationStep, ModelTransformationStepBase

public interface ModelTransformationStepIF
extends ConfigurableItemIF

Interface for model transformation step.

Version:

10.1.1

Author:

jmback

Method Summary

Modifier and Type	Method	Description
MappingElementList	calcAllTargetMatchCandidates(MappingElementIF se, TargetDetectionData target, TransformationStepSubStepData inputSubStepData)
MappingAnchor	detectPatternAnchor(MappingElementIF se, TransformationStepSubStepData inputSubStepData)	Uses the embedding pattern to detect the target elements anchor elements for creation and maintenance of the target.
void	extendModel(WorkModelInterface workModel)	Extend the source model by applying the model extension of this step.
ArrayList<ModelEmbeddingIF>	getMatchEmbedding()	Get the embeddings for the target match.
ModelGlueReaderManager	getModelGlueReaderManager()	Get Model Glue Reader Manager
ModelGlueWriterManager	getModelGlueWriterManager()	Get Model Glue Writer Manager
ArrayList<ModelEmbeddingIF>	getPatternEmbedding()	Get the embeddings for the target pattern.
ArrayList<PatternProductionIF>	getPatternProduction()	Get the pattern to create a target.
ModelTransformationStepList	getPredecessorModelTransformationStep()
ModelTransformationStepList	getPreTransformationSteps()	Returns a List of PreTranstransformationSteps.
ModelExtensionIF	getSourceExtension()	Get the source model extension of this step.
PatternList<SourceMatchClassIF>	getSourceMatchPattern()	Get the patterns that define a source match.
GroupIF	getStepGroup()	Get the lowest step group in which this item is
List<String>	getStepProposals()
ModelTransformationStepListSubStep	getSubTransformationStepList()	Returns a List of SubTranstransformationSteps.
String	getSymbolicStepName()
TransformationStepIterator	getTansformationStepIterator()
ModelExtensionIF	getTargetExtension()	Get the target model extension of this step.
PatternList<TargetMatchClassIF>	getTargetMatchPattern()	Get the patterns that define a target match.
void	preinit(SessionInterface iSession)	Initialize the model transformation step.
void	setPreviousModelTransformationStep(ModelTransformationStepIF previousStep)	Set the previous step as the default predecessor.
void	setStepGroup(GroupIF iGroup)	Set the lowest group of this item
void	transform()	Transform the source model by applying this step.
void	transformDispatch(MappingElementIF sourceElement, TargetDetectionData target, TransformationStepSubStepData subStepData)	Transform a single source model element by applying this step.
void	transformElementList(MappingElementList candidates, TransformationStepSubStepData preStepData)	Transforms the given Mapping Element List

Methods inherited from interface de.mid.innovator.m2msdk.model.transformation.interfaces.ConfigurableItemIF

checkConstraints, checkConstraints, getBaseItem, getConfigurableItems, getConfigurationTag, getItem, getKnownParameters, getName, getParentItem, getParentItem, setBaseItem, setConfigurationContext, setConfigurationTag, setParent

Methods inherited from interface de.mid.innovator.m2msdk.util.IdentifierAble

getId, setId

Method Details

transform

void transform()
        throws M2MException,
RemoteException

Transform the source model by applying this step.

Throws:

AbortException - critical error

SevereException - error to abort step, but not complete transformation

M2MException

RemoteException

RemoteException

transformElementList

void transformElementList(MappingElementList candidates,
 TransformationStepSubStepData preStepData)
                   throws M2MException,
RemoteException

Transforms the given Mapping Element List

Parameters:

candidates -

preStepData -

Throws:

AbortException

SevereException

M2MException

RemoteException

RemoteException

transformDispatch

void transformDispatch(MappingElementIF sourceElement,
 TargetDetectionData target,
 TransformationStepSubStepData subStepData)
                throws M2MException,
RemoteException

Transform a single source model element by applying this step.

Parameters:

sourceElement - model element in source model

target - existing and created targets glued with source persistently or matching source

subStepData - the description of the sub step

Throws:

M2MException

RemoteException

extendModel

void extendModel(WorkModelInterface workModel)
          throws M2MException,
RemoteException

Extend the source model by applying the model extension of this step.

Parameters:

workModel - work model to extend by this step

Throws:

AbortException - critical error

RemoteException

M2MException

RemoteException

preinit

void preinit(SessionInterface iSession)
      throws M2MException,
RemoteException

Initialize the model transformation step.

Parameters:

iSession - session

Throws:

M2MException

RemoteException

detectPatternAnchor

MappingAnchor detectPatternAnchor(MappingElementIF se,
 TransformationStepSubStepData inputSubStepData)
                           throws M2MException,
RemoteException

Uses the embedding pattern to detect the target elements anchor elements for creation and maintenance of the target.

Parameters:

se - Model element in source model

inputSubStepData - data about enclosing step

Returns:

Anchor for a mapping element.

Throws:

M2MException

RemoteException

AbortException - critical error

SevereException - error

RemoteException

getSourceExtension

ModelExtensionIF getSourceExtension()

Get the source model extension of this step.

Returns:

model extension

getTargetExtension

ModelExtensionIF getTargetExtension()

Get the target model extension of this step.

Returns:

model extension

getMatchEmbedding

ArrayList<ModelEmbeddingIF> getMatchEmbedding()

Get the embeddings for the target match.

Returns:

list of model embeddings

getPatternEmbedding

ArrayList<ModelEmbeddingIF> getPatternEmbedding()

Get the embeddings for the target pattern.

Returns:

list of model embeddings

getModelGlueWriterManager

ModelGlueWriterManager getModelGlueWriterManager()

Get Model Glue Writer Manager

Returns:

ModelGlueWriterManager

getModelGlueReaderManager

ModelGlueReaderManager getModelGlueReaderManager()

Get Model Glue Reader Manager

Returns:

ModelGlueReaderManager

getPatternProduction

ArrayList<PatternProductionIF> getPatternProduction()

Get the pattern to create a target.

Returns:

patterns to create a target

getSourceMatchPattern

PatternList<SourceMatchClassIF> getSourceMatchPattern()

Get the patterns that define a source match.

Returns:

list of patterns

getTargetMatchPattern

PatternList<TargetMatchClassIF> getTargetMatchPattern()

Get the patterns that define a target match.

Returns:

list of patterns

setPreviousModelTransformationStep

void setPreviousModelTransformationStep(ModelTransformationStepIF previousStep)

Set the previous step as the default predecessor.

Parameters:

previousStep - Previous step in the order of the owning model transformation

getSubTransformationStepList

ModelTransformationStepListSubStep getSubTransformationStepList()

Returns a List of SubTranstransformationSteps.

Returns:

return a list of steps which are subordinated to this step

getPreTransformationSteps

ModelTransformationStepList getPreTransformationSteps()

Returns a List of PreTranstransformationSteps.

Returns:

return a list of steps which are executed before an element of the current element is processed.

getSymbolicStepName

String getSymbolicStepName()

Returns:

returns the transformation step's symbolic name

getPredecessorModelTransformationStep

ModelTransformationStepList getPredecessorModelTransformationStep()
                                                           throws AbortException,
RemoteException

Throws:

AbortException

RemoteException

getStepProposals

List<String> getStepProposals()

calcAllTargetMatchCandidates

MappingElementList calcAllTargetMatchCandidates(MappingElementIF se,
 TargetDetectionData target,
 TransformationStepSubStepData inputSubStepData)
                                         throws M2MException,
RemoteException

Throws:

M2MException

RemoteException

getTansformationStepIterator

TransformationStepIterator getTansformationStepIterator()

getStepGroup

GroupIF getStepGroup()

Get the lowest step group in which this item is

Returns:

null if it is in no step group.

setStepGroup

void setStepGroup(GroupIF iGroup)

Set the lowest group of this item

Parameters:

iGroup - step group