anl.aida.reader
Interface AIDAComponentReader

All Known Implementing Classes:
AbstractAIDAComponentReader, AlbertLeaTribuneReader, ChicagoTribuneReader, ColumbusTelegramReader, ContentComponentReader, DailyGateReader, DailyIowanReader, DailySentinelReader, FremontTribuneReader, GoldenTriangleReader, GrandIslandIndependentReader, GuardianReader, IndependentReader, JournalStarReader, LATimesReader, MuscatineJournalReader, NTARCReader, NYTimesReader, OmahaNewsStandReader, ProMedReader, QuadCityTimesReader, SiouxCityReader, YorkNewsTimesReader

public interface AIDAComponentReader

Interface for classes that are components in a MIFSCompositeReader. The CompositeReader delegates the reading to its individual components.


Field Summary
static java.lang.String MESSAGE_DIGEST
           
 
Method Summary
 void close()
          Closes this MIFSComponentReader and any resources it may have opened.
 void getNext(org.apache.uima.cas.CAS cas)
          Gets the next document etc.
 boolean hasNext()
          Gets whether or not this MIFSComponentReader has more documents to process.
 void initialize(org.apache.uima.resource.ConfigurableResource resource, java.util.Date cacheDateDate)
          Initializes this MIFSComponentReader, optionally using the resource.
 

Field Detail

MESSAGE_DIGEST

static final java.lang.String MESSAGE_DIGEST
See Also:
Constant Field Values
Method Detail

initialize

void initialize(org.apache.uima.resource.ConfigurableResource resource,
                java.util.Date cacheDateDate)
                throws org.apache.uima.resource.ResourceInitializationException
Initializes this MIFSComponentReader, optionally using the resource.

Parameters:
resource - the resource to use for configuration
Throws:
org.apache.uima.resource.ResourceInitializationException - if there is an error initializing the reader

getNext

void getNext(org.apache.uima.cas.CAS cas)
             throws java.io.IOException,
                    org.apache.uima.collection.CollectionException
Gets the next document etc. into the CAS.

Parameters:
cas - the CAS to put the document into
Throws:
java.io.IOException - if there is an error reading the document
org.apache.uima.collection.CollectionException - if there is an error reading the document

hasNext

boolean hasNext()
                throws java.io.IOException,
                       org.apache.uima.collection.CollectionException
Gets whether or not this MIFSComponentReader has more documents to process.

Returns:
true if done, otherwise false.
Throws:
java.io.IOException - if there is an error in determining if there are more docs to process.
org.apache.uima.collection.CollectionException

close

void close()
           throws java.io.IOException
Closes this MIFSComponentReader and any resources it may have opened.

Throws:
java.io.IOException - if there is an error closing the reader.