org.modelio.api.modelio.pattern

Interface IPatternService

public interface IPatternService

Represents a project's catalog of patterns.

Since:

3.3.4

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IPatternService.PatternException Thrown when a pattern execution fails.

Method Summary

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

Method Detail

exportPattern

void exportPattern(Package pattern,
                   java.nio.file.Path patternPath)
            throws IPatternService.PatternException

Export a pattern.

Parameters:

pattern - the pattern to export.

patternPath - output path for the export.

Throws:

IPatternService.PatternException - when the Pattern can't be exported.

addPattern

void addPattern(java.nio.file.Path patternPath)
         throws IPatternService.PatternException

Install a pattern into the catalog and load it.

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

Parameters:

patternPath - path to a valid .umlt file.

Throws:

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

getPatterns

java.util.Collection<java.lang.String> getPatterns()

Get all available patterns.

Returns:

a collection of pattern names.

getPatterns

java.util.Collection<java.lang.String> getPatterns(java.util.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(java.lang.String pattern)
            throws IPatternService.PatternException

Remove a pattern from the catalog.

Parameters:

pattern - the pattern to remove.

Throws:

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

applyPattern

void applyPattern(java.lang.String pattern,
                  java.util.Map<java.lang.String,java.lang.Object> parameters)
           throws IPatternService.PatternException

Execute a pattern with the given parameters.

Parameters:

pattern - name of the pattern to execute.

parameters - the parameters for the pattern to run.

Throws:

IPatternService.PatternException - when the pattern execution fails.

canApplyPattern

boolean canApplyPattern(java.lang.String pattern)
                 throws IPatternService.PatternException

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:

IPatternService.PatternException - when the pattern execution fails.

applyPattern

void applyPattern(java.nio.file.Path patternPath,
                  java.util.Map<java.lang.String,java.lang.Object> parameters)
           throws IPatternService.PatternException

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:

IPatternService.PatternException - when the pattern execution fails.