ModelTransformationInfo

All Known Implementing Classes:

AbstractModelTransformationInfo, AnyToAnyModelTransformationInfo
```
@OpenApiAll
public interface ModelTransformationInfo
```
Interface for model transformation info

See Also:

AbstractModelTransformationInfo

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`canCreateNewElements()` If true, new elements can be created as the result of transformation.
`PropertyManager`	`getDefaultPropertyManager()` Returns property manager with default properties for transformation
`java.lang.String`	`getDefaulTypeMapProfileName()` Returns name of default type map profile
`java.io.InputStream`	`getDescriptionAsStream()` Returns model transformation description as stream
`javax.swing.Icon`	`getIcon()` Returns model transformation icon
`TypeMapProfile`	`getSpecificTypeMap()` In case there is no user selected option to select type map specific type map can be provided.
`ModelTransformation`	`getTransformation()` Returns model transformation for this info
`java.lang.String`	`getTransformationName()` Getter for model transformation name
`boolean`	`isDefaulTypeMapProfileMappingOrderForward()` Returns mapping order of default type map profile
`boolean`	`isOnlyInPlace()`
`boolean`	`isSupportsLeaveIntactModel()`
`boolean`	`isTypeMappingSupported()` Getter for type mapping support
`boolean`	`isVisibleInBrowser(BaseElement e)` Is element visible in source selection tree.
`boolean`	`prepareTransformation(Project project)` Prepares transformation
`default boolean`	`shouldPreloadDiagram(DiagramPresentationElement diagram, java.util.Collection<BaseElement> elementsInScope)`

- Method Detail
  - getTransformationName
```
java.lang.String getTransformationName()
```
    Getter for model transformation name
    
    Returns:
    
    model transformation name
  - getIcon
```
javax.swing.Icon getIcon()
```
    Returns model transformation icon
    
    Returns:
    
    model transformation icon
  - getTransformation
```
ModelTransformation getTransformation()
```
    Returns model transformation for this info
    
    Returns:
    
    model transforamtion
  - getDefaultPropertyManager
```
PropertyManager getDefaultPropertyManager()
```
    Returns property manager with default properties for transformation
    
    Returns:
    
    property manager
  - isTypeMappingSupported
```
boolean isTypeMappingSupported()
```
    Getter for type mapping support
    
    Returns:
    
    true if type mapping is supported by transformation
  - getDefaulTypeMapProfileName
```
java.lang.String getDefaulTypeMapProfileName()
```
    Returns name of default type map profile
    
    Returns:
    
    name of default type map
  - isDefaulTypeMapProfileMappingOrderForward
```
boolean isDefaulTypeMapProfileMappingOrderForward()
```
    Returns mapping order of default type map profile
    
    Returns:
    
    return true for forward mapping
  - prepareTransformation
```
boolean prepareTransformation(Project project)
```
    Prepares transformation
    
    Parameters:
    
    project -
    
    Returns:
    
    true if preparation was successful, false in other case
  - isVisibleInBrowser
```
boolean isVisibleInBrowser(BaseElement e)
```
    Is element visible in source selection tree.
    
    Parameters:
    
    e - element to check
    
    Returns:
    
    true if visible
  - getDescriptionAsStream
```
java.io.InputStream getDescriptionAsStream()
```
    Returns model transformation description as stream
    
    Returns:
    
    input stream of model transformation description.
  - isSupportsLeaveIntactModel
```
boolean isSupportsLeaveIntactModel()
```
  - isOnlyInPlace
```
boolean isOnlyInPlace()
```
    Returns:
    
    true if transformation supports only in place transformation.
  - getSpecificTypeMap
```
TypeMapProfile getSpecificTypeMap()
```
    In case there is no user selected option to select type map specific type map can be provided.
    
    Returns:
    
    TypeMapProfile which should be used in this transformation.
  - canCreateNewElements
```
default boolean canCreateNewElements()
```
    If true, new elements can be created as the result of transformation. This might cause auto-numbers update to be called which can be time consuming Returning false indicates that the transformation only modifies existing elements and updating auto-numbers can be skipped
  - shouldPreloadDiagram
```
default boolean shouldPreloadDiagram(DiagramPresentationElement diagram,
                                     java.util.Collection<BaseElement> elementsInScope)
```
    Parameters:
    
    diagram - any not loaded diagram in the project
    
    elementsInScope - all elements in scope of this transformation
    
    Returns:
    
    true if the given diagram should be loaded before executing the transformation

Interface ModelTransformationInfo

Method Summary

Method Detail

getTransformationName

getIcon

getTransformation

getDefaultPropertyManager

isTypeMappingSupported

getDefaulTypeMapProfileName

isDefaulTypeMapProfileMappingOrderForward

prepareTransformation

isVisibleInBrowser

getDescriptionAsStream

isSupportsLeaveIntactModel

isOnlyInPlace

getSpecificTypeMap

canCreateNewElements

shouldPreloadDiagram