Raw Model

Description

This is the raw model that is exported by the extract command and is based on the interfaces described in the Model Section

Entities

Repository

interface Repository
{
  Version: string;
  Solutions: SolutionModel[];
  Projects: ProjectModel[]
}

Solution

interface Solution
{
    FilePath: string;
    ProjectsPaths: string[];
    Metadata: Dictionary<string, Dictionary<string, string>>
}

Project

interface ProjectModel
{
    Language: string;
    Name: string;
    FilePath: string;
    ProjectReferences: string[];
    Namespaces: NamespaceModel[];
    CompilationUnits: ICompilationUnitType[];
    Metadata: Dictionary<string, Dictionary<string, string>>
}

Language can be either: C# or Visual Basic

Namespace

interface NamespaceModel 
{
    Name: string;
    ClassNames: string[];
}

Compilation Unit

Up until now, the presented models were common to all programming languages. Starting from the compilation unit type, all the interface types are implemented in a dedicated project for each programming language. By doing so, the extractors can keep the same interface across the model, yet still be able to store the particular features of each programming language.

C#

interface CompilationUnitType
{
    FilePath: string;
    ClassTypes: IClassType[];
    Imports: IImportType[];
    Loc: LinesOfCode;
    Metrics: MetricModel[];
}

Visual Basic

interface CompilationUnitType
{
    FilePath: string;
    ClassTypes: IClassType[];
    Imports: IImportType[];
    Loc: LinesOfCode;
    Metrics: MetricModel[];
}

Class

C#

interface ClassModel 
{
    ClassType: string;
    Mame: string;
    GenericParameters: IGenericParameterType[];
    FilePath: string;
    AccessModifier: string;
    Modifier: string;
    ContainingNamespaceName: string;
    ContainingClassName: string;
    BaseTypes: IBaseType[];
    Imports: IImportType[];
    Fields: FieldType[];
    Properties: PropertyType[];
    Constructors: IConstructorType[];
    Methods: IMethodType[];
    Destructor?: IDestructorType;
    Attributes: IAttributeType[];
    Metrics: MetricModel[];
    Loc: LinesOfCode;
}

Visual Basic

interface ClassModel 
{
    ClassType: string;
    Name: string;
    GenericParameters: IGenericParameterType[];
    FilePath: string; 
    AccessModifier: string;
    Modifier: string;
    ContainingNamespaceName: string;
    ContainingModuleName: string;
    ContainingClassName: string;
    BaseTypes: IBaseType[];
    Imports: IImportType[]; 
    Fields: FieldType[];
    Properties: PropertyType[];
    Constructors: ConstructorType[];
    Methods: MethodType[]; 
    Destructor?: IDestructorType;
    Attributes: AttributeType[];
    Metrics: MetricModel[];
    Loc: LinesOfCode;
}

ClassType can be either: class, interface or struct

Enum

C#

interface EnumModel
{
    ClassType: string;
    Mame: string;
    FilePath: string;
    Type: string;
    Labels: IEnumLabelType[];
    AccessModifier: string;
    Modifier: string;
    ContainingNamespaceName: string;
    ContainingClassName: string;
    BaseTypes: IBaseType[];
    Imports: IImportType[]; 
    Attributes: IAttributeType[];
    Metrics: MetricModel[];
    Loc: LinesOfCode;
}

Visual Basic

interface EnumModel 
{
    ClassType: string;
    Mame: string;
    FilePath: string;
    Type: string;
    Labels: IEnumLabelType[];
    AccessModifier: string;
    Modifier: string;
    ContainingNamespaceName: string;
    ContainingModuleName: string;
    ContainingClassName: string;
    BaseTypes: IBaseType[];
    Imports: IImportType[]; 
    Attributes: IAttributeType[];
    Metrics: MetricModel[];
    Loc: LinesOfCode;
}

ClassType is enum

Enum Label

C#

interface EnumLabel 
{
    Name: string; 
    Attributes: IAttributeType[]; 
}

Visual Basic

interface EnumLabel
{
    Name: string; 
    Attributes: IAttributeType[]; 
}

Delegate

C#

interface DelegateModel 
{
    ClassType: string;
    Mame: string;
    FilePath: string;
    GenericParameters: IGenericParameterType[];
    AccessModifier: string;
    Modifier: string;
    ContainingNamespaceName: string;
    ContainingClassName: string;
    BaseTypes: IBaseType[];
    ParameterTypes: IParameterType[];
    ReturnValue: IReturnValueType;
    Imports: IImportType[]; 
    Attributes: IAttributeType[];
    Metrics: MetricModel[];
    Loc: LinesOfCode;
}

Visual Basic

interface DelegateModel 
{
    ClassType: string;
    Mame: string;
    FilePath: string;
    GenericParameters: IGenericParameterType[];
    AccessModifier: string;
    Modifier: string;
    ContainingNamespaceName: string;
    ContainingModuleName: string;
    ContainingClassName: string;
    BaseTypes: IBaseType[];
    ParameterTypes: IParameterType[];
    ReturnValue: IReturnValueType;
    Imports: IImportType[]; 
    Attributes: IAttributeType[];
    Metrics: MetricModel[];
    Loc: LinesOfCode;
}

ClassType is delegate

Import

C#

interface Import 
{
    Name: string; 
    IsStatic: bool;
    Alias: string;
    AliasType: string;
}

Visual Basic

interface Import 
{
    Name: string; 
    IsStatic: bool;
    Alias: string;
    AliasType: string;
}

AliasType can have one of the following values: - None - Namespace - Class - NotDetermined

Base Type

C#

interface BaseType 
{
    Type: IEntityType; 
    Kind: string; 
}

Visual Basic

interface BaseType 
{
    Type: IEntityType; 
    Kind: string; 
}

Kind can be either: class or interface

Entity Type

C#

interface EntityType 
{
    Name: string; 
    FullType: GenericType;
    IsExtern: bool;
}

Visual Basic

interface EntityType
{
    Name: string; 
    FullType: GenericType;
    IsExtern: bool; 
}

Generic Type

interface GenericType
{
    Name: string;
    ContainedTypes: GenericType[];
    IsNullable: bool;
}

Attribute

C#

interface Attribute 
{
    Name: string; 
    Type: IEntityType;
    ParameterTypes: IParameterTypes[];
    Target: string;
}

Visual Basic

interface Attribute 
{
    Name: string; 
    Type: IEntityType;
    ParameterTypes: IParameterTypes[];
    Target: string;
}

Target can be one of the following: - method - type - field - property - param - return

Field

C#

interface Field 
{
    Name: string; 
    Type: IEntityType;
    Modifier: string;
    AccessModifier: string;
    IsEvent: bool;
    IsNullable: bool;
    Attributes: IAttributeType[];
    Metrics: MetricModel[]
}

Visual Basic

interface Field 
{
    Name: string; 
    Type: IEntityType;
    Modifier: string;
    AccessModifier: string;
    IsNullable: bool;
    Attributes: IAttributeType[];
    Metrics: MetricModel[]
}

Property

C#

interface Property 
{
    Name: string; 
    Type: IEntityType;
    Modifier: string;
    AccessModifier: string;
    IsEvent: bool;
    IsNullable: bool;
    CyclomaticComplexity: number;
    Accessors: IAccessorMethodType[];
    Loc: LinesOfCode;
    Attributes: IAttributeType[];
    Metrics: MetricModel[]
}

Visual Basic

interface Property 
{
    Name: string; 
    Type: IEntityType;
    Modifier: string;
    AccessModifier: string;
    IsNullable: bool;
    CyclomaticComplexity: number;
    Accessors: IAccessorMethodType[];
    Loc: LinesOfCode;
    Attributes: IAttributeType[];
    Metrics: MetricModel[]
}

Accessor Method

C#

interface AccessorMethod 
{
    Name: string;
    ReturnValue: IReturnValueType;
    ParameterTypes: IParameterType[];
    AccessModifier: string;
    Modifier: string;
    Attributes: IAttributeType[];
    CalledMethods: IMethodCallType[];
    AccessedFields: AccessField[];
    CyclomaticComplexity: number;
    LocalVariableTypes: ILocalVariableType[];
    LocalFunctions: IMethodType[];
    Loc: LinesOfCode;
    Metrics: MetricModel[];
}

Visual Basic

interface AccessorMethod 
{
    Name: string;
    ReturnValue: IReturnValueType;
    ParameterTypes: IParameterType[];
    AccessModifier: string;
    Modifier: string;
    Attributes: IAttributeType[];
    CalledMethods: IMethodCallType[];
    AccessedFields: AccessField[];
    CyclomaticComplexity: number;
    LocalVariableTypes: ILocalVariableType[];
    LocalFunctions: IMethodType[];
    Loc: LinesOfCode;
    Metrics: MetricModel[];
}

Method

C#

interface Method 
{
    Name: string;
    ReturnValue: IReturnValueType;
    ParameterTypes: IParameterType[];
    GenericParameters: IGenericParameterType[];
    AccessModifier: string;
    Modifier: string;
    Attributes: IAttributeType[];
    CalledMethods: IMethodCallType[];
    AccessedFields: AccessField[];
    CyclomaticComplexity: number;
    LocalVariableTypes: ILocalVariableType[];
    LocalFunctions: IMethodType[];
    Loc: LinesOfCode;
    Metrics: MetricModel[];
}

Visual Basic

interface Method 
{
    Name: string;
    ReturnValue: IReturnValueType;
    ParameterTypes: IParameterType[];
    GenericParameters: IGenericParameterType[];
    AccessModifier: string;
    Modifier: string;
    Attributes: IAttributeType[];
    CalledMethods: IMethodCallType[];
    AccessedFields: AccessField[];
    CyclomaticComplexity: number;
    LocalVariableTypes: ILocalVariableType[];
    LocalFunctions: IMethodType[];
    Loc: LinesOfCode;
    Metrics: MetricModel[];
}

Constructor

C#

interface Constructor 
{
    Name: string;
    ParameterTypes: IParameterType[];
    AccessModifier: string;
    Modifier: string;
    Attributes: IAttributeType[];
    CalledMethods: IMethodCallType[];
    AccessedFields: AccessField[];
    CyclomaticComplexity: number;
    LocalVariableTypes: ILocalVariableType[];
    LocalFunctions: IMethodType[];
    Loc: LinesOfCode;
    Metrics: MetricModel[];
}

Visual Basic

interface Constructor 
{
    Name: string;
    ParameterTypes: IParameterType[];
    AccessModifier: string;
    Modifier: string;
    Attributes: IAttributeType[];
    CalledMethods: IMethodCallType[];
    AccessedFields: AccessField[];
    CyclomaticComplexity: number;
    LocalVariableTypes: ILocalVariableType[];
    LocalFunctions: IMethodType[];
    Loc: LinesOfCode;
    Metrics: MetricModel[];
}

Destructor

C#

interface Destructor 
{
    Name: string;
    ParameterTypes: IParameterType[];
    AccessModifier: string;
    Modifier: string;
    Attributes: IAttributeType[];
    CalledMethods: IMethodCallType[];
    AccessedFields: AccessField[];
    CyclomaticComplexity: number;
    LocalVariableTypes: ILocalVariableType[];
    LocalFunctions: IMethodType[];
    Loc: LinesOfCode;
    Metrics: MetricModel[];
}

Visual Basic

interface Destructor 
{
    Name: string;
    ParameterTypes: IParameterType[];
    AccessModifier: string;
    Modifier: string;
    Attributes: IAttributeType[];
    CalledMethods: IMethodCallType[];
    AccessedFields: AccessField[];
    CyclomaticComplexity: number;
    LocalVariableTypes: ILocalVariableType[];
    LocalFunctions: IMethodType[];
    Loc: LinesOfCode;
    Metrics: MetricModel[];
}

Parameter

C#

interface Parameter 
{
    Type: EntityType; 
    Modifier: string;
    DefaultValue?: string;
    IsNullable: bool;
    Attributes: IAttributeType[];
}

Visual Basic

interface Parameter 
{
    Type: EntityType; 
    Modifier: string;
    DefaultValue?: string;
    IsNullable: bool;
    Attributes: IAttributeType[]; 
}

Generic Parameter

C#

interface GenericParameter 
{
    Name: string;
    Modifier: string;
    Constraints: EntityType[];
    Attributes: IAttributeType[];
}

Visual Basic

interface GenericParameter 
{
    Name: string;
    Modifier: string;
    Constraints: EntityType[];
    Attributes: IAttributeType[];
}

Return Value

C#

interface ReturnValue
{
    Type: IEntityType;
    Modifier: string;
    IsNullable: bool;
    Attributes: IAttributeType[];
}

Visual Basic

interface ReturnValue 
{
    Type: IEntityType;
    Modifier: string;
    IsNullable: bool;
    Attributes: IAttributeType[];
}

Accessed Field

interface AccessedField
{
    Name: string;
    DefinitionClassName: string;
    LocationClassName: string;
    Kind: number;
}

Kind can be either 0 (Getter) or 1 (Setter)

DefinitionClassName is used for the base class and LocationClassName is used for the derived class

Called Method

C#

interface MethodCall
{
    Name: string;
    DefinitionClassName: string;
    LocationClassName: string;
    MethodDefinitionNames: string[];
    GenericParameters: EntitTye[];
    ParameterTypes: IParameterType[];
}

Visual Basic

interface MethodCall
{
    Name: string;
    DefinitionClassName: string;
    LocationClassName: string;
    MethodDefinitionNames: string[];
    GenericParameters: EntitTye[];
    ParameterTypes: IParameterType[];
}

Local Variable

C#

interface LocalVariable
{
    Name: string;
    Type: IEntityType;
    Modifier: string;
    IsNullable: bool;
}

Visual Basic

interface LocalVariable
{
    Name: string;
    Type: IEntityType;
    Modifier: string;
    IsNullable: bool;
}

Metric Model

interface MetricModel
{
    Name: string;
    ExtractorName: string;
    ValueType: string;
    Value?: object;
}

Lines of Code

interface LinesOfCode
{
    SourceLines: number;
    CommentedLines: number;
    EmptyLines: number;
}