gov.va.vinci.leo.cr

Class BaseLeoCollectionReader

java.lang.Object

org.apache.uima.resource.Resource_ImplBase

org.apache.uima.resource.ConfigurableResource_ImplBase

org.apache.uima.collection.CollectionReader_ImplBase

gov.va.vinci.leo.cr.BaseLeoCollectionReader

All Implemented Interfaces:

LeoCollectionReaderInterface, org.apache.uima.collection.base_cpm.BaseCollectionReader, org.apache.uima.collection.CollectionReader, org.apache.uima.resource.ConfigurableResource, org.apache.uima.resource.Resource

Direct Known Subclasses:

BaseDatabaseCollectionReader, BaseFileCollectionReader

public abstract class BaseLeoCollectionReader
extends org.apache.uima.collection.CollectionReader_ImplBase
implements LeoCollectionReaderInterface

Provides the CollectionReader interface object to the UIMA framework for implementations of SubReaders. This interface class allows us to provide a common data information structure propagated throughout every CAS object it produces.

Author:

thomasginter

Field Summary

Fields

Modifier and Type	Field and Description
protected List<TextFilter>	filters List of filters to be applied to the text before adding to the CAS as document text.
protected String[]	textFilters

Fields inherited from interface org.apache.uima.resource.Resource

PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT

Constructor Summary

Constructors

Constructor and Description
BaseLeoCollectionReader()

Method Summary

Modifier and Type	Method and Description
<T extends BaseLeoCollectionReader> T	addFilters(String... textFilters) Add the list of textFilters classes from a String list.
<T extends BaseLeoCollectionReader> T	addFilters(TextFilter... textFilters) Add one or more text filters to the list of filters to be applied to the document text before adding to the CAS.
void	close()
org.apache.uima.collection.CollectionReaderDescription	generateCollectionReaderDescription() Generate a new CollectionReaderDescription from the CollectionReader parameters and values.
List<TextFilter>	getFilters() Return the list of filters for this reader.
abstract void	getNext(org.apache.uima.cas.CAS aCAS)
abstract boolean	hasNext()
void	initialize() This method is called during initialization, and does nothing by default.
org.apache.uima.collection.CollectionReader	produceCollectionReader() Generate a new CollectionReaderDescription from the current reader and reader parameters.

Methods inherited from class org.apache.uima.collection.CollectionReader_ImplBase

destroy, getCasInitializer, getProcessingResourceMetaData, initialize, isConsuming, reconfigure, setCasInitializer, typeSystemInit

Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase

getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

Methods inherited from class org.apache.uima.resource.Resource_ImplBase

getCasManager, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger, setMetaData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.uima.collection.base_cpm.BaseCollectionReader

getProgress

Methods inherited from interface org.apache.uima.resource.ConfigurableResource

getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

Methods inherited from interface org.apache.uima.resource.Resource

getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

Field Detail

filters

protected List<TextFilter> filters

List of filters to be applied to the text before adding to the CAS as document text.

textFilters

@LeoConfigurationParameter(description="TextFilter classes that will be used to filter the text")
protected String[] textFilters

Constructor Detail

BaseLeoCollectionReader

public BaseLeoCollectionReader()

Method Detail

initialize

public void initialize()
                throws org.apache.uima.resource.ResourceInitializationException

This method is called during initialization, and does nothing by default. Subclasses should override it to perform one-time startup logic.

Overrides:

initialize in class org.apache.uima.collection.CollectionReader_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException - if a failure occurs during initialization.

getNext

public abstract void getNext(org.apache.uima.cas.CAS aCAS)
                      throws org.apache.uima.collection.CollectionException,
                             IOException

Specified by:

getNext in interface org.apache.uima.collection.CollectionReader

Parameters:

aCAS - the CAS to populate with the next document;

Throws:

org.apache.uima.collection.CollectionException - if there is a problem getting the next and populating the CAS.

IOException

hasNext

public abstract boolean hasNext()
                         throws IOException,
                                org.apache.uima.collection.CollectionException

Specified by:

hasNext in interface org.apache.uima.collection.base_cpm.BaseCollectionReader

Returns:

true if and only if there are more elements availble from this CollectionReader.

Throws:

IOException

org.apache.uima.collection.CollectionException

addFilters

public <T extends BaseLeoCollectionReader> T addFilters(String... textFilters)
                                                 throws ClassNotFoundException,
                                                        IllegalAccessException,
                                                        InstantiationException

Add the list of textFilters classes from a String list. Typically this list is coming from the Configuration Parameter input.

Parameters:

textFilters - List of class names, each of which is a TextFilter

Throws:

ClassNotFoundException - if one of the filter classes cannot be found

IllegalAccessException - if the filter class cannot be accessed

InstantiationException - if the filter class cannot be instantiated.

addFilters

public <T extends BaseLeoCollectionReader> T addFilters(TextFilter... textFilters)

Add one or more text filters to the list of filters to be applied to the document text before adding to the CAS.

Parameters:

textFilters - One or more filters to be added to the list

getFilters

public List<TextFilter> getFilters()

Return the list of filters for this reader.

Returns:

list of filters

close

public void close()
           throws IOException

Specified by:

close in interface org.apache.uima.collection.base_cpm.BaseCollectionReader

Throws:

IOException - if the underlying reader throws an IOException closing.

See Also:

BaseCollectionReader.close()

produceCollectionReader

public org.apache.uima.collection.CollectionReader produceCollectionReader()
                                                                    throws org.apache.uima.resource.ResourceInitializationException

Generate a new CollectionReaderDescription from the current reader and reader parameters. Uses the UIMAFramework to create a new CollectionReader from the description and return it.

Specified by:

produceCollectionReader in interface LeoCollectionReaderInterface

Returns:

CollectionReader instance

Throws:

org.apache.uima.resource.ResourceInitializationException - if there is an error creating the descriptor

generateCollectionReaderDescription

public org.apache.uima.collection.CollectionReaderDescription generateCollectionReaderDescription()
                                                                                           throws org.apache.uima.resource.ResourceInitializationException

Generate a new CollectionReaderDescription from the CollectionReader parameters and values.

Returns:

CollectionReaderDescription instance

Throws:

org.apache.uima.resource.ResourceInitializationException - if there is an error creating the descriptor