Package org.contextmapper.dsl.standalone

Class StandaloneContextMapper

java.lang.Object

org.contextmapper.dsl.standalone.StandaloneContextMapper

All Implemented Interfaces:

StandaloneContextMapperAPI

public class StandaloneContextMapper
extends Object
implements StandaloneContextMapperAPI

Constructor Summary

Constructors

Constructor	Description
StandaloneContextMapper()

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, String outputDir)	Calls a generator that produces output (Graphical Context Map, PlantUML, etc.) given a CML resource as input.
CMLResource	createCML(File cmlFile)	Creates a new CML model.
CMLResource	createCML(String filepath)	Creates a new CML model.
CMLResource	loadCML(File cmlFile)	Loads a CML model, given a *.cml file.
CMLResource	loadCML(String filepath)	Loads a CML model, given a *.cml file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StandaloneContextMapper

public StandaloneContextMapper()

Method Details

loadCML

public CMLResource loadCML(String filepath)

Description copied from interface: StandaloneContextMapperAPI

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

Specified by:

loadCML in interface StandaloneContextMapperAPI

Parameters:

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

Returns:

the CMLResource loaded from the *.cml file

loadCML

public CMLResource loadCML(File cmlFile)

Description copied from interface: StandaloneContextMapperAPI

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

Specified by:

loadCML in interface StandaloneContextMapperAPI

Parameters:

cmlFile - the *.cml file

Returns:

the CMLResource loaded from the *.cml file

callGenerator

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

Description copied from interface: StandaloneContextMapperAPI

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".

Specified by:

callGenerator in interface StandaloneContextMapperAPI

Parameters:

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

generator - the generator that shall be called

callGenerator

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

Description copied from interface: StandaloneContextMapperAPI

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).

Specified by:

callGenerator in interface StandaloneContextMapperAPI

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)

createCML

public CMLResource createCML(String filepath)

Description copied from interface: StandaloneContextMapperAPI

Creates a new CML model.

Specified by:

createCML in interface StandaloneContextMapperAPI

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

public CMLResource createCML(File cmlFile)

Description copied from interface: StandaloneContextMapperAPI

Creates a new CML model.

Specified by:

createCML in interface StandaloneContextMapperAPI

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)

applyRefactoring

public void applyRefactoring(CMLResource cml,
 SemanticCMLRefactoring refactoring)

Description copied from interface: StandaloneContextMapperAPI

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

Specified by:

applyRefactoring in interface StandaloneContextMapperAPI

Parameters:

cml - the model on which the refactoring shall be applied

refactoring - the refactoring that shall be applied