com.raritantechnologies.uima
Class UIMASearchSourceAnnotator

java.lang.Object
  Annotator_ImplBase
      com.raritantechnologies.uima.UIMASearchSourceAnnotator

public class UIMASearchSourceAnnotator

extends Annotator_ImplBase

A UIMA Annotator that uses a RTI SearchSource to get annotation terms.

UIMA Configuration Template:

 <!-- ============================================================ -->
 <!-- UIMA Annotator Descriptor for the UIMASearchSourceAnnotator. -->
 <!-- ============================================================ -->

 <taeDescription xmlns="http://uima.watson.ibm.com/resourceSpecifier">
   <frameworkImplementation>com.ibm.uima.java</frameworkImplementation>
   <primitive>true</primitive>

   <annotatorImplementationName>com.raritantechnologies.uima.UIMASearchSourceAnnotator</annotatorImplementationName>

     <analysisEngineMetaData>
       <name>Raritan Search Source Annotator</name>
       <description>An  annotator that uses a Raritan Search Source to annotate documents.</description>
       <version>1.0</version>
       <vendor>Raritan Technologies</vendor>

       <configurationParameters>

         <!-- ================================================ -->
         <!--   Links the annotator to a Raritan SearchSource  -->
         <!-- ================================================ -->
         <configurationParameter>
           <name>searchSourceName</name>
           <description>Name of RTI Search Source.</description>
           <type>String</type>
           <multiValued>false</multiValued>
           <mandatory>true</mandatory>
         </configurationParameter>

         <!-- ================================================ -->
         <!--   Defines the result fields(s) that contain      -->
         <!--   annotator terms.                               -->
         <!-- ================================================ -->
         <configurationParameter>
           <name>resultField</name>
           <description>Name of search result field with annotation strings.</description>
           <type>String</type>
           <multiValued>false</multiValued>
           <mandatory>true</mandatory>
         </configurationParameter>

         <!-- ================================================ -->
         <!--   (optional) Provides a unique name for the      -->
         <!--   annotation map.                                -->
         <!-- ================================================ -->
         <configurationParameter>
           <name>annotationName</name>
           <description>Name of the RaritanAnnotation.</description>
           <type>String</type>
           <multiValued>false</multiValued>
           <mandatory>true</mandatory>
         </configurationParameter>
       </configurationParameters>

       <configurationParameterSettings>
         <nameValuePair>
           <name>searchSourceName</name>
           <value><string>[ Name of SourceType tag in RTI Config XML ]</string></value>
         </nameValuePair>
         <nameValuePair>
           <name>[ name of result field from which annotations are derived ]</name>
           <value><string>Name</string></value>
         </nameValuePair>
         <nameValuePair>
           <name>annotationName</name>
           <value><string>[ name of the annotator ]</string></value>
         </nameValuePair>
       </configurationParameterSettings>

       <!-- TypeSystem Definition: Uses a RaritanAnnotator -->
       <typeSystemDescription>
         <imports>
           <import location="RaritanAnnotation.xml"/>
         </imports>
       </typeSystemDescription>

     <!-- Capabilities: Inputs, Outputs, and Preconditions -->
     <capabilities>
       <capability>
         <inputs />
         <outputs>
           <type>com.raritantechnologies.uima.RaritanAnnotation</type>
           <feature>com.raritantechnologies.uima.RaritanAnnotation:name</feature>
         </outputs>
       </capability>
     </capabilities>

   </analysisEngineMetaData>
 </taeDescription>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

See Also:

Serialized Form

Constructor Summary

UIMASearchSourceAnnotator()

Method Summary

void	initialize(AnnotatorContext aContext)
void	process(TCAS aTCAS, ResultSpecification aResultSpec)
void	typeSystemInit(TypeSystem aTypeSystem)

Methods inherited from class java.lang.Object

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

Constructor Detail

UIMASearchSourceAnnotator

public UIMASearchSourceAnnotator()

Method Detail

initialize

public void initialize(AnnotatorContext aContext)
                throws AnnotatorConfigurationException,
                       AnnotatorInitializationException

Throws:

AnnotatorConfigurationException

AnnotatorInitializationException

typeSystemInit

public void typeSystemInit(TypeSystem aTypeSystem)
                    throws AnnotatorInitializationException

Throws:

AnnotatorInitializationException

process

public void process(TCAS aTCAS,
                    ResultSpecification aResultSpec)
             throws AnnotatorProcessException

Throws:

AnnotatorProcessException