Package org.contextmapper.dsl.standalone

Interface StandaloneContextMapperAPI

All Known Implementing Classes:

StandaloneContextMapper

public interface StandaloneContextMapperAPI

Interface that eases the usage of Context Mapper in standalone (usage as library) scenario.

Method Summary

Modifier and Type	Method	Description
void	applyRefactoring(CMLResource cml, SemanticCMLRefactoring refactoring)	Applies a refactoring (must be of type SemanticCMLRefactoring) on a CML model.
void	callGenerator(CMLResource cml, org.eclipse.xtext.generator.IGenerator2 generator)	Calls a generator that produces output (Graphical Context Map, PlantUML, etc.) given a CML resource as input.
void	callGenerator(CMLResource cml, org.eclipse.xtext.generator.IGenerator2 generator, java.lang.String outputDir)	Calls a generator that produces output (Graphical Context Map, PlantUML, etc.) given a CML resource as input.
CMLResource	createCML(java.io.File cmlFile)	Creates a new CML model.
CMLResource	createCML(java.lang.String filepath)	Creates a new CML model.
CMLResource	loadCML(java.io.File cmlFile)	Loads a CML model, given a *.cml file.
CMLResource	loadCML(java.lang.String filepath)	Loads a CML model, given a *.cml file.

Method Detail

loadCML

CMLResource loadCML(java.lang.String filepath)

Loads a CML model, given a *.cml file.

Parameters:

filepath - the path to the *.cml file that shall be loaded

Returns:

the CMLResource loaded from the *.cml file

loadCML

CMLResource loadCML(java.io.File cmlFile)

Loads a CML model, given a *.cml file.

Parameters:

cmlFile - the *.cml file

Returns:

the CMLResource loaded from the *.cml file

createCML

CMLResource createCML(java.lang.String filepath)

Creates a new CML model.

Parameters:

filepath - the filepath where the *.cml file will be stored, in case the resource is saved/persisted

Returns:

the new CMLResource (not yet persisted; you have to call save() on the resource)

createCML

CMLResource createCML(java.io.File cmlFile)

Creates a new CML model.

Parameters:

cmlFile - the file where the *.cml file will be stored, in case the resource is saved/persisted

Returns:

the new CMLResource (not yet persisted; you have to call save() on the resource)

callGenerator

void callGenerator(CMLResource cml,
                   org.eclipse.xtext.generator.IGenerator2 generator)

Calls a generator that produces output (Graphical Context Map, PlantUML, etc.) given a CML resource as input. This method generates all output files into the default directory "./src-gen".

Parameters:

cml - the CML resource for which the generator shall be called

generator - the generator that shall be called

callGenerator

void callGenerator(CMLResource cml,
                   org.eclipse.xtext.generator.IGenerator2 generator,
                   java.lang.String outputDir)

Calls a generator that produces output (Graphical Context Map, PlantUML, etc.) given a CML resource as input. This method allows to define the directory into which the output shall be generated (start with "./" and provide a directory relative to your execution home).

Parameters:

cml - the CML resource for which the generator shall be called

generator - the generator that shall be called

outputDir - the directory in which you want to generate the output (start with "./", relative to your execution directory)

applyRefactoring

void applyRefactoring(CMLResource cml,
                      SemanticCMLRefactoring refactoring)

Applies a refactoring (must be of type SemanticCMLRefactoring) on a CML model.

Parameters:

cml - the model on which the refactoring shall be applied

refactoring - the refactoring that shall be applied