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 File
The ae specifier file.(package private) int
The docs processed.private String
The encoding.private boolean
The gen progress messages.private File
The input dir.private String
The language.private CollectionProcessingEngine
The m CPE.private File
The output dir.private int
The stats level.private boolean
The xcas input.private boolean
The x lenient.private boolean
The xmi input.private String
The xml tag name. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
aborted()
Aborted.void
Batch process complete.void
Collection process complete.void
entityProcessComplete
(CAS aCas, EntityProcessStatus aStatus) Entity process complete.void
Initialization complete.static void
The main method.void
paused()
Paused.private void
Prints usage message.private boolean
processCmdLineArgs
(String[] args) Reads command line arguments and sets static class variables appropriately.void
resumed()
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:
initializationComplete
in interfaceBaseStatusCallbackListener
- See Also:
-
entityProcessComplete
Entity process complete.- Specified by:
entityProcessComplete
in interfaceStatusCallbackListener
- Parameters:
aCas
- the a casaStatus
- the a status- See Also:
-
aborted
public void aborted()Aborted.- Specified by:
aborted
in interfaceBaseStatusCallbackListener
- See Also:
-
batchProcessComplete
public void batchProcessComplete()Batch process complete.- Specified by:
batchProcessComplete
in interfaceBaseStatusCallbackListener
- See Also:
-
collectionProcessComplete
public void collectionProcessComplete()Collection process complete.- Specified by:
collectionProcessComplete
in interfaceBaseStatusCallbackListener
- See Also:
-
paused
public void paused()Paused.- Specified by:
paused
in interfaceBaseStatusCallbackListener
- See Also:
-
resumed
public void resumed()Resumed.- Specified by:
resumed
in 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
-