|
Traceability | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecttte.impl.Engine
public class Engine
Field Summary | |
---|---|
static java.lang.String |
ANALYZER_EXT_POINT_ID
id of the documentAnalyzers extension point. |
static java.lang.String |
DEFAULT_ANALYZER_DEFAULT_CONVERSION_METHOD_ID
id of the default conversion method of the default documentAnalyzers extension. |
static java.lang.String |
DEFAULT_ANALYZER_DEFAULT_EDITION_METHOD_ID
id of the default edition method of the default documentAnalyzers extension. |
static java.lang.String |
DEFAULT_ANALYZER_ID
id of the default documentAnalyzers extension. |
Constructor Summary | |
---|---|
Engine()
Creates a new instance of Engine. |
Method Summary | |
---|---|
static void |
cleanCachedElements()
Cleans static elements that are in cache. |
void |
editElement(Element element)
|
static ExtendedAnalyzer[] |
getAnalyzers()
Gets analyzers from extensions to DocumentAnalyzer extension point. |
static ExtendedAnalyzer |
getAnalyzerWithID(java.lang.String anID)
Gets analyzer from extensions to DocumentAnalyzer extension point which id is given in parameter. |
java.lang.String |
getProjectFilename()
|
static ExtendedRule[] |
getRules(Project aProject)
gets the rules availables from extensions to RulesSet extension point and add them to the project rule definition. |
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 outputFileStr)
|
void |
printRulesReport(Project aProject,
java.lang.String outputFileStr)
|
void |
reloadProject(Project aProject)
|
void |
reloadProjectForcing(Project aProject,
java.lang.Boolean update)
|
static java.util.Map<java.lang.String,java.lang.Object> |
ttmMap()
Gets the Map needed for the emf xml saved format. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ANALYZER_EXT_POINT_ID
public static final java.lang.String DEFAULT_ANALYZER_ID
public static final java.lang.String DEFAULT_ANALYZER_DEFAULT_CONVERSION_METHOD_ID
public static final java.lang.String DEFAULT_ANALYZER_DEFAULT_EDITION_METHOD_ID
Constructor Detail |
---|
public Engine()
Method Detail |
---|
public static java.util.Map<java.lang.String,java.lang.Object> ttmMap()
public static void cleanCachedElements()
public final java.lang.String getProjectFilename()
getProjectFilename
in interface IEngine
IEngine.getProjectFilename()
public final void newProject(java.lang.String filename) throws ProjectFileAlreadyDefinedException, CannotCreateProjectFileException
newProject
in interface IEngine
filename
- that will contain the traceability project structure
ProjectFileAlreadyDefinedException
- indicates the project that
the user want to create already exists
CannotCreateProjectFileException
- indicates that an exception
occured during the project creationIEngine.newProject(java.lang.String)
public final void newProjectWithOverwrite(java.lang.String filename) throws ProjectFileAlreadyDefinedException, CannotCreateProjectFileException
newProjectWithOverwrite
in interface IEngine
filename
- that will contain the traceability project structure
ProjectFileAlreadyDefinedException
- indicates the project that
the user want to create already exists
CannotCreateProjectFileException
- indicates that an exception
occured during the project creation{@inheritDoc}
public final void reloadProject(Project aProject) throws FilesNeedToBeReloadException, ResourceLoadingException, MustBeTTMKindFileException, AnalysisException
reloadProject
in interface IEngine
FilesNeedToBeReloadException
- indicates that some files in project
have changed since the last reloading action
ResourceLoadingException
- indicates the loading
of resource failed
MustBeTTMKindFileException
- indicates that the extension of
filename in parameter is wrong
AnalysisException
- indicates that exceptions occured
during project analysistte.IEngine#reloadProject(java.lang.String)
public final void reloadProjectForcing(Project aProject, java.lang.Boolean update) throws ResourceLoadingException, MustBeTTMKindFileException, AnalysisException
reloadProjectForcing
in interface IEngine
update
- boolean indicates if the user want to update modified file
during reloading action
ResourceLoadingException
- indicates the loading
of resource failed
MustBeTTMKindFileException
- indicates that the extension of
filename in parameter is wrong
AnalysisException
- indicates that exceptions occured
during project analysistte.IEngine#reloadProjectForcing(java.lang.String,
java.lang.Boolean)
public final void editElement(Element element) throws EditionException, AnalyzerMethodException
EditionException
AnalyzerMethodException
public final void printReport(Project aProject, java.lang.String outputFileStr) throws ReportGenerationException, MustBeTTMKindFileException
printReport
in interface IEngine
ReportGenerationException
- indicates that some exception occured
during report generation
MustBeTTMKindFileException
- indicates that the extension of
filename in parameter is wrongtte.IEngine#printReport(java.lang.String)
public final void printRulesReport(Project aProject, java.lang.String outputFileStr) throws ReportGenerationException, MustBeTTMKindFileException
printRulesReport
in interface IEngine
ReportGenerationException
- indicates that some exception occured
during report generation
MustBeTTMKindFileException
- indicates that the extension of
filename in parameter is wrongtte.IEngine#printRulesReport(java.lang.String)
public static ExtendedRule[] getRules(Project aProject)
aProject
- is the project in which rules definition will be added
public static ExtendedAnalyzer getAnalyzerWithID(java.lang.String anID)
anID
- is the id of the analyzer requested
public static ExtendedAnalyzer[] getAnalyzers()
|
Traceability | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) 2005 TOPCASED Contributors 2005 - 2007. All rights reserved.