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

Class ModelTransformationStepBase

java.lang.Object

de.mid.innovator.m2msdk.model.transformation.ConfigurableItem

de.mid.innovator.m2msdk.model.transformation.ModelTransformationStepBase

All Implemented Interfaces:

ConfigurableItemIF, ModelTransformationStepIF, IdentifierAble, Serializable

Direct Known Subclasses:

ModelTransformationStep

public abstract class ModelTransformationStepBase
extends ConfigurableItem
implements ModelTransformationStepIF

The base of model transformation steps.

Version:

10.1.1

Author:

jmback

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ModelTransformationStepBase.FlowCondition

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAMETERNAME_STEP_NAME_SYMBOLIC
static final String	PARAMETERNAME_STEP_TAG_PROPOSALS

Constructor Summary

Constructors

Constructor	Description
ModelTransformationStepBase()

Method Summary

Modifier and Type	Method	Description
MappingElementList	calcAllTargetMatchCandidates(MappingElementIF se, TargetDetectionData target, TransformationStepSubStepData inputSubStepData)	Get existing possible target elements for checking source and target according to the tasks in this step.
boolean	checkConstraints(MappingElementIF element, ExpressionContext context)	Check if all constraints evaluate to true.
MappingAnchor	detectPatternAnchor(MappingElementIF se, TransformationStepSubStepData inputSubStepData)	Uses the embedding pattern to detect the target elements anchor elements for creation of target.
void	extendModel(WorkModelInterface workModel)	Extend the source model by applying the model extension of this step.
ConfigurationTag	getConfigurationTag()	Get the type of the configurable item.
boolean	getIsValidatingSubStep()
ParameterTemplates	getKnownParameters(MappingElementIF me, ConfigurationItemIF iItem)	Get the list of all acceptable parameter names.
ArrayList<ModelEmbeddingIF>	getMatchEmbedding()	Get the embeddings for the target match.
ModelGlueReaderManager	getModelGlueReaderManager()	Get Model Glue Reader Manager
ModelGlueWriterManager	getModelGlueWriterManager()	Get Model Glue Writer Manager
String	getName()	Get the name.
ArrayList<ModelEmbeddingIF>	getPatternEmbedding()	Get the embeddings for the target pattern.
ArrayList<PatternProductionIF>	getPatternProduction()	Get the pattern to create a target.
MappingElementList	getPatternSourceModelCandidateElements()	Retrieves from the source model the elements suitable for the current pattern.
ModelTransformationStepList	getPredecessorModelTransformationStep()
List<String>	getPreStepIdentificationName()
ModelTransformationStepListPreStep	getPreTransformationSteps()	Returns a List of PreTranstransformationSteps.
static ModelTransformationStepList	getRelevantTransformationStep(ConfigurableItemIF runtimeItem, MappingElementIF sourceElement, String sStepIdentifier, String tagProposal)
ModelExtensionIF	getSourceExtension()	Get the source model extension of this step.
PatternList<SourceMatchClassIF>	getSourceMatchPattern()	Get the patterns that define a source match.
String	getStepFullName()
GroupIF	getStepGroup()	Get the lowest step group in which this item is
List<String>	getStepProposals()
String	getSubStepIdentificationName()
ModelTransformationStepListSubStep	getSubTransformationStepList()	Returns a List of SubTranstransformationSteps.
String	getSymbolicStepName()
TransformationStepIterator	getTansformationStepIterator()
ModelExtensionIF	getTargetExtension()	Get the target model extension of this step.
MappingElementList	getTargetMatchCandidates(MappingElementIF se, TransformationStepSubStepData preStepData)	Try to find the target via glue or via properties from source elements .
PatternList<TargetMatchClassIF>	getTargetMatchPattern()	Get the patterns that define a target match.
boolean	isName(String name)
boolean	isPreStep()
boolean	isSubStep()
boolean	isSubTransformationStep()
void	preinit(SessionInterface iSession)	Initialize the model transformation step.
void	setConfigurationContext(SessionInterface iSession, MetaModel sourceMM, MetaModel targetMM, ConfigurationItemIF context)	Set the configuration context of this configurable item.
void	setPreviousModelTransformationStep(ModelTransformationStepIF lastStep)	Set the previous step as the default predecessor.
void	setStepGroup(GroupIF iGroup)	Set the lowest group of this item
String	toString()
void	transform()	Transform the source model by applying this step.
void	transformDispatch(MappingElementIF se, TargetDetectionData target, TransformationStepSubStepData inputSubStepData)	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 class de.mid.innovator.m2msdk.model.transformation.ConfigurableItem

checkConstraints, getBaseItem, getConfigurableItems, getId, getItem, getParentItem, getParentItem, setBaseItem, setConfigurationTag, setId, setParent

Methods inherited from class java.lang.Object

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

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

checkConstraints, getBaseItem, getConfigurableItems, getItem, getParentItem, getParentItem, setBaseItem, setConfigurationTag, setParent

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

getId, setId

Field Details

PARAMETERNAME_STEP_NAME_SYMBOLIC

public static final String PARAMETERNAME_STEP_NAME_SYMBOLIC

See Also:

• Constant Field Values

PARAMETERNAME_STEP_TAG_PROPOSALS

public static final String PARAMETERNAME_STEP_TAG_PROPOSALS

See Also:

• Constant Field Values

Constructor Details

ModelTransformationStepBase

public ModelTransformationStepBase()

Method Details

getStepGroup

public GroupIF getStepGroup()

Description copied from interface: ModelTransformationStepIF

Get the lowest step group in which this item is

Specified by:

getStepGroup in interface ModelTransformationStepIF

Returns:

null if it is in no step group.

setStepGroup

public void setStepGroup(GroupIF iGroup)

Description copied from interface: ModelTransformationStepIF

Set the lowest group of this item

Specified by:

setStepGroup in interface ModelTransformationStepIF

Parameters:

iGroup - step group

getModelGlueWriterManager

public ModelGlueWriterManager getModelGlueWriterManager()

Description copied from interface: ModelTransformationStepIF

Get Model Glue Writer Manager

Specified by:

getModelGlueWriterManager in interface ModelTransformationStepIF

Returns:

ModelGlueWriterManager

getModelGlueReaderManager

public ModelGlueReaderManager getModelGlueReaderManager()

Description copied from interface: ModelTransformationStepIF

Get Model Glue Reader Manager

Specified by:

getModelGlueReaderManager in interface ModelTransformationStepIF

Returns:

ModelGlueReaderManager

getSubTransformationStepList

public ModelTransformationStepListSubStep getSubTransformationStepList()

Description copied from interface: ModelTransformationStepIF

Returns a List of SubTranstransformationSteps.

Specified by:

getSubTransformationStepList in interface ModelTransformationStepIF

Returns:

return a list of steps which are subordinated to this step

checkConstraints

public boolean checkConstraints(MappingElementIF element,
 ExpressionContext context)
                         throws RemoteException,
M2MException

Description copied from interface: ConfigurableItemIF

Check if all constraints evaluate to true.

Specified by:

checkConstraints in interface ConfigurableItemIF

Overrides:

checkConstraints in class ConfigurableItem

Parameters:

context - context of evaluation with source and target

Returns:

true, if there are no constraints or all constraints evaluate to true

Throws:

RemoteException - exception from remote execution

M2MException - generic exception

getName

public String getName()

Description copied from interface: ConfigurableItemIF

Get the name.

Specified by:

getName in interface ConfigurableItemIF

Overrides:

getName in class ConfigurableItem

Returns:

name as given by user in model transformation configuration

transform

public void transform()
               throws M2MException,
RemoteException

Description copied from interface: ModelTransformationStepIF

Transform the source model by applying this step.

Specified by:

transform in interface ModelTransformationStepIF

Throws:

M2MException

RemoteException

RemoteException

transformElementList

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

Description copied from interface: ModelTransformationStepIF

Transforms the given Mapping Element List

Specified by:

transformElementList in interface ModelTransformationStepIF

Parameters:

candidates -

preStepData -

Throws:

M2MException

RemoteException

RemoteException

transformDispatch

public void transformDispatch(MappingElementIF se,
 TargetDetectionData target,
 TransformationStepSubStepData inputSubStepData)
                       throws M2MException,
RemoteException

Description copied from interface: ModelTransformationStepIF

Transform a single source model element by applying this step.

Specified by:

transformDispatch in interface ModelTransformationStepIF

Parameters:

se - model element in source model

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

inputSubStepData - the description of the sub step

Throws:

M2MException

RemoteException

preinit

public void preinit(SessionInterface iSession)
             throws M2MException,
RemoteException

Description copied from interface: ModelTransformationStepIF

Initialize the model transformation step.

Specified by:

preinit in interface ModelTransformationStepIF

Parameters:

iSession - session

Throws:

M2MException

RemoteException

getSourceExtension

public ModelExtensionIF getSourceExtension()

Description copied from interface: ModelTransformationStepIF

Get the source model extension of this step.

Specified by:

getSourceExtension in interface ModelTransformationStepIF

Returns:

model extension

getTargetExtension

public ModelExtensionIF getTargetExtension()

Description copied from interface: ModelTransformationStepIF

Get the target model extension of this step.

Specified by:

getTargetExtension in interface ModelTransformationStepIF

Returns:

model extension

getPatternProduction

public ArrayList<PatternProductionIF> getPatternProduction()

Description copied from interface: ModelTransformationStepIF

Get the pattern to create a target.

Specified by:

getPatternProduction in interface ModelTransformationStepIF

Returns:

patterns to create a target

getSourceMatchPattern

public PatternList<SourceMatchClassIF> getSourceMatchPattern()

Description copied from interface: ModelTransformationStepIF

Get the patterns that define a source match.

Specified by:

getSourceMatchPattern in interface ModelTransformationStepIF

Returns:

list of patterns

getTargetMatchPattern

public PatternList<TargetMatchClassIF> getTargetMatchPattern()

Description copied from interface: ModelTransformationStepIF

Get the patterns that define a target match.

Specified by:

getTargetMatchPattern in interface ModelTransformationStepIF

Returns:

list of patterns

getPatternEmbedding

public ArrayList<ModelEmbeddingIF> getPatternEmbedding()

Description copied from interface: ModelTransformationStepIF

Get the embeddings for the target pattern.

Specified by:

getPatternEmbedding in interface ModelTransformationStepIF

Returns:

list of model embeddings

getMatchEmbedding

public ArrayList<ModelEmbeddingIF> getMatchEmbedding()

Description copied from interface: ModelTransformationStepIF

Get the embeddings for the target match.

Specified by:

getMatchEmbedding in interface ModelTransformationStepIF

Returns:

list of model embeddings

extendModel

public void extendModel(WorkModelInterface workModel)
                 throws M2MException,
RemoteException

Description copied from interface: ModelTransformationStepIF

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

Specified by:

extendModel in interface ModelTransformationStepIF

Parameters:

workModel - work model to extend by this step

Throws:

M2MException

RemoteException

RemoteException

getKnownParameters

public ParameterTemplates getKnownParameters(MappingElementIF me,
 ConfigurationItemIF iItem)
                                      throws M2MException,
RemoteException

Description copied from interface: ConfigurableItemIF

Get the list of all acceptable parameter names.

Specified by:

getKnownParameters in interface ConfigurableItemIF

Overrides:

getKnownParameters in class ConfigurableItem

Parameters:

me - mapping element, maybe null

iItem - configuration item, maybe null

Returns:

list of parameter names

Throws:

M2MException - generic exception

RemoteException - error in communication

RemoteException - exception from remote execution

setConfigurationContext

public void setConfigurationContext(SessionInterface iSession,
 MetaModel sourceMM,
 MetaModel targetMM,
 ConfigurationItemIF context)
                             throws M2MException,
RemoteException

Description copied from interface: ConfigurableItemIF

Set the configuration context of this configurable item. The configurable item is configured according the context.

Specified by:

setConfigurationContext in interface ConfigurableItemIF

Overrides:

setConfigurationContext in class ConfigurableItem

Parameters:

iSession - session

sourceMM - source meta model

targetMM - target meta model

context - Configuration item

Throws:

M2MException - generic exception

RemoteException - exception from remote execution

setPreviousModelTransformationStep

public void setPreviousModelTransformationStep(ModelTransformationStepIF lastStep)

Description copied from interface: ModelTransformationStepIF

Set the previous step as the default predecessor.

Specified by:

setPreviousModelTransformationStep in interface ModelTransformationStepIF

Parameters:

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

toString

public String toString()

Overrides:

toString in class ConfigurableItem

getPatternSourceModelCandidateElements

public MappingElementList getPatternSourceModelCandidateElements()
                                                          throws M2MException,
RemoteException

Retrieves from the source model the elements suitable for the current pattern.

Returns:

source elements fitting the pattern

Throws:

RemoteException

AbortException

SevereException

RemoteException

M2MException

getPreTransformationSteps

public ModelTransformationStepListPreStep getPreTransformationSteps()

Description copied from interface: ModelTransformationStepIF

Returns a List of PreTranstransformationSteps.

Specified by:

getPreTransformationSteps in interface ModelTransformationStepIF

Returns:

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

calcAllTargetMatchCandidates

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

Get existing possible target elements for checking source and target according to the tasks in this step.

Specified by:

calcAllTargetMatchCandidates in interface ModelTransformationStepIF

Parameters:

se - source element

inputSubStepData -

Returns:

list of all elements that comply the target match

Throws:

AbortException

SevereException

RemoteException

M2MException

RemoteException

getTargetMatchCandidates

public MappingElementList getTargetMatchCandidates(MappingElementIF se,
 TransformationStepSubStepData preStepData)
                                            throws M2MException,
RemoteException

Try to find the target via glue or via properties from source elements .

Parameters:

se - list of source elements

Returns:

If found, list of target elements glued persistently or virtually with source

Throws:

RemoteException

SevereException

RemoteException

M2MException

detectPatternAnchor

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

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

Specified by:

detectPatternAnchor in interface ModelTransformationStepIF

Parameters:

se - Model element in source model

inputSubStepData - data about enclosing step

Returns:

Anchor for a mapping element.

Throws:

RemoteException

AbortException - critical error

SevereException - error

RemoteException

M2MException

getConfigurationTag

public ConfigurationTag getConfigurationTag()

Description copied from interface: ConfigurableItemIF

Get the type of the configurable item. The type defines the role that the item plays in the execution.

Specified by:

getConfigurationTag in interface ConfigurableItemIF

Overrides:

getConfigurationTag in class ConfigurableItem

Returns:

type of the item

isPreStep

public boolean isPreStep()
                  throws AbortException,
RemoteException

Throws:

AbortException

RemoteException

isSubStep

public boolean isSubStep()
                  throws AbortException,
RemoteException

Throws:

AbortException

RemoteException

getSubStepIdentificationName

public String getSubStepIdentificationName()
                                    throws AbortException,
RemoteException

Throws:

AbortException

RemoteException

getPreStepIdentificationName

public List<String> getPreStepIdentificationName()
                                          throws AbortException,
RemoteException

Throws:

AbortException

RemoteException

getIsValidatingSubStep

public boolean getIsValidatingSubStep()
                               throws AbortException,
RemoteException

Throws:

AbortException

RemoteException

isSubTransformationStep

public boolean isSubTransformationStep()
                                throws AbortException,
RemoteException

Throws:

AbortException

RemoteException

getSymbolicStepName

public String getSymbolicStepName()

Specified by:

getSymbolicStepName in interface ModelTransformationStepIF

Returns:

returns the transformation step's symbolic name

getStepProposals

public List<String> getStepProposals()

Specified by:

getStepProposals in interface ModelTransformationStepIF

getPredecessorModelTransformationStep

public ModelTransformationStepList getPredecessorModelTransformationStep()
                                                                  throws AbortException,
RemoteException

Specified by:

getPredecessorModelTransformationStep in interface ModelTransformationStepIF

Throws:

AbortException

RemoteException

getRelevantTransformationStep

public static ModelTransformationStepList getRelevantTransformationStep(ConfigurableItemIF runtimeItem,
 MappingElementIF sourceElement,
 String sStepIdentifier,
 String tagProposal)
                                                                 throws RemoteException,
M2MException

Throws:

RemoteException

M2MException

getTansformationStepIterator

public TransformationStepIterator getTansformationStepIterator()

Specified by:

getTansformationStepIterator in interface ModelTransformationStepIF

getStepFullName

public String getStepFullName()

isName

public boolean isName(String name)