Interface PatternIF

All Superinterfaces:

ConditionAbleIF, ConfigurableItemIF, IdentifierAble, Serializable

All Known Subinterfaces:

ModelEmbeddingIF, SourceMatchClassIF, TargetMatchClassIF

All Known Implementing Classes:

ElementFromActivePassiveSelection, ElementFromInitialSelection, ElementFromStore, ElementFromStore, Pattern, PatternEmbeddingDefault, PatternEmbeddingInnovatorDiagram, PatternEmbeddingInnovatorSortOrder, PatternEmbeddingMultiple, PatternEmbeddingNull, PatternEmbeddingOne, PatternEmbeddingPair, PatternEmbeddingQualified, PatternExtendingInnovator, PatternHookBase, PatternHookElementFromActivePassiveSelection, PatternHookElementFromInitialSelection, PatternHookElementFromTransformationStep, PatternHookInnovator, PatternProductionAppend, PatternProductionBaseInnovator, PatternProductionDiagramInnovator, PatternProductionError, PatternProductionPathSequence, PatternProductionSortOrderInnovator, PatternSourceHookElementByElementURI, PatternSourceHookPackageByPath, PatternTargetHookElementByCreateRedirect, PatternTargetHookElementByElementURI, PatternTargetHookElementByMappingConfigurationPackage, PatternTargetHookPackageByPath, PatternTargetMatchAnchor, PatternTargetMatchAssociationEndInnovator, PatternTargetMatchAssociationInnovator, PatternTargetMatchBase, PatternTargetMatchBaseInnovator, PatternTargetMatchCommentAssignInnovator, PatternTargetMatchDiagramInnovator, PatternTargetMatchInnovator, PatternTargetMatchInnovatorLost, PatternTargetMatchOwning, PatternTargetMatchPathSequence, PatternTargetMatchSource, PatternTargetMatchSourceTargetInnovator

public interface PatternIF
extends ConfigurableItemIF, ConditionAbleIF

The pattern

Author:

jmback

Method Summary

Modifier and Type	Method	Description
void	evaluate(MappingModelRole modelRole, MappingElementIF sourceElement, MappingAnchor anchors, MappingElementList patternIn, MappingElementList patternOut, TransformationStepSubStepData subStepData)	Evaluate the pattern.
void	filterByPattern(MappingModelRole modelRole, MappingElementIF sourceElement, MappingAnchor anchors, MappingElementList patternIn, MappingElementList patternOut, TransformationStepSubStepData subStepData)	Filter the given list of patterns.
void	preinit(SessionInterface iSession, MappingModelRole modelRole)	Preinits the element for later usage.

Methods inherited from interface ConditionAbleIF

evaluateConditions, evaluateScore, filterElements

Methods inherited from interface ConfigurableItemIF

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

Methods inherited from interface IdentifierAble

getId, setId

Method Details

filterByPattern

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

Filter the given list of patterns.

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

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

Evaluate the pattern.

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

preinit

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

Preinits the element for later usage.

Parameters:

iSession - Session item

modelRole - it his pattern used in source or target model

Throws:

M2MException

RemoteException

AbortException - critical error

SevereException - non critical error

RemoteException