Class RunAE
- All Implemented Interfaces:
BaseStatusCallbackListener,StatusCallbackListener
CollectionProcessingEngine to drive the processing. For a simpler introduction to using
AEs in an application, see class ExampleApplication in the uimaj-examples project.
Usage: java org.apache.uima.examples.RunAE [OPTIONS]
<AE descriptor or JAR file name> <input dir>
[<output dir>]
If output dir is not specified, the analysis results will not be output. This can be
useful when only interested in performance statistics.
OPTIONS
-t <TagName> (XML Text Tag) - specifies the name of an XML tag, found within the input
documents, that contains the text to be analyzed. The text will also be detagged. If this option
is not specified, the entire document will be processed.
-l <ISO code> (Language) - specifies the ISO code for the language of the input documents.
Some AEs (e.g. PersonTitleAnnotator) require this.
-e <Encoding> - specifies character encoding of the input documents. The default is UTF-8.
-q (Quiet) - supresses progress messages that are normally printed as each document is processed.
-s<x> (Stats level) - determines the verboseness of performance statistics. s0=none,
s1=brief, s2=full. The default is brief.
-x - process input files as XCAS files.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate FileThe ae specifier file.(package private) intThe docs processed.private StringThe encoding.private booleanThe gen progress messages.private FileThe input dir.private StringThe language.private CollectionProcessingEngineThe m CPE.private FileThe output dir.private intThe stats level.private booleanThe xcas input.private booleanThe x lenient.private booleanThe xmi input.private StringThe xml tag name. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaborted()Aborted.voidBatch process complete.voidCollection process complete.voidentityProcessComplete(CAS aCas, EntityProcessStatus aStatus) Entity process complete.voidInitialization complete.static voidThe main method.voidpaused()Paused.private voidPrints usage message.private booleanprocessCmdLineArgs(String[] args) Reads command line arguments and sets static class variables appropriately.voidresumed()Resumed.
-
Field Details
-
aeSpecifierFile
The ae specifier file. -
inputDir
The input dir. -
outputDir
The output dir. -
xmlTagName
The xml tag name. -
language
The language. -
encoding
The encoding. -
genProgressMessages
private boolean genProgressMessagesThe gen progress messages. -
statsLevel
private int statsLevelThe stats level. -
xcasInput
private boolean xcasInputThe xcas input. -
xmiInput
private boolean xmiInputThe xmi input. -
xLenient
private boolean xLenientThe x lenient. -
docsProcessed
int docsProcessedThe docs processed. -
mCPE
The m CPE.
-
-
Constructor Details
-
RunAE
Constructor. Sets up and runs an Analysis Engine.- Parameters:
args- the args
-
-
Method Details
-
initializationComplete
public void initializationComplete()Initialization complete.- Specified by:
initializationCompletein interfaceBaseStatusCallbackListener- See Also:
-
entityProcessComplete
Entity process complete.- Specified by:
entityProcessCompletein interfaceStatusCallbackListener- Parameters:
aCas- the a casaStatus- the a status- See Also:
-
aborted
public void aborted()Aborted.- Specified by:
abortedin interfaceBaseStatusCallbackListener- See Also:
-
batchProcessComplete
public void batchProcessComplete()Batch process complete.- Specified by:
batchProcessCompletein interfaceBaseStatusCallbackListener- See Also:
-
collectionProcessComplete
public void collectionProcessComplete()Collection process complete.- Specified by:
collectionProcessCompletein interfaceBaseStatusCallbackListener- See Also:
-
paused
public void paused()Paused.- Specified by:
pausedin interfaceBaseStatusCallbackListener- See Also:
-
resumed
public void resumed()Resumed.- Specified by:
resumedin interfaceBaseStatusCallbackListener- See Also:
-
printUsageMessage
private void printUsageMessage()Prints usage message. -
processCmdLineArgs
Reads command line arguments and sets static class variables appropriately.- Parameters:
args- the args- Returns:
- true if command line args were valid, false if not
-
main
The main method.- Parameters:
args- the arguments
-