de.cau.cs.kieler.core.model.xtend.transformation
Interface ITransformationFramework

All Known Implementing Classes:
XtendTransformationFramework

Deprecated. This class is used by KSBasE. For new implementations use the ITransformationContext instead.

public interface ITransformationFramework

Interface for creating a bridge between a transformation framework and KIELER. Every transformation framework that is used by the KSBasE Plug-in has to implement this interface. The XtendTransformationFramework class contains an implementation for the Xtend framework.

Rating red

Method Summary
 List<Object> createParameterMapping(List<EObject> parametersToMap, String... parameter)
          Deprecated. Creates the actual mapping between the selected diagram elements and the given list of formal parameters.
 Object executeTransformation()
          Deprecated. Executes a transformation with the parameters set with the initalizeTransformation method.
 String getFileExtension()
          Deprecated. Returns the default file extension for this framework without the leading dot.
 boolean initializeTransformation(String fileName, String operation, String... basePackages)
          Deprecated. Initializes a transformation.
 List<AbstractTransformation> parseTransformations(URL fileName, boolean inplaceOnly)
          Deprecated. Parses a transformation file and returns the existing transformations.
 void reset()
          Deprecated. Resets the transformation framework.
 boolean setParameters(List<EObject> parametersToMap, String... parameter)
          Deprecated. Sets the transformation parameters by matching the current selection with the given list of types.
 void setParameters(Object[] parameter)
          Deprecated. Sets the transformation parameters.
 

Method Detail

getFileExtension

String getFileExtension()
Deprecated. 
Returns the default file extension for this framework without the leading dot.

Returns:
A string representing the file extension

executeTransformation

Object executeTransformation()
                             throws TransformException
Deprecated. 
Executes a transformation with the parameters set with the initalizeTransformation method.

Returns:
A return value from the transformation. May be null
Throws:
TransformException - if executing the transformation failed

setParameters

boolean setParameters(List<EObject> parametersToMap,
                      String... parameter)
Deprecated. 
Sets the transformation parameters by matching the current selection with the given list of types. The framework may return 'false' if the parameters could not be matched.

Parameters:
parametersToMap - The list of parameters that should be mapped. If this is null, the parameters are retrieved from the current selection
parameter - The list of parameter types.
Returns:
True if all parameters could be set.

createParameterMapping

List<Object> createParameterMapping(List<EObject> parametersToMap,
                                    String... parameter)
Deprecated. 
Creates the actual mapping between the selected diagram elements and the given list of formal parameters.

Parameters:
parametersToMap - The list of parameters that should be mapped. If this is null, the parameters are retrieved from the current selection
parameter - The list of formal parameters
Returns:
The parameters or null if the mapping could not achieved

setParameters

void setParameters(Object[] parameter)
Deprecated. 
Sets the transformation parameters.

Parameters:
parameter - The actual parameters

reset

void reset()
Deprecated. 
Resets the transformation framework.


initializeTransformation

boolean initializeTransformation(String fileName,
                                 String operation,
                                 String... basePackages)
Deprecated. 
Initializes a transformation. This includes the parameter mapping, if necessary. The parameter 'parameter' is only a string representation of the parameter types of the given operation.

Parameters:
fileName - The transformation file name
operation - The operation to execute
basePackages - The class name of the editors EPackage
Returns:
False if an error occurred.

parseTransformations

List<AbstractTransformation> parseTransformations(URL fileName,
                                                  boolean inplaceOnly)
Deprecated. 
Parses a transformation file and returns the existing transformations.

Parameters:
fileName - a URL to the transformation file
inplaceOnly - indicates if only in-place transformations should be parsed. If this flag is set to 'false' in-place transformations will be ignored!
Returns:
a list of abstract transformations.