org.apache.ctakes.chunker.ae.adjuster

Class ChunkAdjuster

java.lang.Object

org.apache.uima.analysis_component.AnalysisComponent_ImplBase

org.apache.uima.analysis_component.Annotator_ImplBase

org.apache.uima.analysis_component.JCasAnnotator_ImplBase

org.apache.uima.fit.component.JCasAnnotator_ImplBase

org.apache.ctakes.chunker.ae.adjuster.ChunkAdjuster

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

@PipeBitInfo(name="Chunk Adjuster",
             description="Annotator that uses a pattern and a rule about that pattern to adjust certain annotations.",
             role=SPECIAL,
             dependencies={SENTENCE,CHUNK})
public class ChunkAdjuster
extends org.apache.uima.fit.component.JCasAnnotator_ImplBase

UIMA annotator that uses a pattern and a rule about that pattern to adjust certain annotations. The original reason for this annotator is to extend NP annotations to include prepositional phrases so that for the pattern NP PP NP, named entities that includes a word(s) from each of those NPs is found. Searches for the pattern within each Sentence. The end offset of the first chunk in the pattern is extended to match the end offset of the last chunk in the pattern. Note the pattern is applied repeatedly so that a sentence of NP PP NP PP NP results in only the first NP being extended all the way to the last NP in that sentence. This prevents NP annotations from only partially overlapping other NP annotations. This annotator is written to be able to handle more general cases than NP PP NP.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_CHUNK_PATTERN The pattern of chunks that trigger an adjustment.
static String	PARAM_EXTEND_TO_INCLUDE_TOKEN The index of the token (within the pattern) to extend the end offset to include.

Constructor Summary

Constructors

Constructor and Description
ChunkAdjuster()

Method Summary

Modifier and Type	Method and Description
protected void	annotateRange(org.apache.uima.jcas.JCas jcas, int rangeBegin, int rangeEnd) A utility method that annotates a given range.
protected void	annotateSentence(org.apache.uima.jcas.JCas jcas, Sentence sent)
static org.apache.uima.analysis_engine.AnalysisEngineDescription	createAnnotatorDescription(String[] chunkPattern, int patternIndex)
void	initialize(org.apache.uima.UimaContext aContext) Performs initialization logic.
void	process(org.apache.uima.jcas.JCas jcas) Invokes this annotator's analysis logic.

Methods inherited from class org.apache.uima.fit.component.JCasAnnotator_ImplBase

getLogger

Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_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, getResultSpecification, reconfigure, setResultSpecification

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_CHUNK_PATTERN

public static final String PARAM_CHUNK_PATTERN

The pattern of chunks that trigger an adjustment.

See Also:

Constant Field Values

PARAM_EXTEND_TO_INCLUDE_TOKEN

public static final String PARAM_EXTEND_TO_INCLUDE_TOKEN

The index of the token (within the pattern) to extend the end offset to include. E.g. is 2 to extend the first NP to include the last NP in NP PP NP.

See Also:

Constant Field Values

Constructor Detail

ChunkAdjuster

public ChunkAdjuster()

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. This method is not invoked for every document processed. // * @see org.apache.uima.analysis_engine.annotator.BaseAnnotator#initialize(AnnotatorContext)

Specified by:

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

Overrides:

initialize in class org.apache.uima.fit.component.JCasAnnotator_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

process

public void process(org.apache.uima.jcas.JCas jcas)
             throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Invokes this annotator's analysis logic. Invoked for each document processed. For each Sentence, look for the pattern, and adjust a chunk if the pattern is found.

Specified by:

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

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

annotateSentence

protected void annotateSentence(org.apache.uima.jcas.JCas jcas,
                                Sentence sent)
                         throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

annotateRange

protected void annotateRange(org.apache.uima.jcas.JCas jcas,
                             int rangeBegin,
                             int rangeEnd)
                      throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

A utility method that annotates a given range.

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

createAnnotatorDescription

public static org.apache.uima.analysis_engine.AnalysisEngineDescription createAnnotatorDescription(String[] chunkPattern,
                                                                                                   int patternIndex)
                                                                                            throws org.apache.uima.resource.ResourceInitializationException

Throws:

org.apache.uima.resource.ResourceInitializationException