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.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaborted()Called when the processing has been aborted.voidCalled when the processing of a batch has completed.voidCalled when the processing of an entire collection has completed.voidentityProcessComplete(CAS aCas, EntityProcessStatus aStatus) Called when the processing of each entity has completed.voidCalled when the Collection Processing Manager's initialization has completed.static voidvoidpaused()Called when the processing has been paused.voidresumed()Called when the processing has been resumed (after it had been previously paused).
-
Constructor Details
-
RunAE
Constructor. Sets up and runs an Analysis Engine.
-
-
Method Details
-
initializationComplete
public void initializationComplete()Description copied from interface:BaseStatusCallbackListenerCalled when the Collection Processing Manager's initialization has completed.- Specified by:
initializationCompletein interfaceBaseStatusCallbackListener- See Also:
-
entityProcessComplete
Description copied from interface:StatusCallbackListenerCalled when the processing of each entity has completed.- Specified by:
entityProcessCompletein interfaceStatusCallbackListener- Parameters:
aCas- the CAS containing the processed entity and the analysis resultsaStatus- the status of the processing. This object contains a record of any Exception that occurred, as well as timing information.- See Also:
-
aborted
public void aborted()Description copied from interface:BaseStatusCallbackListenerCalled when the processing has been aborted.- Specified by:
abortedin interfaceBaseStatusCallbackListener- See Also:
-
batchProcessComplete
public void batchProcessComplete()Description copied from interface:BaseStatusCallbackListenerCalled when the processing of a batch has completed.- Specified by:
batchProcessCompletein interfaceBaseStatusCallbackListener- See Also:
-
collectionProcessComplete
public void collectionProcessComplete()Description copied from interface:BaseStatusCallbackListenerCalled when the processing of an entire collection has completed.- Specified by:
collectionProcessCompletein interfaceBaseStatusCallbackListener- See Also:
-
paused
public void paused()Description copied from interface:BaseStatusCallbackListenerCalled when the processing has been paused.- Specified by:
pausedin interfaceBaseStatusCallbackListener- See Also:
-
resumed
public void resumed()Description copied from interface:BaseStatusCallbackListenerCalled when the processing has been resumed (after it had been previously paused).- Specified by:
resumedin interfaceBaseStatusCallbackListener- See Also:
-
main
-