Package org.apache.uima.fit.examples.tutorial.ex2

Class RoomNumberAnnotator

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.uima.fit.examples.tutorial.ex2.RoomNumberAnnotator

All Implemented Interfaces:

AnalysisComponent

public class RoomNumberAnnotator
extends JCasAnnotator_ImplBase

This class demonstrates annotating member variables with the @ConfigurationParameter annotation. Defining configuration parameters in this way in combination with using the uimaFIT's JCasAnnotator_ImplBase class obviates the need for an initialize method at all because the super class initialize method calls ConfigurationParameterInitializer.initialize(java.lang.Object, org.apache.uima.UimaContext). This method initializes member variables annotated as configuration parameters using the configuration parameter information provided in the UimaContext. This class was copied from the uimaj-examples project and modified in following ways:

• The package name was changed to org.apache.uima.fit.tutorial.ex2
• The super class was changed to org.apache.uima.fit.component.JCasAnnotator_ImplBase
• The class is annotated with org.apache.uima.fit.descriptor.TypeCapability
• mPatterns and mLocations is annotated with @ConfigurationParameters
• the initialize method was removed

Constructor Summary

Constructors

Constructor	Description
RoomNumberAnnotator()

Method Summary

Modifier and Type	Method	Description
void	process(JCas aJCas)	This method should be overriden by subclasses.

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

initialize

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, getLogger, getResultSpecification, reconfigure, setResultSpecification

Methods inherited from class java.lang.Object

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

Constructor Details

RoomNumberAnnotator

public RoomNumberAnnotator()

Method Details

process

public void process(JCas aJCas)
             throws AnalysisEngineProcessException

Description copied from class: JCasAnnotator_ImplBase

This method should be overriden by subclasses. Inputs a JCAS to the AnalysisComponent. The AnalysisComponent "owns" this JCAS until such time as Annotator_ImplBase.hasNext() is called and returns false (see AnalysisComponent for details).

Specified by:

process in class JCasAnnotator_ImplBase

Parameters:

aJCas - a JCAS that this AnalysisComponent should process.

Throws:

AnalysisEngineProcessException - if a problem occurs during processing

See Also:

• JCasAnnotator_ImplBase.process(JCas)