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

Interface ConfigurableItemIF

All Superinterfaces:

IdentifierAble, Serializable

All Known Subinterfaces:

AnchorGroupIF, ApplicationInterface, ChangeSetIF, ConditionIF, ConstraintIF, EngineInterface, ExtensionStatementIF, FilterExtensionStatementIF, FrameInterface, FunctionalVariationPointIF, GroupIF, InsertIF, MappingModelGlueIF, ModelAnchorIF, ModelEmbeddingIF, ModelExtensionIF, ModelTransformationIF, ModelTransformationStepIF, ModificationIF, OperatorIF, ParameterIF, PatternIF, PatternProductionIF, ReferenceIF, SetExtensionStatementIF, SolutionIF, SourceMatchClassIF, TargetMatchClassIF, TemplateIF, WorkflowInterface

All Known Implementing Classes:

AddToStore, AnchorAllGroup, AnchorAnyGroup, AnchorChoiceGroup, AnchorGroup, AndFunction, ChangeFrame, ChangeSet, ClassRegister, Condition, ConfigurableItem, ConfigurationFrame, ConfigurationReader, ConfigurationWriter, ConflictFrame, ConflictType, ConflictTypeNameChanged, ConflictTypeNamespace, ConflictTypeNullForeign, ConflictTypeNullPrimaryForeign, ConflictTypeNullPrimaryPrimary, ConflictTypeSplitByColumn, ConflictTypeSplitByRow, Constraint, DebugFrame, DeleteMappingModelGlueInnovatorDependency, DeleteStore, ElementFromActivePassiveSelection, ElementFromInitialSelection, ElementFromStore, ElementFromStore, Error, ErrorFrame, ExtensionGroup, FileFrame, FilterChanged, FunctionalVariationPointGroup, FunctionalVariationPointGroups, InnovatorModelCreate, InnovatorModelDelete, InnovatorModelImportAOB, InnovatorModelRestoreFromZip, InnovatorModelSaveToZip, InnovatorModelWorkflowBase, InnovatorRepositoryCreate, InnovatorRepositoryRestoreFromZip, InnovatorRepositorySaveToZip, InnovatorRepositoryShutdown, InnovatorRepositoryStart, InnovatorRepositoryStatus, InnovatorRepositoryWorkflowBase, Insert, LastMappingDataWriter, LogCleaner, LogFrame, LogWriter, MapCompartmentVisibility, MapEdgePositions, MappingElementReaderBase, MappingElementWriterBase, MappingModelGlue, MappingModelGlueInnovator, MappingModelGlueInnovatorDependency, MappingModelGlueInnovatorProxyAbstractBase, MappingModelGlueInnovatorProxyExternModel, MappingModelGlueInnovatorProxyInnovator, MappingModelGlueNull, MapTextPosition, ModelAnchor, ModelAnchorCustomNavigation, ModelAnchorInnovator, ModelAnchorInnovatorAbsolutePath, ModelAnchorInnovatorAssociation, ModelAnchorInnovatorAssociationEnd, ModelAnchorInnovatorCustomNavigation, ModelAnchorInnovatorSourceTarget, ModelAnchorInnovatorUri, ModelAnchorSelf, ModelAnchorSubStep, ModelConfigurationImporterReader, ModelExtension, ModelTransformation, ModelTransformationStep, ModelTransformationStepBase, Modification, NotAndFunction, NotOrFunction, NullTransform, Operator, OptionFrame, OptionReader, OptionSetter, OptionWriter, OrFunction, ParameterCardinalityStructure, ParameterImpl, ParameterListRangeSelectionStructure, ParameterStructureBase, Pattern, PatternEmbeddingDefault, PatternEmbeddingInnovatorDiagram, PatternEmbeddingInnovatorSortOrder, PatternEmbeddingMultiple, PatternEmbeddingNull, PatternEmbeddingPair, PatternEmbeddingQualified, PatternExtendingInnovator, PatternHookBase, PatternHookElementFromActivePassiveSelection, PatternHookElementFromInitialSelection, PatternHookElementFromTransformationStep, PatternHookInnovator, PatternProductionAbs2RelPositionInnovator, PatternProductionAppend, PatternProductionAssignmentInnovator, PatternProductionBaseInnovator, PatternProductionDiagramInnovator, PatternProductionDiagramRotationInnovator, PatternProductionError, PatternProductionNull, PatternProductionPathSequence, PatternProductionSortOrderInnovator, PatternProductionStretchDiaNodePositionsInnovator, PatternSourceHookElementByElementURI, PatternSourceHookPackageByPath, PatternTargetHookElementByCreateRedirect, PatternTargetHookElementByElementURI, PatternTargetHookElementByMappingConfigurationPackage, PatternTargetHookPackageByPath, PatternTargetMatchAnchor, PatternTargetMatchAssociationEndInnovator, PatternTargetMatchAssociationInnovator, PatternTargetMatchBase, PatternTargetMatchBaseInnovator, PatternTargetMatchCommentAssignInnovator, PatternTargetMatchDiagramInnovator, PatternTargetMatchInnovator, PatternTargetMatchInnovatorLost, PatternTargetMatchOwning, PatternTargetMatchPathSequence, PatternTargetMatchSource, PatternTargetMatchSourceTargetInnovator, ProgressFrame, Reference, RelationModelWriter, RemoveFromStore, RepositoryShutdown, RepositoryStartOrCreate, ServerFrame, SetExtension, SimpleExtension, SimpleTransform, SourceCleaner, SourceFrame, SourceReader, SourceReaderInnovator, SourceReaderJavaBeans, SourceWriter, SourceWriterInnovator, StepGroup, StepReferenceParameterStructure, StoreReader, StoreRWBase, StoreWriter, SuccessFrame, TabbedFrame, TargetFrame, TargetReader, TargetReaderInnovator, TargetWriter, TargetWriterInnovator, TransformationStepIterator, WelcomeFrame, WizardHorizontalFrame, WizardVerticalFrame, WorkflowRunner, XOrFunction

public interface ConfigurableItemIF
extends IdentifierAble, Serializable

This interface allows configuration of this item.

Version:

10.1.1

Author:

jmback

Method Summary

Modifier and Type	Method	Description
boolean	checkConstraints(MappingElementIF sourceElement, MappingElementList targetElement, MappingElementList passedElements, MappingElementList bypassedElements)
boolean	checkConstraints(MappingElementIF element, ExpressionContext context)	Check if all constraints evaluate to true.
ConfigurationItemIF	getBaseItem()	Configuration item which is the base of this configured item.
List<ConfigurableItemIF>	getConfigurableItems(ConfigurationTag searchTag, ConfigurationItemSearchMode mode)
ConfigurationTag	getConfigurationTag()	Get the type of the configurable item.
ConfigurableItemIF	getItem(Identifier iId)	Get owned item with this identifier.
ParameterTemplates	getKnownParameters(MappingElementIF me, ConfigurationItemIF item)	Get the list of all acceptable parameter names.
String	getName()	Get the name.
ConfigurableItemIF	getParentItem()	Get the parent of this item.
<T extends ConfigurableItemIF> T	getParentItem(Class<T> parentClassType)
void	setBaseItem(ConfigurationItemIF iItem)
void	setConfigurationContext(SessionInterface iSession, MetaModel sourceMM, MetaModel targetMM, ConfigurationItemIF context)	Set the configuration context of this configurable item.
void	setConfigurationTag(ConfigurationTag iTag)	Set the type of the item.
void	setParent(ConfigurableItemIF iParent)	Set the parent of this item.

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

getId, setId

Method Details

getName

String getName()

Get the name.

Returns:

name as given by user in model transformation configuration

setConfigurationContext

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

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

Parameters:

iSession - session

sourceMM - source meta model

targetMM - target meta model

context - Configuration item

Throws:

M2MException - generic exception

RemoteException - exception from remote execution

getKnownParameters

ParameterTemplates getKnownParameters(MappingElementIF me,
 ConfigurationItemIF item)
                               throws M2MException,
RemoteException

Get the list of all acceptable parameter names.

Parameters:

me - mapping element, maybe null

item - configuration item, maybe null

Returns:

list of parameter names

Throws:

AbortException - exception resulting in abort

SevereException - severe exception

RemoteException - error in communication

M2MException - generic exception

RemoteException - exception from remote execution

getParentItem

ConfigurableItemIF getParentItem()
                          throws M2MException

Get the parent of this item.

Returns:

parent item, if found, else null

Throws:

M2MException - error in communication

getParentItem

<T extends ConfigurableItemIF> T getParentItem(Class<T> parentClassType)
                                        throws M2MException

Throws:

M2MException

setParent

void setParent(ConfigurableItemIF iParent)
        throws M2MException

Set the parent of this item.

Parameters:

iParent - parent item

Throws:

M2MException - error in communication

getConfigurationTag

ConfigurationTag getConfigurationTag()

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

Returns:

type of the item

setConfigurationTag

void setConfigurationTag(ConfigurationTag iTag)

Set the type of the item.

Parameters:

iTag - type of the item

getBaseItem

ConfigurationItemIF getBaseItem()

Configuration item which is the base of this configured item.

Returns:

configuration item

setBaseItem

void setBaseItem(ConfigurationItemIF iItem)

getConfigurableItems

List<ConfigurableItemIF> getConfigurableItems(ConfigurationTag searchTag,
 ConfigurationItemSearchMode mode)
                                       throws M2MException

Throws:

M2MException

checkConstraints

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

Check if all constraints evaluate to true.

Parameters:

context - context of evaluation with source and target

Returns:

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

Throws:

M2MException - generic exception

RemoteException - exception from remote execution

checkConstraints

boolean checkConstraints(MappingElementIF sourceElement,
 MappingElementList targetElement,
 MappingElementList passedElements,
 MappingElementList bypassedElements)
                  throws RemoteException,
M2MException

Throws:

RemoteException

M2MException

getItem

ConfigurableItemIF getItem(Identifier iId)

Get owned item with this identifier.

Parameters:

iId - identifier of the item, maybe the identifier of an owned element

Returns:

item if found, else null