archimate.codegen
Interface IGenModel

All Known Implementing Classes:
MVCModel

public interface IGenModel

This interface defines the model containing all code generation settings for an ICodeGenerator

Author:
Samuel Esposito

Method Summary
 java.lang.String classComment(java.lang.String archiMateTag)
          Returns the comments for a class
 java.lang.String className(java.lang.String archiMateTag)
          Returns the class name for a source file
 java.util.ArrayList<java.lang.String> imports(java.lang.String archiMateTag)
          Returns the imports for a snippet of code
 java.util.ArrayList<java.lang.String> interfaces(java.lang.String archiMateTag)
          Returns a list of implemented interfaces
 boolean isInterface(java.lang.String archiMateTag)
          Returns whether a source file contains a class or an interface
 java.util.ArrayList<java.lang.String> methodInvocations(java.lang.String archiMateTag)
          Returns a list of methods invoking another method in a source file
 java.util.ArrayList<java.lang.String> methods(java.lang.String archiMateTag)
          Returns a list of methods in a source file
 java.lang.String objectClass(java.lang.String archiMateTag)
          Returns the class of an object
 java.lang.String objectName(java.lang.String archiMateTag)
          Returns the name of an object
 java.lang.String packageBase()
          Returns the source folder package base
 java.lang.String packageName(java.lang.String archiMateTag)
          Returns the package name for a source file
 java.lang.String sourceType(java.lang.String archiMateTag)
          Returns the type of the tagged source element.
 java.lang.String targetFile(java.lang.String archiMateTag)
          Returns the file name for a source file
 java.lang.String targetFolder()
          Returns the project source folder
 

Method Detail

sourceType

java.lang.String sourceType(java.lang.String archiMateTag)
Returns the type of the tagged source element. Types can either be one of JavaHelper.METHOD_DECLARATION, JavaHelper.METHOD_IMPLEMENTATION or JavaHelper.METHOD_INVOCATION.

Parameters:
archiMateTag - The tag of the source element at hand
Returns:
the type of the tagged source element

targetFolder

java.lang.String targetFolder()
Returns the project source folder

Returns:
The project source folder

packageBase

java.lang.String packageBase()
Returns the source folder package base

Returns:
The source folder package base

targetFile

java.lang.String targetFile(java.lang.String archiMateTag)
Returns the file name for a source file

Parameters:
archiMateTag - The tag labeling the class in the source file
Returns:
The file name for a source file

packageName

java.lang.String packageName(java.lang.String archiMateTag)
Returns the package name for a source file

Parameters:
archiMateTag - The tag labeling the class in the source file
Returns:
The package name for a source file

imports

java.util.ArrayList<java.lang.String> imports(java.lang.String archiMateTag)
Returns the imports for a snippet of code

Parameters:
archiMateTag - The tag labeling the key source element
Returns:
The imports for a snippet of code

classComment

java.lang.String classComment(java.lang.String archiMateTag)
Returns the comments for a class

Parameters:
archiMateTag - The tag labeling the key source element
Returns:
The comments for a class

className

java.lang.String className(java.lang.String archiMateTag)
Returns the class name for a source file

Parameters:
archiMateTag - The tag labeling the key source element
Returns:
The class name for a source file

interfaces

java.util.ArrayList<java.lang.String> interfaces(java.lang.String archiMateTag)
Returns a list of implemented interfaces

Parameters:
archiMateTag - The tag labeling the key source element
Returns:
A list of implemented interfaces

isInterface

boolean isInterface(java.lang.String archiMateTag)
Returns whether a source file contains a class or an interface

Parameters:
archiMateTag - The tag labeling the key source element
Returns:
Whether a source file contains a class or an interface

objectClass

java.lang.String objectClass(java.lang.String archiMateTag)
Returns the class of an object

Parameters:
archiMateTag - The tag labeling the key source element
Returns:
The class of an object

objectName

java.lang.String objectName(java.lang.String archiMateTag)
Returns the name of an object

Parameters:
archiMateTag - The tag labeling the key source element
Returns:
The name of an object

methods

java.util.ArrayList<java.lang.String> methods(java.lang.String archiMateTag)
Returns a list of methods in a source file

Parameters:
archiMateTag - The tag labeling the key source element
Returns:
A list of methods in a source file

methodInvocations

java.util.ArrayList<java.lang.String> methodInvocations(java.lang.String archiMateTag)
Returns a list of methods invoking another method in a source file

Parameters:
archiMateTag - The tag labeling the key source element
Returns:
A list of methods invoking another method in a source file