org.apache.uima.tools

Class RunAE

java.lang.Object

org.apache.uima.tools.RunAE

All Implemented Interfaces:

org.apache.uima.collection.base_cpm.BaseStatusCallbackListener, org.apache.uima.collection.StatusCallbackListener

public class RunAE
extends Object
implements org.apache.uima.collection.StatusCallbackListener

An example application that reads documents from the file system, sends them though an Analysis Engine(AE), and produces XML files with inline annotations. This application uses a 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

Constructor and Description
RunAE(String[] args) Constructor.

Method Summary

Modifier and Type	Method and Description
void	aborted() Aborted.
void	batchProcessComplete() Batch process complete.
void	collectionProcessComplete() Collection process complete.
void	entityProcessComplete(org.apache.uima.cas.CAS aCas, org.apache.uima.collection.EntityProcessStatus aStatus) Entity process complete.
void	initializationComplete() Initialization complete.
static void	main(String[] args) The main method.
void	paused() Paused.
void	resumed() Resumed.

Methods inherited from class java.lang.Object

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

Constructor Detail

RunAE

public RunAE(String[] args)

Constructor. Sets up and runs an Analysis Engine.

Parameters:

args - the args

Method Detail

initializationComplete

public void initializationComplete()

Initialization complete.

Specified by:

initializationComplete in interface org.apache.uima.collection.base_cpm.BaseStatusCallbackListener

See Also:

BaseStatusCallbackListener.initializationComplete()

entityProcessComplete

public void entityProcessComplete(org.apache.uima.cas.CAS aCas,
                                  org.apache.uima.collection.EntityProcessStatus aStatus)

Entity process complete.

Specified by:

entityProcessComplete in interface org.apache.uima.collection.StatusCallbackListener

Parameters:

aCas - the a cas

aStatus - the a status

See Also:

StatusCallbackListener.entityProcessComplete(org.apache.uima.cas.CAS, org.apache.uima.collection.EntityProcessStatus)

aborted

public void aborted()

Aborted.

Specified by:

aborted in interface org.apache.uima.collection.base_cpm.BaseStatusCallbackListener

See Also:

BaseStatusCallbackListener.aborted()

batchProcessComplete

public void batchProcessComplete()

Batch process complete.

Specified by:

batchProcessComplete in interface org.apache.uima.collection.base_cpm.BaseStatusCallbackListener

See Also:

BaseStatusCallbackListener.batchProcessComplete()

collectionProcessComplete

public void collectionProcessComplete()

Collection process complete.

Specified by:

collectionProcessComplete in interface org.apache.uima.collection.base_cpm.BaseStatusCallbackListener

See Also:

BaseStatusCallbackListener.collectionProcessComplete()

paused

public void paused()

Paused.

Specified by:

paused in interface org.apache.uima.collection.base_cpm.BaseStatusCallbackListener

See Also:

BaseStatusCallbackListener.paused()

resumed

public void resumed()

Resumed.

Specified by:

resumed in interface org.apache.uima.collection.base_cpm.BaseStatusCallbackListener

See Also:

BaseStatusCallbackListener.resumed()

main

public static void main(String[] args)

The main method.

Parameters:

args - the arguments