org.modelio.api.modelio.pattern

Interface IPatternService

public interface IPatternService

Represents a project's catalog of patterns.

Since:

3.3.4

Method Summary

Modifier and Type	Method and Description
void	addPattern(Path patternPath) Install a pattern into the catalog and load it.
void	applyPattern(Path patternPath, Map<String,Object> parameters) Execute a pattern with the given parameters.
void	applyPattern(String patternName, Map<String,Object> parameters) Execute a pattern with the given parameters.
boolean	canApplyPattern(String patternName) Check that all module and model components dependencies are resolved before applying a pattern.
void	exportPattern(Package modelPattern, Path patternPath) Export a pattern.
Collection<String>	getPatterns() Get all available patterns.
Collection<String>	getPatterns(Collection<MObject> elements) Get patterns applicable on these elements from the catalog.
void	removePattern(String patternName) Remove a pattern from the catalog.

Method Detail

exportPattern

void exportPattern(Package modelPattern,
                   Path patternPath)
            throws IOException

Export a pattern.

Parameters:

pattern - the pattern to export.

Throws:

IOException - when the Pattern can't be exported.

addPattern

void addPattern(Path patternPath)
         throws IOException

Install a pattern into the catalog and load it.

If the pattern already exists in the catalog, it is replaced.

Parameters:

newPattern - a valid .umlt file.

Throws:

IOException - when the given file doesn't contain a valid pattern.

getPatterns

Collection<String> getPatterns()

Get all available patterns.

Returns:

a collection of pattern names.

getPatterns

Collection<String> getPatterns(Collection<MObject> elements)

Get patterns applicable on these elements from the catalog.

Parameters:

elements - the model elements to filter the patterns with.

Returns:

a collection of pattern names.

removePattern

void removePattern(String patternName)
            throws InvalidParameterException

Remove a pattern from the catalog.

Parameters:

pattern - the pattern to remove.

Throws:

InvalidParameterException - when no pattern with this name is found in the catalog.

applyPattern

void applyPattern(String patternName,
                  Map<String,Object> parameters)
           throws IOException,
                  InvalidParameterException

Execute a pattern with the given parameters.

Parameters:

pattern - the name of the pattern to execute.

parameters - the parameters for the pattern to run.

Throws:

IOException - when the pattern loading fails.

InvalidParameterException - when no pattern with this name is found in the catalog.

canApplyPattern

boolean canApplyPattern(String patternName)
                 throws IOException,
                        InvalidParameterException

Check that all module and model components dependencies are resolved before applying a pattern.

Parameters:

pattern - the name of the pattern to execute.

Returns:

true when all module and model components the pattern depends on are resolved. false if at least one of them is missing.

Throws:

IOException - when the pattern loading fails.

InvalidParameterException - when no pattern with this name is found in the catalog.

applyPattern

void applyPattern(Path patternPath,
                  Map<String,Object> parameters)
           throws IOException

Execute a pattern with the given parameters.

Parameters:

patternPath - the jar of the pattern to execute.

parameters - the parameters for the pattern to run.

Throws:

IOException - when the pattern loading fails.