Traceability

tte
Interface IEngine

All Known Implementing Classes:
Engine

public interface IEngine

The Factory interface. provides some methods to interact with the TopCased Traceability Tool model

See Also:
org.topcased.traceability

Method Summary
 java.lang.String getProjectFilename()
           
 void newProject(java.lang.String filename)
          Creates a new project in the filename passed in parameter.
 void newProjectWithOverwrite(java.lang.String filename)
           
 void printReport(Project aProject, java.lang.String outputStr)
           
 void printRulesReport(Project aProject, java.lang.String outputStr)
           
 void reloadProject(Project aProject)
           
 void reloadProjectForcing(Project aProject, java.lang.Boolean update)
           
 

Method Detail

newProject

void newProject(java.lang.String filename)
                throws ProjectFileAlreadyDefinedException,
                       CannotCreateProjectFileException
Creates a new project in the filename passed in parameter.

Parameters:
filename - that will contain the traceability project structure
Throws:
ProjectFileAlreadyDefinedException - indicates the project that the user want to create already exists
CannotCreateProjectFileException - indicates that an exception occured during the project creation

newProjectWithOverwrite

void newProjectWithOverwrite(java.lang.String filename)
                             throws ProjectFileAlreadyDefinedException,
                                    CannotCreateProjectFileException
Parameters:
filename - that will contain the traceability project structure
Throws:
ProjectFileAlreadyDefinedException - indicates the project that the user want to create already exists
CannotCreateProjectFileException - indicates that an exception occured during the project creation

getProjectFilename

java.lang.String getProjectFilename()
Returns:
filename of the project

reloadProject

void reloadProject(Project aProject)
                   throws FilesNeedToBeReloadException,
                          ResourceLoadingException,
                          MustBeTTMKindFileException,
                          AnalysisException
Parameters:
the - project the user want to reload
Throws:
FilesNeedToBeReloadException - indicates that some files in project have changed since the last reloading action
ResourceLoadingException - indicates the loading of resource failed
AnalysisException - indicates that exceptions occured during project analysis
MustBeTTMKindFileException - indicates that the extension of filename in parameter is wrong

reloadProjectForcing

void reloadProjectForcing(Project aProject,
                          java.lang.Boolean update)
                          throws ResourceLoadingException,
                                 MustBeTTMKindFileException,
                                 AnalysisException
Parameters:
the - project the user want to reload
update - boolean indicates if the user want to update modified file during reloading action
Throws:
ResourceLoadingException - indicates the loading of resource failed
AnalysisException - indicates that exceptions occured during project analysis
MustBeTTMKindFileException - indicates that the extension of filename in parameter is wrong

printReport

void printReport(Project aProject,
                 java.lang.String outputStr)
                 throws ReportGenerationException,
                        MustBeTTMKindFileException
Parameters:
the - project which report the user want to produce
Throws:
MustBeTTMKindFileException - indicates that the extension of filename in parameter is wrong
ReportGenerationException - indicates that some exception occured during report generation

printRulesReport

void printRulesReport(Project aProject,
                      java.lang.String outputStr)
                      throws ReportGenerationException,
                             MustBeTTMKindFileException
Parameters:
the - project which report the user want to produce
Throws:
MustBeTTMKindFileException - indicates that the extension of filename in parameter is wrong
ReportGenerationException - indicates that some exception occured during report generation

Traceability

Copyright (c) 2005 TOPCASED Contributors 2005 - 2007. All rights reserved.