Traceability

tte.analyzers
Interface IAnalyzer

All Known Implementing Classes:
DefaultAnalyzer, OpenOfficeAnalyzer

public interface IAnalyzer

Interface the must be implemented to develop an owningClass for a documentAnalyzer extension.


Method Summary
 void executeConversionMethodID(java.lang.String id, java.io.File inFile, java.io.File outFile, java.lang.String conversionDefaultArguments, Document document)
          Runs the conversion of the method which id is in parameter.
 void executeEditionMethodID(java.lang.String id, Document document, Element element)
          Runs the edition method which id is in parameter.
 

Method Detail

executeConversionMethodID

void executeConversionMethodID(java.lang.String id,
                               java.io.File inFile,
                               java.io.File outFile,
                               java.lang.String conversionDefaultArguments,
                               Document document)
                               throws AnalyzerMethodException,
                                      ConversionException
Runs the conversion of the method which id is in parameter.

Parameters:
id - is the method id
inFile - is the source file
outFile - is the file that will contains the result of conversion
conversionDefaultArguments - is a string tha represents common arguments from the conversion Method declaration
documentSpecificArguments - is the string that represents the arguments added to the document properties that will be understood by the conversion method (can be null)
the - document that will be converted
Throws:
AnalyzerMethodException - if an exception occurs during instanciation of OwningClass
ConversionException - if an occurs during the conversion

executeEditionMethodID

void executeEditionMethodID(java.lang.String id,
                            Document document,
                            Element element)
                            throws AnalyzerMethodException,
                                   EditionException
Runs the edition method which id is in parameter.

Parameters:
the - id of executed method
the - document that will be edited
the - element that be searched
Throws:
AnalyzerMethodException - if an exception occurs during instanciation of OwningClass
EditionException - if an occurs during the conversion

Traceability

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