gov.va.vinci.leo.listener

Class SimpleXmiListener

java.lang.Object

org.apache.uima.aae.client.UimaAsBaseCallbackListener

gov.va.vinci.leo.listener.BaseListener

gov.va.vinci.leo.listener.SimpleXmiListener

All Implemented Interfaces:

org.apache.uima.aae.client.UimaASStatusCallbackListener

public class SimpleXmiListener
extends BaseListener

Store processed CAS objects in XMI files then launch the AnnotationViewer once collection processing is complete.

Author:

thomasginter

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	launchAnnotationViewer Flag to launch annotation viewer when processing is complete.
static org.apache.log4j.Logger	log Logging object of output.
static String	TYPE_DESCRIPTION_NAME Name of the type system description which this listener will serialize if the typeSystemDescriptor is set.
protected File	typeDescriptionFile File pointer to the serialized type description.
protected LeoTypeSystemDescription	typeSystemDescriptor Path to the type system descriptor or aggregate descriptor file for the service.

Fields inherited from class gov.va.vinci.leo.listener.BaseListener

annotationTypeFilter, docInfo, exitOnError, inputType, lastException, LOG, logErrors, mOutputDir, numReceived, numSent, previousReferenceId, referenceID

Constructor Summary

Constructors

Constructor and Description
SimpleXmiListener(File outputDir) Constructor with output directory input.

Method Summary

Modifier and Type	Method and Description
void	collectionProcessComplete(org.apache.uima.collection.EntityProcessStatus aStatus)
void	entityProcessComplete(org.apache.uima.cas.CAS aCas, org.apache.uima.collection.EntityProcessStatus aStatus)
LeoTypeSystemDescription	getTypeSystemDescriptor() Get the type system or aggregate descriptor File reference that this listener will set in the viewer if launched.
boolean	isLaunchAnnotationViewer() True if the annotation viewer should be launched after processing is complete, else false.
protected void	launchAnnotationViewer() Launch the UIMA annotation viewer.
SimpleXmiListener	setLaunchAnnotationViewer(boolean launchAnnotationViewer) Set the value of launch annotation viewer.
SimpleXmiListener	setTypeSystemDescriptor(File typeSystemDescriptor) Set the type system descriptor File reference that this listener will set in the viewer if launched.
SimpleXmiListener	setTypeSystemDescriptor(LeoTypeSystemDescription typeSystemDescriptor) Set the type system description this listener will serialize into the output directory.

Methods inherited from class gov.va.vinci.leo.listener.BaseListener

checkForError, entityProcessError, getAnnotationTypeFilter, getInputType, getInputTypesList, getNumReceived, getNumSent, getOutputDir, getReferenceLocation, hasAnnotationsToProcess, hasFilteredAnnotation, initializationComplete, isExitOnError, isLogErrors, onBeforeMessageSend, setAnnotationTypeFilter, setExitOnError, setInputType, setLogErrors, setOutputDir

Methods inherited from class org.apache.uima.aae.client.UimaAsBaseCallbackListener

onBeforeProcessCAS, onBeforeProcessMeta, onUimaAsServiceExit

Methods inherited from class java.lang.Object

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

Field Detail

launchAnnotationViewer

protected boolean launchAnnotationViewer

Flag to launch annotation viewer when processing is complete.

typeSystemDescriptor

protected LeoTypeSystemDescription typeSystemDescriptor

Path to the type system descriptor or aggregate descriptor file for the service.

typeDescriptionFile

protected File typeDescriptionFile

File pointer to the serialized type description.

TYPE_DESCRIPTION_NAME

public static final String TYPE_DESCRIPTION_NAME

Name of the type system description which this listener will serialize if the typeSystemDescriptor is set.

See Also:

Constant Field Values

log

public static final org.apache.log4j.Logger log

Logging object of output.

Constructor Detail

SimpleXmiListener

public SimpleXmiListener(File outputDir)

Constructor with output directory input.

Parameters:

outputDir - the directory to write the final xmi files to.

Method Detail

getTypeSystemDescriptor

public LeoTypeSystemDescription getTypeSystemDescriptor()

Get the type system or aggregate descriptor File reference that this listener will set in the viewer if launched.

Returns:

leo type system description

setTypeSystemDescriptor

public SimpleXmiListener setTypeSystemDescriptor(File typeSystemDescriptor)
                                          throws Exception

Set the type system descriptor File reference that this listener will set in the viewer if launched.

Parameters:

typeSystemDescriptor - type system descriptor file reference

Returns:

reference to this listener instance

Throws:

Exception

setTypeSystemDescriptor

public SimpleXmiListener setTypeSystemDescriptor(LeoTypeSystemDescription typeSystemDescriptor)

Set the type system description this listener will serialize into the output directory.

Parameters:

typeSystemDescriptor - type system descriptor to set

Returns:

reference to this listener instance

isLaunchAnnotationViewer

public boolean isLaunchAnnotationViewer()

True if the annotation viewer should be launched after processing is complete, else false.

Returns:

True if the annotation viewer should be launched after processing is complete, else false.

setLaunchAnnotationViewer

public SimpleXmiListener setLaunchAnnotationViewer(boolean launchAnnotationViewer)

Set the value of launch annotation viewer. If true, when collectionProcessComplete is finished, the annotation view will be launched.

Parameters:

launchAnnotationViewer - True if the annotation viewer should be launched after processing is complete, else false.

Returns:

reference to this listener instance

entityProcessComplete

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

Specified by:

entityProcessComplete in interface org.apache.uima.aae.client.UimaASStatusCallbackListener

Overrides:

entityProcessComplete in class BaseListener

Parameters:

aCas - the CAS containing the processed entity and the analysis results

aStatus - the status of the processing. This object contains a record of any Exception that occurred, as well as timing information.

See Also:

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

collectionProcessComplete

public void collectionProcessComplete(org.apache.uima.collection.EntityProcessStatus aStatus)

Specified by:

collectionProcessComplete in interface org.apache.uima.aae.client.UimaASStatusCallbackListener

Overrides:

collectionProcessComplete in class BaseListener

Parameters:

aStatus - the status of the processing. This object contains a record of any Exception that occurred, as well as timing information.

See Also:

UimaAsBaseCallbackListener.collectionProcessComplete(org.apache.uima.collection.EntityProcessStatus)

launchAnnotationViewer

protected void launchAnnotationViewer()

Launch the UIMA annotation viewer.