org.apache.uima.examples.cas

Class PersonTitleAnnotator

java.lang.Object

org.apache.uima.analysis_component.AnalysisComponent_ImplBase

org.apache.uima.analysis_component.Annotator_ImplBase

org.apache.uima.analysis_component.CasAnnotator_ImplBase

org.apache.uima.examples.cas.PersonTitleAnnotator

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

public class PersonTitleAnnotator
extends org.apache.uima.analysis_component.CasAnnotator_ImplBase

An example annotator that discovers Person Titles in text and classifies them into three categories - Civilian (e.g. Mr.,Ms.), Military (e.g. Lt. Col.) , and Government (e.g. Gov., Sen.). The titles are detected using simple string matching. The strings that are matched are determined by the CivilianTitles, MilitaryTitles, and GovernmentTitles configuration parameters.

If the ContainingAnnotationType parameter is specified, this annotator will only look for titles within existing annotations of that type. This feature can be used, for example, to only match person titles within existing Person Name annotations, discovered by some annotator that has run previously.

Constructor Summary

Constructors

Constructor and Description
PersonTitleAnnotator()

Method Summary

Modifier and Type	Method and Description
protected void	annotateRange(org.apache.uima.cas.CAS aCAS, String aText, int aBeginPos) A utility method that searches a part of the document for Person Titles.
protected void	annotateRange(org.apache.uima.cas.CAS aCAS, String aText, int aBeginPos, String aTitleType, String[] aTitles) A utility method that searches a part of the document for a specific kind of Person Title.
protected void	createAnnotation(org.apache.uima.cas.CAS aCAS, int aBeginPos, int aEndPos, String aTitleType) Creates an PersonTitle annotation in the CAS.
void	initialize(org.apache.uima.UimaContext aContext) Performs initialization logic.
void	process(org.apache.uima.cas.CAS aCAS) Annotates a document.
void	typeSystemInit(org.apache.uima.cas.TypeSystem aTypeSystem) Called whenever the CAS type system changes.

Methods inherited from class org.apache.uima.analysis_component.CasAnnotator_ImplBase

getRequiredCasInterface, process

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase

getCasInstancesRequired, hasNext, next

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

batchProcessComplete, collectionProcessComplete, destroy, getContext, getLogger, getResultSpecification, reconfigure, setResultSpecification

Methods inherited from class java.lang.Object

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

Constructor Detail

PersonTitleAnnotator

public PersonTitleAnnotator()

Method Detail

initialize

public void initialize(org.apache.uima.UimaContext aContext)
                throws org.apache.uima.resource.ResourceInitializationException

Performs initialization logic. This implementation just reads values for the configuration parameters.

Specified by:

initialize in interface org.apache.uima.analysis_component.AnalysisComponent

Overrides:

initialize in class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

See Also:

AnalysisComponent_ImplBase.initialize(UimaContext)

typeSystemInit

public void typeSystemInit(org.apache.uima.cas.TypeSystem aTypeSystem)
                    throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Called whenever the CAS type system changes. Acquires references to Types and Features.

Overrides:

typeSystemInit in class org.apache.uima.analysis_component.CasAnnotator_ImplBase

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

See Also:

BaseAnnotator.typeSystemInit(TypeSystem)

process

public void process(org.apache.uima.cas.CAS aCAS)
             throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Annotates a document. This annotator searches for person titles using simple string matching.

Specified by:

process in class org.apache.uima.analysis_component.CasAnnotator_ImplBase

Parameters:

aCAS - CAS containing document text and previously discovered annotations, and to which new annotations are to be written.

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

See Also:

CasAnnotator_ImplBase.process(CAS)

annotateRange

protected void annotateRange(org.apache.uima.cas.CAS aCAS,
                             String aText,
                             int aBeginPos)

A utility method that searches a part of the document for Person Titles.

Parameters:

aCAS - the CAS in which to create new annotations

aText - the substring of the document text within which to search

aBeginPos - the position of this substring relative to the start of the document

annotateRange

protected void annotateRange(org.apache.uima.cas.CAS aCAS,
                             String aText,
                             int aBeginPos,
                             String aTitleType,
                             String[] aTitles)

A utility method that searches a part of the document for a specific kind of Person Title.

Parameters:

aCAS - the CAS in which to create new annotations

aText - the substring of the document text within which to search

aBeginPos - the position of this substring relative to the start of the document

aTitleType - the type of title to look for. This becomes the value of the Kind feature.

aTitles - the exact strings to look for in the document

createAnnotation

protected void createAnnotation(org.apache.uima.cas.CAS aCAS,
                                int aBeginPos,
                                int aEndPos,
                                String aTitleType)

Creates an PersonTitle annotation in the CAS.

Parameters:

aCAS - the CAS in which to create the annotation

aBeginPos - the begin position of the annotation relative to the start of the document

aEndPos - the end position of the annotation relative to the start of the document. (Note that, as in the Java string functions, the end position is one past the last character in the annotation, so that (end - begin) = length.

aTitleType - the type of person title. This becomes the value of the Kind feature.