org.apache.uima.test.junit_extension

Class AnnotatorTester

java.lang.Object

org.apache.uima.test.junit_extension.AnnotatorTester

public class AnnotatorTester
extends Object

AnnotatorTester is the helper class to test annotators.

Constructor Summary

Constructors

Constructor and Description
AnnotatorTester(File descFile) Constructor save the specified descriptor file path and initialize the analysis engine.
AnnotatorTester(String descFilePath) Constructor save the specified descriptor file path and initialize the analysis engine.
AnnotatorTester(String descFilePath, ResourceManager mgr) Constructor save the specified descriptor file path and initialize the analysis engine.

Method Summary

Modifier and Type	Method and Description
void	changeDelegateParameterSetting(String delegeteKey, String groupName, String paramName, Object paramValue) change the parameter name for the given delegate analysis engine key
void	changeParameterSetting(String groupName, String paramName, Object paramValue) change the parameter name for the given analysis engine
static void	checkResult(CAS cas, String[] AnnotationTypes, File refFile, File testFile) checkResult compares the analyzed document with the reference output.
CAS	createCAS() Creates a new fresh CAS instance which can be used for testing.
static AnalysisEngine	doConfigurationTest(String configDescFilePath) does configuration parameter test
static CAS	getCASfromXCAS(File tsFile, File xcasFile) create a CAS object from the given XCAS and typesystem files
CAS	performTest(CAS cas) performs a test on the initialized annotator.
CAS	performTest(String text, String language) performs a test on the initialized annotator.
static CAS	performTest(String descFilePath, String text, String language) performs a test with a special annotator configuration.
static String	readFileContent(File file, String encoding) Reads the content form a file to a String with respect to the file encoding.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnnotatorTester

public AnnotatorTester(String descFilePath)
                throws Exception

Constructor save the specified descriptor file path and initialize the analysis engine.

Parameters:

descFilePath - descriptor file path

Throws:

Exception - passthru if an analysis engine initialize error occurs.

AnnotatorTester

public AnnotatorTester(File descFile)
                throws Exception

Constructor save the specified descriptor file path and initialize the analysis engine.

Parameters:

descFile - descriptor file

Throws:

Exception - passthru if an analysis engine initialize error occurs.

AnnotatorTester

public AnnotatorTester(String descFilePath,
                       ResourceManager mgr)
                throws Exception

Constructor save the specified descriptor file path and initialize the analysis engine.

Parameters:

descFilePath - descriptor file path

mgr - a ResourceManager

Throws:

Exception - if an analysis engine initialize error occurs.

Method Detail

changeParameterSetting

public void changeParameterSetting(String groupName,
                                   String paramName,
                                   Object paramValue)
                            throws ResourceConfigurationException

change the parameter name for the given analysis engine

Parameters:

groupName - group name, if no group is available, pass null

paramName - parameter name

paramValue - parameter value

Throws:

ResourceConfigurationException - passthru

changeDelegateParameterSetting

public void changeDelegateParameterSetting(String delegeteKey,
                                           String groupName,
                                           String paramName,
                                           Object paramValue)
                                    throws InvalidXMLException,
                                           ResourceInitializationException,
                                           IOException

change the parameter name for the given delegate analysis engine key

Parameters:

delegeteKey - analysis engine key

groupName - group name

paramName - parameter name

paramValue - parameter value

Throws:

InvalidXMLException - passthru

ResourceInitializationException - passthru

IOException - passthru

doConfigurationTest

public static AnalysisEngine doConfigurationTest(String configDescFilePath)
                                          throws Exception

does configuration parameter test

Parameters:

configDescFilePath -

Returns:

AnalysisEngine

Throws:

Exception - passthru

createCAS

public CAS createCAS()
              throws Exception

Creates a new fresh CAS instance which can be used for testing.

Returns:

a new fresh CAS instance which can be used for testing

Throws:

Exception - passthru

performTest

public CAS performTest(String text,
                       String language)
                throws Exception

performs a test on the initialized annotator. The specified document is processed with the given language.

Parameters:

text - a document text

language - the document text language

Returns:

CAS - results of the analysis

Throws:

Exception - passthru

performTest

public CAS performTest(CAS cas)
                throws Exception

performs a test on the initialized annotator. The specified CAS is processed and the results are returned.

Parameters:

cas - a CAS for processing

Returns:

CAS - results of the analysis

Throws:

Exception - passthru

performTest

public static CAS performTest(String descFilePath,
                              String text,
                              String language)
                       throws Exception

performs a test with a special annotator configuration. For this a new AE is created and used to process the specified document for the specified language.

Parameters:

descFilePath - Descriptor file path

text - a document text

language - the document text language

Returns:

CAS - results of the analysis

Throws:

Exception - passthru

getCASfromXCAS

public static CAS getCASfromXCAS(File tsFile,
                                 File xcasFile)
                          throws Exception

create a CAS object from the given XCAS and typesystem files

Parameters:

tsFile - - a typesystem file

xcasFile - - a xcas file

Returns:

CAS - CAS object created from the given input data

Throws:

Exception - passthru

readFileContent

public static String readFileContent(File file,
                                     String encoding)
                              throws Exception

Reads the content form a file to a String with respect to the file encoding.

Parameters:

file - a file with the source

encoding - file encoding

Returns:

String - file content

Throws:

Exception - passthru

checkResult

public static void checkResult(CAS cas,
                               String[] AnnotationTypes,
                               File refFile,
                               File testFile)
                        throws Exception

checkResult compares the analyzed document with the reference output.

Parameters:

cas - a cas with the analyzed data

AnnotationTypes - respected annotation types

refFile - reference output

testFile - test file for the current output

Throws:

Exception - passthru