gov.va.vinci.leo.cr

Class FileCollectionReader

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

gov.va.vinci.leo.cr.BaseFileCollectionReader

gov.va.vinci.leo.cr.FileCollectionReader

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

public class FileCollectionReader
extends BaseFileCollectionReader

Get a list of the files in a directory and return them one at a time. Optionally a recurse flag can also be set which causes the reader to search recursively through the entire folder structure of the parent directory.

Note: Collection readers, to be used within UIMA, need to be generated via the CollectionReader factory.

For example, a file subreader would be created via:

 

     CollectionReader reader = CollectionReaderFactory
                                  .generateFileSubReader(new File("my-input-directory/sub-dir/"), true);

  

Author:

thomasginter

Field Summary

Fields

Modifier and Type	Field and Description
static String	fileExtensionString Default file extension string.

Fields inherited from class gov.va.vinci.leo.cr.BaseFileCollectionReader

filenameFilter, fileNameFilterJSON, fileNameFilterName, inputDirectoryPath, LOG, mEncoding, mFileCollection, mFileIndex, mInDir, mRecurse

Fields inherited from class gov.va.vinci.leo.cr.BaseLeoCollectionReader

filters, 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
FileCollectionReader() Default constructor used during UIMA initialization.
FileCollectionReader(File inputDirectory, boolean recurse) Constructor that takes an input directory path and recurse flag as inputs.

Method Summary

Modifier and Type	Method and Description
void	getNext(org.apache.uima.cas.CAS aCAS) Get the next file to be processed in the pipeline.

Methods inherited from class gov.va.vinci.leo.cr.BaseFileCollectionReader

findFiles, getCollectionSize, getCurrentIndex, getEncoding, getFilenameFilter, getInputDirectory, getProgress, hasNext, initialize, setEncoding, setFilenameFilter, setInputDirectory, setRecurseFlag

Methods inherited from class gov.va.vinci.leo.cr.BaseLeoCollectionReader

addFilters, addFilters, close, generateCollectionReaderDescription, getFilters, produceCollectionReader

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.resource.ConfigurableResource

getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

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

getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

Field Detail

fileExtensionString

public static final String fileExtensionString

Default file extension string.

See Also:

Constant Field Values

Constructor Detail

FileCollectionReader

public FileCollectionReader()

Default constructor used during UIMA initialization.

FileCollectionReader

public FileCollectionReader(File inputDirectory,
                            boolean recurse)

Constructor that takes an input directory path and recurse flag as inputs.

Parameters:

inputDirectory - Path to the input directory to be read.

recurse - If true then recursively search sub-directories for files to process.

Method Detail

getNext

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

Get the next file to be processed in the pipeline.

Specified by:

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

Specified by:

getNext in class BaseFileCollectionReader

Parameters:

aCAS - CAS to be populated with the next document.

Throws:

Exception - if retrieval of the next file fails

IOException - if there is an error reading the data.

org.apache.uima.collection.CollectionException - if retrieval of the next file fails