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

Class Pattern

java.lang.Object

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

de.mid.innovator.m2msdk.model.transformation.pattern.Pattern

All Implemented Interfaces:

ConditionAbleIF, ConfigurableItemIF, PatternIF, IdentifierAble, Serializable

Direct Known Subclasses:

PatternEmbeddingDefault, PatternExtendingInnovator, PatternHookBase, PatternHookInnovator, PatternProductionAppend, PatternTargetMatchBase

public abstract class Pattern
extends ConfigurableItem
implements PatternIF

Base class for all patterns.

Author:

jmback

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Pattern()

Method Summary

Modifier and Type	Method	Description
void	checkElementsExtension(MappingElementList patternOut)
final void	evaluate(MappingModelRole modelRole, MappingElementIF sourceElement, MappingAnchor anchors, MappingElementList patternIn, MappingElementList patternOut, TransformationStepSubStepData subStepData)	Evaluate the pattern.
boolean	evaluateConditions(MappingElementIF sourceElement, MappingElementIF targetElement)	Evaluate the conditions for a pair of source and target elements or for a single source element.
ValidatingScore	evaluateScore(MappingElementIF sourceElement, MappingElementIF targetElement)	Evaluate the score of the target element in context of source element.
void	filterByPattern(MappingModelRole modelRole, MappingElementIF sourceElement, MappingAnchor anchors, MappingElementList patternIn, MappingElementList patternOut, TransformationStepSubStepData subStepData)	Filter the given list of patterns.
MappingElementList	filterElements(MappingElementIF sourceElement, MappingElementList targetElements)	Filter the list target elements according to conditions and current source element.
ParameterTemplates	getKnownParameters(MappingElementIF me, ConfigurationItemIF item)	Get the list of all acceptable parameter names.
void	preinit(SessionInterface iSession, MappingModelRole modelRole)	Preinits the element for later usage.
void	setConfigurationContext(SessionInterface iSession, MetaModel sourceMM, MetaModel targetMM, ConfigurationItemIF context)	Set the configuration context of this configurable item.

Methods inherited from class de.mid.innovator.m2msdk.model.transformation.ConfigurableItem

checkConstraints, checkConstraints, getBaseItem, getConfigurableItems, getConfigurationTag, getId, getItem, getName, getParentItem, getParentItem, setBaseItem, setConfigurationTag, setId, setParent, toString

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, checkConstraints, getBaseItem, getConfigurableItems, getConfigurationTag, getItem, getName, getParentItem, getParentItem, setBaseItem, setConfigurationTag, setParent

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

getId, setId

Constructor Details

Pattern

public Pattern()

Method Details

evaluateScore

public ValidatingScore evaluateScore(MappingElementIF sourceElement,
 MappingElementIF targetElement)
                              throws RemoteException,
M2MException

Description copied from interface: ConditionAbleIF

Evaluate the score of the target element in context of source element.

Specified by:

evaluateScore in interface ConditionAbleIF

Parameters:

sourceElement - source element

targetElement - target element

Returns:

a score showing how good the target matches the source via conditions

Throws:

RemoteException - communication error

M2MException - application error

checkElementsExtension

public void checkElementsExtension(MappingElementList patternOut)
                            throws AbortException,
RemoteException

Throws:

AbortException

RemoteException

evaluateConditions

public boolean evaluateConditions(MappingElementIF sourceElement,
 MappingElementIF targetElement)
                           throws M2MException,
RemoteException

Description copied from interface: ConditionAbleIF

Evaluate the conditions for a pair of source and target elements or for a single source element.

Specified by:

evaluateConditions in interface ConditionAbleIF

Parameters:

sourceElement - source element for the evaluation

targetElement - target element for the evaluation

Returns:

true, if all conditions are true

Throws:

M2MException - error in application

RemoteException - error in communication

filterElements

public MappingElementList filterElements(MappingElementIF sourceElement,
 MappingElementList targetElements)
                                  throws M2MException,
RemoteException

Description copied from interface: ConditionAbleIF

Filter the list target elements according to conditions and current source element.

Specified by:

filterElements in interface ConditionAbleIF

Parameters:

sourceElement - source element

targetElements - candidate target elements

Returns:

filtered target elements

Throws:

M2MException - application error

RemoteException - communication error

filterByPattern

public void filterByPattern(MappingModelRole modelRole,
 MappingElementIF sourceElement,
 MappingAnchor anchors,
 MappingElementList patternIn,
 MappingElementList patternOut,
 TransformationStepSubStepData subStepData)
                     throws M2MException,
RemoteException

Description copied from interface: PatternIF

Filter the given list of patterns.

Specified by:

filterByPattern in interface PatternIF

Parameters:

modelRole - If the given pattern is in the source or target model

sourceElement - TODO

anchors -

patternIn - The list of patterns to be filtered

patternOut - The list of patterns which matched

subStepData - SubstepData

Throws:

M2MException - an exception occurred

RemoteException

evaluate

public final void evaluate(MappingModelRole modelRole,
 MappingElementIF sourceElement,
 MappingAnchor anchors,
 MappingElementList patternIn,
 MappingElementList patternOut,
 TransformationStepSubStepData subStepData)
                    throws M2MException,
RemoteException

Description copied from interface: PatternIF

Evaluate the pattern.

Specified by:

evaluate in interface PatternIF

Parameters:

modelRole - If the given pattern is in the source or target model

sourceElement - source element to compare the target with

anchors - anchor for the created patterns. The anchor maybe modified by an embedding.

patternIn - pattern to be used for creation

patternOut - created pattern

subStepData - subStepData

Throws:

M2MException - an exception occurred

RemoteException

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

preinit

public void preinit(SessionInterface iSession,
 MappingModelRole modelRole)
             throws M2MException,
RemoteException

Description copied from interface: PatternIF

Preinits the element for later usage.

Specified by:

preinit in interface PatternIF

Parameters:

iSession - Session item

modelRole - it his pattern used in source or target model

Throws:

M2MException

RemoteException

RemoteException

getKnownParameters

public ParameterTemplates getKnownParameters(MappingElementIF me,
 ConfigurationItemIF item)
                                      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

item - configuration item, maybe null

Returns:

list of parameter names

Throws:

M2MException - generic exception

RemoteException - error in communication

RemoteException - exception from remote execution