gov.va.vinci.leo.cr

Class ExternalCollectionReader

java.lang.Object

gov.va.vinci.leo.cr.ExternalCollectionReader

All Implemented Interfaces:

LeoCollectionReaderInterface

public class ExternalCollectionReader
extends Object
implements LeoCollectionReaderInterface

Import a third party CollectionReader from a descriptor or an already initialized CollectionReader object.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.uima.collection.CollectionReader	reader Reference to the external CollectionReader object that will do the real work of getting the data.

Constructor Summary

Constructors

Constructor and Description
ExternalCollectionReader(org.apache.uima.collection.CollectionReader_ImplBase reader) Initialize with a pre-created CollectionReader object.
ExternalCollectionReader(File collectionReaderDescriptor) Set the reader from the CollectionReader referenced in the File object specified.
ExternalCollectionReader(String collectionReaderDescriptorPath) Set the reader from the path to the descriptor.

Method Summary

Modifier and Type	Method and Description
org.apache.uima.collection.CollectionReader	produceCollectionReader() Generate the UIMA Collection reader with resources.

Methods inherited from class java.lang.Object

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

Field Detail

reader

protected org.apache.uima.collection.CollectionReader reader

Reference to the external CollectionReader object that will do the real work of getting the data.

Constructor Detail

ExternalCollectionReader

public ExternalCollectionReader(org.apache.uima.collection.CollectionReader_ImplBase reader)

Initialize with a pre-created CollectionReader object.

Parameters:

reader - CollectionReader to set.

ExternalCollectionReader

public ExternalCollectionReader(String collectionReaderDescriptorPath)
                         throws org.apache.uima.resource.ResourceInitializationException,
                                IOException,
                                org.apache.uima.util.InvalidXMLException

Set the reader from the path to the descriptor. The path should be preceded by file: or classpath: to distinguish between explicit file system paths and classpath resources.

Parameters:

collectionReaderDescriptorPath - Path to the CollectionReader descriptor.

Throws:

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

IOException - if there is an error in the XML of the descriptor.

org.apache.uima.util.InvalidXMLException - if the CollectionReader cannot be initialized by the framework.

ExternalCollectionReader

public ExternalCollectionReader(File collectionReaderDescriptor)
                         throws IOException,
                                org.apache.uima.util.InvalidXMLException,
                                org.apache.uima.resource.ResourceInitializationException

Set the reader from the CollectionReader referenced in the File object specified.

Parameters:

collectionReaderDescriptor - CollectionReader descriptor to use.

Throws:

IOException - if there is an error reading the descriptor.

org.apache.uima.util.InvalidXMLException - if there is an error in the XML of the descriptor.

org.apache.uima.resource.ResourceInitializationException - if the CollectionReader cannot be initialized by the framework.

Method Detail

produceCollectionReader

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

Generate the UIMA Collection reader with resources.

Specified by:

produceCollectionReader in interface LeoCollectionReaderInterface

Returns:

a uima collection reader.

Throws:

org.apache.uima.resource.ResourceInitializationException - if there is an error initializing the reader.