BaseListener (Leo Parent Project 2018.01.0 API)

java.lang.Object
- org.apache.uima.aae.client.UimaAsBaseCallbackListener
- - gov.va.vinci.leo.listener.BaseListener

All Implemented Interfaces:

org.apache.uima.aae.client.UimaASStatusCallbackListener

Direct Known Subclasses:

BaseCsvListener, BaseDatabaseListener, SimpleXmiListener
```
public abstract class BaseListener
extends org.apache.uima.aae.client.UimaAsBaseCallbackListener
```
BaseListener class that other listeners can extend from to add default functionality commonly used.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String[]`	`annotationTypeFilter` the annotation types to filter on.
`protected CSI`	`docInfo` CSI annotation for the document being processed in an entityProcessComplete event.
`protected boolean`	`exitOnError` Flag to indicate whether or not entityProcessComplete processing should terminate when exceptions are received from the service.
`protected String[]`	`inputType` The list of input types to save to the database.
`protected String`	`lastException` Exceptions Received from service via entityProcessComplete event.
`protected org.apache.log4j.Logger`	`LOG` Logging object of output.
`protected boolean`	`logErrors` If true, the base listener will log errors via log4j.
`protected File`	`mOutputDir` Output Directory for this gov.va.vinci.leo.listener output if required.
`protected int`	`numReceived` Number of CAS objects returned from the pipeline.
`protected int`	`numSent` Number of CAS objects sent to the service for processing.
`protected String`	`previousReferenceId` Use to work around a bug in 2.4.2 where UIMA calls the onBeforeMessageSend one extra time on the last document.
`protected String`	`referenceID` ID of the document received in an entityProcessComplete event.

Constructor Summary

Constructors
Constructor and Description

BaseListener()
Default Constructor.

Constructors
Constructor and Description
`BaseListener()` Default Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`checkForError(org.apache.uima.cas.CAS aCas, org.apache.uima.collection.EntityProcessStatus aStatus)` Check for an error in the return status of the processed CAS.
`void`	`collectionProcessComplete(org.apache.uima.collection.EntityProcessStatus aStatus)`
`void`	`entityProcessComplete(org.apache.uima.cas.CAS aCas, org.apache.uima.collection.EntityProcessStatus aStatus)`
`boolean`	`entityProcessError()` Return true if an exception was received from the service when the entityProcessComplete event was thrown.
`String[]`	`getAnnotationTypeFilter()` gets the list of annotation types to be filtered on.
`String[]`	`getInputType()` Get the array of input type names this listener will use.
`protected List<String>`	`getInputTypesList(org.apache.uima.cas.CAS cas)`
`int`	`getNumReceived()` Return the number of CAS objects that were returned by the service.
`int`	`getNumSent()` The number of CAS objects sent to the service.
`File`	`getOutputDir()` Return the output directory File object for this listener.
`protected String`	`getReferenceLocation(org.apache.uima.jcas.JCas jcas)` Return the document ID based on the CSI or SourceDocumentInformation objects.
`protected boolean`	`hasAnnotationsToProcess(org.apache.uima.cas.CAS aCas)` See if the cas has any annotations of the input type (if input types are specified).
`boolean`	`hasFilteredAnnotation(org.apache.uima.cas.CAS aCas)` See if the CAS has ANY annotations of the types specified in annotationTypeFilter.
`void`	`initializationComplete(org.apache.uima.collection.EntityProcessStatus aStatus)` Called once client initialization is complete.
`boolean`	`isExitOnError()` If true then the listener will exit the entityProcessComplete event when an error occurs.
`boolean`	`isLogErrors()` If true, when the service returns an error status, it is logged via log4j.
`void`	`onBeforeMessageSend(org.apache.uima.aae.client.UimaASProcessStatus status)` Called before sending a CAS to the pipeline, If we were timing each CAS individually this is where we would want to capture individual start times.
`<T extends BaseListener> T`	`setAnnotationTypeFilter(String... annotationTypeFilter)` Sets a list of annotation types.
`<T extends BaseListener> T`	`setExitOnError(boolean exitOnError)` Set the flag that if true will cause the entityProcessComplete method to return when an error occurs.
`<T extends BaseListener> T`	`setInputType(String... inputType)` Set the array of input type names.
`void`	`setLogErrors(boolean logErrors)` Set whether or not to log errors to log4j.
`<T extends BaseListener> T`	`setOutputDir(File mOutputDir)` Set the output directory for this listener.

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
  - inputType
```
protected String[] inputType
```
    The list of input types to save to the database. If set, only documents with annotations of a type in the list, those annotations, and their related feature are saved.
  - mOutputDir
```
protected File mOutputDir
```
    Output Directory for this gov.va.vinci.leo.listener output if required.
  - numReceived
```
protected int numReceived
```
    Number of CAS objects returned from the pipeline.
  - numSent
```
protected int numSent
```
    Number of CAS objects sent to the service for processing.
  - exitOnError
```
protected boolean exitOnError
```
    Flag to indicate whether or not entityProcessComplete processing should terminate when exceptions are received from the service.
  - lastException
```
protected String lastException
```
    Exceptions Received from service via entityProcessComplete event.
  - referenceID
```
protected String referenceID
```
    ID of the document received in an entityProcessComplete event.
  - docInfo
```
protected CSI docInfo
```
    CSI annotation for the document being processed in an entityProcessComplete event.
  - LOG
```
protected org.apache.log4j.Logger LOG
```
    Logging object of output.
  - logErrors
```
protected boolean logErrors
```
    If true, the base listener will log errors via log4j.
  - annotationTypeFilter
```
protected String[] annotationTypeFilter
```
    the annotation types to filter on. If annotation types are included, sub-classes can call hasFilteredAnnotation on this class to determine if the cas has one or more of the filter annotation types. Type is the string name, ie: gov.va.vinci.uima.type.Token
  - previousReferenceId
```
protected String previousReferenceId
```
    Use to work around a bug in 2.4.2 where UIMA calls the onBeforeMessageSend one extra time on the last document.
    https://issues.apache.org/jira/browse/UIMA-3581?jql=project%20%3D%20UIMA%20AND%20resolution%20%3D%20Unresolved%20AND%20assignee%20%3D%20cwiklik%20ORDER%20BY%20priority%20DESC
- Constructor Detail
  - BaseListener
```
public BaseListener()
```
    Default Constructor.
- Method Detail
  - initializationComplete
```
public void initializationComplete(org.apache.uima.collection.EntityProcessStatus aStatus)
```
    Called once client initialization is complete.
    
    Specified by:
    
    initializationComplete in interface org.apache.uima.aae.client.UimaASStatusCallbackListener
    
    Overrides:
    
    initializationComplete in class org.apache.uima.aae.client.UimaAsBaseCallbackListener
    
    Parameters:
    
    aStatus - the status of the processing.
    
    See Also:
    
    UimaAsBaseCallbackListener.initializationComplete(org.apache.uima.collection.EntityProcessStatus)
  - onBeforeMessageSend
```
public void onBeforeMessageSend(org.apache.uima.aae.client.UimaASProcessStatus status)
```
    Called before sending a CAS to the pipeline, If we were timing each CAS individually this is where we would want to capture individual start times.
    
    Overrides:
    
    onBeforeMessageSend in class org.apache.uima.aae.client.UimaAsBaseCallbackListener
    
    Parameters:
    
    status - the status of the processing.
    
    See Also:
    
    UimaAsBaseCallbackListener.onBeforeMessageSend(org.apache.uima.aae.client.UimaASProcessStatus)
  - 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 org.apache.uima.aae.client.UimaAsBaseCallbackListener
    
    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 org.apache.uima.aae.client.UimaAsBaseCallbackListener
    
    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)
  - getOutputDir
```
public File getOutputDir()
```
    Return the output directory File object for this listener.
    
    Returns:
    
    Output Directory File object
  - setOutputDir
```
public <T extends BaseListener> T setOutputDir(File mOutputDir)
```
    Set the output directory for this listener.
    
    Parameters:
    
    mOutputDir - output directory
    
    Returns:
    
    reference to this listener instance
  - getNumSent
```
public int getNumSent()
```
    The number of CAS objects sent to the service.
    
    Returns:
    
    number of CAS objects sent up to the service
  - getNumReceived
```
public int getNumReceived()
```
    Return the number of CAS objects that were returned by the service.
    
    Returns:
    
    number of CAS objects received from the service
  - isExitOnError
```
public boolean isExitOnError()
```
    If true then the listener will exit the entityProcessComplete event when an error occurs.
    
    Returns:
    
    true if the listener should exit when errors occur.
  - setExitOnError
```
public <T extends BaseListener> T setExitOnError(boolean exitOnError)
```
    Set the flag that if true will cause the entityProcessComplete method to return when an error occurs.
    
    Parameters:
    
    exitOnError - value to set.
  - getInputType
```
public String[] getInputType()
```
    Get the array of input type names this listener will use.
    
    Returns:
    
    input types array
  - setInputType
```
public <T extends BaseListener> T setInputType(String... inputType)
```
    Set the array of input type names. Extending listeners should only output annotations from this list.
    
    Parameters:
    
    inputType - input type name(s)
    
    Returns:
    
    reference to this listener instance
  - entityProcessError
```
public boolean entityProcessError()
```
    Return true if an exception was received from the service when the entityProcessComplete event was thrown.
    
    Returns:
    
    True if an exception was received, false otherwise
  - getReferenceLocation
```
protected String getReferenceLocation(org.apache.uima.jcas.JCas jcas)
```
    Return the document ID based on the CSI or SourceDocumentInformation objects.
    
    Parameters:
    
    jcas - JCas object where the annotations are stored
    
    Returns:
    
    String object containing the document ID or null if no ID is found
  - hasFilteredAnnotation
```
public boolean hasFilteredAnnotation(org.apache.uima.cas.CAS aCas)
```
    See if the CAS has ANY annotations of the types specified in annotationTypeFilter.
    
    Parameters:
    
    aCas - the CAS to check
    
    Returns:
    
    true if the CAS has ANY of the types, false if it does not
  - checkForError
```
protected boolean checkForError(org.apache.uima.cas.CAS aCas,
                                org.apache.uima.collection.EntityProcessStatus aStatus)
```
    Check for an error in the return status of the processed CAS. Return true if there is an error.
    
    Parameters:
    
    aCas - CAS that was processed
    
    aStatus - Status object that contains the exception if one is thrown
    
    Returns:
    
    True if an error was returned, False otherwise
  - getAnnotationTypeFilter
```
public String[] getAnnotationTypeFilter()
```
    gets the list of annotation types to be filtered on. A CAS can be checked via hasFilteredAnnotation(CAS aCas) against this list.
    
    Returns:
    
    the list of annotation types to be filtered on. A CAS can be checked via hasFilteredAnnotation(CAS aCas) against this list.
  - setAnnotationTypeFilter
```
public <T extends BaseListener> T setAnnotationTypeFilter(String... annotationTypeFilter)
```
    Sets a list of annotation types. Type is the string name, ie: gov.va.vinci.uima.type.Token
    
    Parameters:
    
    annotationTypeFilter - a list of annotation types. Type is the string name, ie: gov.va.vinci.uima.type.Token
  - isLogErrors
```
public boolean isLogErrors()
```
    If true, when the service returns an error status, it is logged via log4j.
    
    Returns:
    
    true if errors from the service are logged via log4j, false if they are not.
  - setLogErrors
```
public void setLogErrors(boolean logErrors)
```
    Set whether or not to log errors to log4j. If true, when the service returns an error status, it is logged via log4j.
  - hasAnnotationsToProcess
```
protected boolean hasAnnotationsToProcess(org.apache.uima.cas.CAS aCas)
```
    See if the cas has any annotations of the input type (if input types are specified).
    
    Parameters:
    
    aCas - the CAS to check
    
    Returns:
    
    true if the CAS has any annotations of type in inputType, or true if no inputTypes are specified.
  - getInputTypesList
```
protected List<String> getInputTypesList(org.apache.uima.cas.CAS cas)
```

Class BaseListener

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

inputType

mOutputDir

numReceived

numSent

exitOnError

lastException

referenceID

docInfo

LOG

logErrors

annotationTypeFilter

previousReferenceId

Constructor Detail

BaseListener

Method Detail

initializationComplete

onBeforeMessageSend

entityProcessComplete

collectionProcessComplete

getOutputDir

setOutputDir

getNumSent

getNumReceived

isExitOnError

setExitOnError

getInputType

setInputType

entityProcessError

getReferenceLocation

hasFilteredAnnotation

checkForError

getAnnotationTypeFilter

setAnnotationTypeFilter

isLogErrors

setLogErrors

hasAnnotationsToProcess

getInputTypesList