org.apache.ctakes.utils.test

Class TestUtil

java.lang.Object

org.apache.ctakes.utils.test.TestUtil

public class TestUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	unexpectedParamValueMsg

Constructor Summary

Constructors

Constructor and Description
TestUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static AnalysisEngine	getAE(java.io.File analysisEngineDescriptorFile)
static CollectionReader	getCR(java.io.File collectionReaderDescriptorFile)
static <T extends TOP> T	getFeatureStructureAtIndex(JCas jCas, java.lang.Class<T> cls, int index)
static <T extends TOP> int	getFeatureStructureSize(JCas jCas, java.lang.Class<T> cls)
static JCas	processAE(AnalysisEngine ae, java.io.File textFile) This method simply calls #createAnalysisEngineJCas(File, File, String) with the charSetName equal to "UTF-8".
static JCas	processAE(AnalysisEngine ae, java.io.File textFile, java.lang.String charSetName) This method reads in the text from the text file using the provided character set and then calls #getJCas(File, String)
static JCas	processAE(AnalysisEngine ae, java.lang.String text) This method creates a JCas for the provided analysis engine descriptor file and then processes the provided text and returns the JCas.
static void	testConfigParam(UimaContext uimaContext, java.lang.String descriptorFile, java.lang.String paramName, java.lang.Object paramValue)
static void	testConfigParam(UimaContext uimaContext, java.lang.String descriptorFile, java.lang.String paramName, java.lang.Object paramValue, java.lang.Integer arrayIndex)

Methods inherited from class java.lang.Object

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

Field Detail

unexpectedParamValueMsg

static java.lang.String unexpectedParamValueMsg

Constructor Detail

TestUtil

public TestUtil()

Method Detail

processAE

public static JCas processAE(AnalysisEngine ae,
             java.io.File textFile)
                      throws ResourceInitializationException

This method simply calls #createAnalysisEngineJCas(File, File, String) with the charSetName equal to "UTF-8".

Parameters:

analysisEngineDescriptorFile - a descriptor file for a UIMA Analysis Engine.

textFile - a file that contains text that the analysis engine will process.

Returns:

a JCas that represents the analysis engine's processing of the text file.

Throws:

ResourceInitializationException

See Also:

#createAnalysisEngineJCas(File, File, String)}

processAE

public static JCas processAE(AnalysisEngine ae,
             java.io.File textFile,
             java.lang.String charSetName)
                      throws ResourceInitializationException

This method reads in the text from the text file using the provided character set and then calls #getJCas(File, String)

Parameters:

analysisEngineDescriptorFile - a descriptor file for a UIMA Analysis Engine.

textFile - a file that contains text that the analysis engine will process.

charSetName - the name of the character encoding of the file

Returns:

a JCas that represents the analysis engine's processing of the text file.

Throws:

ResourceInitializationException

See Also:

#getJCas(File, String)}, Charset

processAE

public static JCas processAE(AnalysisEngine ae,
             java.lang.String text)
                      throws ResourceInitializationException

This method creates a JCas for the provided analysis engine descriptor file and then processes the provided text and returns the JCas. This method is convenient for unit testing because the first line of a unit test can be.

 JCas jCas = createAnalysisEngineJCas(someAEDescriptorFile, someText);
 

The subsequent lines can then be assertions that query the expected contents of the JCas.

Parameters:

analysisEngineDescriptorFile - a descriptor file for a UIMA Analysis Engine.

text - text that the analysis engine will process.

Returns:

a JCas that represents the analysis engine's processing of the text file.

Throws:

ResourceInitializationException - The code for this method was found here: http://article.gmane.org/gmane.comp.apache.uima.general/880/match=push+documents+into+cpe+collectionreader

getAE

public static AnalysisEngine getAE(java.io.File analysisEngineDescriptorFile)
                            throws ResourceInitializationException

Throws:

ResourceInitializationException

getCR

public static CollectionReader getCR(java.io.File collectionReaderDescriptorFile)
                              throws ResourceInitializationException

Throws:

ResourceInitializationException

getFeatureStructureSize

public static <T extends TOP> int getFeatureStructureSize(JCas jCas,
                                          java.lang.Class<T> cls)

getFeatureStructureAtIndex

public static <T extends TOP> T getFeatureStructureAtIndex(JCas jCas,
                                           java.lang.Class<T> cls,
                                           int index)

testConfigParam

public static void testConfigParam(UimaContext uimaContext,
                   java.lang.String descriptorFile,
                   java.lang.String paramName,
                   java.lang.Object paramValue)

testConfigParam

public static void testConfigParam(UimaContext uimaContext,
                   java.lang.String descriptorFile,
                   java.lang.String paramName,
                   java.lang.Object paramValue,
                   java.lang.Integer arrayIndex)