Logo Search packages:      
Sourcecode: uimaj version File versions  Download package

Public Member Functions | Static Public Attributes

org::apache::uima::collection::base_cpm::BaseCollectionReader Interface Reference

Inheritance diagram for org::apache::uima::collection::base_cpm::BaseCollectionReader:
Inheritance graph
[legend]
Collaboration diagram for org::apache::uima::collection::base_cpm::BaseCollectionReader:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void close () throws IOException
void destroy ()
Logger getLogger ()
ResourceMetaData getMetaData ()
ProcessingResourceMetaData getProcessingResourceMetaData ()
Progress[] getProgress ()
ResourceManager getResourceManager ()
UimaContext getUimaContext ()
UimaContextAdmin getUimaContextAdmin ()
boolean hasNext () throws IOException, CollectionException
boolean initialize (ResourceSpecifier aSpecifier, Map< String, Object > aAdditionalParams) throws ResourceInitializationException
boolean isConsuming ()
void setLogger (Logger aLogger)

Static Public Attributes

static final String PARAM_AGGREGATE_SOFA_MAPPINGS = "AGGREGATE_SOFA_MAPPINGS"
static final String PARAM_CONFIG_PARAM_SETTINGS = "CONFIG_PARAM_SETTINGS"
static final String PARAM_PERFORMANCE_TUNING_SETTINGS = "PERFORMANCE_TUNING_SETTINGS"
static final String PARAM_RESOURCE_MANAGER = "RESOURCE_MANAGER"
static final String PARAM_UIMA_CONTEXT = "UIMA_CONTEXT"

Detailed Description

The Base CollectionReader interface. Collection Readers should not implement this interface directly. Instead they should implement org.apache.uima.collection.CollectionReader or CasDataCollectionReader. Most UIMA developers will prefer to use the former.

A consuming CollectionReader is one that removes each element from the collection as it is read. To find out whether a CollectionReader will consume elements in this way, call the isConsuming() method.

Users of a CollectionReader should always close it when they are finished using it.

Definition at line 44 of file BaseCollectionReader.java.


The documentation for this interface was generated from the following file:

Generated by  Doxygen 1.6.0   Back to index