com.raritantechnologies.uima
Class UIMACollectionReader

java.lang.Object
  CollectionReader_ImplBase
      com.raritantechnologies.uima.UIMACollectionReader

All Implemented Interfaces:

IConfigurable

public class UIMACollectionReader

extends CollectionReader_ImplBase

implements IConfigurable

Implements a UIMA Collection Reader by pulling information from a RTI Search Source using an ICollectionGateway.

XML Configuration Template

   <SystemObject type="UIMACollectionReader" name="[ name of this reader ]"
                    resultNameField="[ field to use for result ID in UIMA CPE ]" >

     <CollectionGateway class="[ class of com.raritantechnologies.searchApp.dataCollection.ICollectionGateway ]" >

     </CollectionGateway>

     <!-- Any formatting operations that need to be performed (e.g. get Full Text, etc ) -->
     <FieldFormatters>
       <!-- One or more FieldFormatter tags: -->
       <FieldFormatter class="[ class of com.raritantechnologies.searchApp.IFieldFormatter ]" >

       </FieldFormatter>

       <!-- etc. . . -->

     </FieldFormatters>

     <!-- ResultRenderer used to transform Results to text sent to UIMA Collection Processing Engine -->
     <ResultRenderer class="[ class of com.raritantechnologies.searchApp.taglibrary.IResultRenderer ]" >

     </ResultRenderer>

   </SystemObject>
 

The following diagram shows how the Raritan UIMACollectionReader fits into a standard UIMA Collection Processing Engine:

Developed by Raritan Technologies .

Author:

Ted Sullivan

See Also:

Serialized Form

Constructor Summary

UIMACollectionReader()

Method Summary

void	close()
CasInitializer	getCasInitializer()
void	getNext(CAS aCas) get the next result in the current result set.
ProcessingResourceMetaData	getProcessingResourceMetaData()
Progress[]	getProgress()
boolean	hasNext() 1) check if we have more results in the current result set.
void	initialize(org.w3c.dom.Element outputProcElem) Initializes the object from an XML tag or element.

Methods inherited from class java.lang.Object

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

Constructor Detail

UIMACollectionReader

public UIMACollectionReader()

Method Detail

hasNext

public boolean hasNext()
                throws java.io.IOException,
                       CollectionException

1) check if we have more results in the current result set. if NOT: Check if there are more result sets. if NOT: check if there are more queries to run. if more queries to run, run the next query until - we get a result or no more queries to run.

Throws:

java.io.IOException

CollectionException

getNext

public void getNext(CAS aCas)
             throws java.io.IOException,
                    CollectionException

get the next result in the current result set. if no more, see if there are more result sets. if no more result sets, see if there are more queries to run if more queries to run, run a query and try this again.

Throws:

java.io.IOException

CollectionException

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException

getProcessingResourceMetaData

public ProcessingResourceMetaData getProcessingResourceMetaData()

getCasInitializer

public CasInitializer getCasInitializer()

getProgress

public Progress[] getProgress()

initialize

public void initialize(org.w3c.dom.Element outputProcElem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable