com.togethersoft.openapi.sci.pattern
Interface SciPatternManager

public interface SciPatternManager

Creates new classes/interfaces, members and links using specified patterns and returns the default patterns for the classes/interfaces, members and links.

Default patterns are patterns which make some default actions for classes/interfaces, members and links.

An instance of SciPatternManger can be obtained using SciModel.getPatternManager() method.

Author:

TogetherSoft

See Also: com.togethersoft.openapi.sci.SciModel.getPatternManager()

public SciClass applyPatternToClass(SciPattern pattern, SciClass sciClass)

public SciElement applyPatternToLink(SciPattern pattern, SciElement sciElement, SciClass sciSource, SciClass sciDestination)

public SciMember applyPatternToMember(SciPattern pattern, SciMember sciMember)

public boolean canApplyPatternToClass(SciPattern pattern, SciClass sciClass)

public boolean canApplyPatternToLink(SciPattern pattern, SciElement sciElement, SciClass sciSource, SciClass sciDestination)

public boolean canApplyPatternToMember(SciPattern pattern, SciMember sciMember)

public boolean canCreateClassByPattern(SciPattern pattern, SciContainer container)

public boolean canCreateLinkByPattern(SciPattern pattern, SciClass sourceClass, SciClass destinationClass)

public boolean canCreateMemberByPattern(SciPattern pattern, SciClass container)

public SciClass createClassByPattern(SciPattern pattern, SciContainer container)

Creates a new class/interface in the specified container using the specified pattern.

Parameters:

pattern - the SciPattern

container - the SciContainer for the newly created class/interface

Returns: a new just created SciClass

public SciElement createLinkByPattern(SciPattern pattern, SciClass sourceClass, SciClass destinationClass)

public SciMember createMemberByPattern(SciPattern pattern, SciClass container)

public SciPattern findPattern(String language, String category, String patternName)

Finds a pattern by using additional information about it.

Parameters:

language - The string with the name of the source code language. The predefined language names are in SciLanguage interface.

category - The string which indicates a kind of an object the pattern is applicable to. The predefined values in SciPatternCategory interface.

patternName - the string with the name of the pattern

Returns: SciPattern matching specified information, null if there is no such pattern

See Also:

SciLanguage, SciPatternCategory

public SciPattern getDefaultClassPattern(SciContainer container, String language, String key)

Returns a default pattern for the classes/interfaces.

Parameters:

container - The SciContainer this pattern is intended to be used within. For different kinds of containers there can be different default patterns for classes/interfaces.

key - The string with additional information about the kind of a class/interface this pattern is intended to work with. There are two predefined kinds "Interface" and "Class" in SciDefaultPattern interface.

Returns: default SciPattern for the classes/interfaces

See Also:

SciDefaultPattern.INTERFACE, SciDefaultPattern.CLASS

public SciPattern getDefaultLinkPattern(SciClass sourceClass, SciClass destinationClass, String key)

public SciPattern getDefaultMemberPattern(SciClass container, String key)