gov.va.vinci.leo.cr

Class BaseFileCollectionReader

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

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:

FileCollectionReader, XmiFileCollectionReader

public abstract class BaseFileCollectionReader
extends BaseLeoCollectionReader

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.

Author:

thomasginter

Field Summary

Fields

Modifier and Type	Field and Description
protected FilenameFilter	filenameFilter Filters out the files found by filename extension.
protected String	fileNameFilterJSON JSON representation of the filename filter used to pass this object to the CollectionReader descriptor for initialization.
protected String	fileNameFilterName Class name of the file name filter this reader is using.
protected String	inputDirectoryPath Path to the input directory.
protected org.apache.log4j.Logger	LOG Logger for class.
protected String	mEncoding Encoding type for the files being read in.
protected ArrayList<File>	mFileCollection Array of File objects being processed.
protected int	mFileIndex Index of the next file to be processed.
protected File	mInDir Input Directory File object to be searched for available files.
protected boolean	mRecurse Recurse flag we will search recursively in sub-directories if true.

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
BaseFileCollectionReader() Default constructor used during UIMA initialization.
BaseFileCollectionReader(File inputDirectory, boolean recurse) Constructor that sets the input directory to be searched and the recurse flag that controls whether or not the reader will descend in to subdirectories.

Method Summary

Modifier and Type	Method and Description
protected void	findFiles(File f) Find the list of files that meet the requirements.
int	getCollectionSize() Return the number of documents in the set.
int	getCurrentIndex()
String	getEncoding() Return the encoding format that this CollectionReader will use for the source data.
FilenameFilter	getFilenameFilter() Get the filename filter that will be used to filter files found in the input directory.
File	getInputDirectory() Return the input directory this reader will search for files.
abstract void	getNext(org.apache.uima.cas.CAS aCAS) Get the next file to be processed in the pipeline.
org.apache.uima.util.Progress[]	getProgress()
boolean	hasNext()
void	initialize() This method is called during initialization, and does nothing by default.
<T extends BaseFileCollectionReader> T	setEncoding(String encoding) Set the file encoding from the encoding string provided.
<T extends BaseFileCollectionReader> T	setFilenameFilter(FilenameFilter filenameFilter) Set the FilenameFilter that this object will use to filter the files found in the input directory.
<T extends BaseFileCollectionReader> T	setInputDirectory(File inputDirectory) Set the inputDirectory for this FileSubReader object.
<T extends BaseFileCollectionReader> T	setRecurseFlag(boolean recurse) Set the recurse flag for this property.

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

inputDirectoryPath

@LeoConfigurationParameter(description="Path to the input directory",
                           mandatory=true)
protected String inputDirectoryPath

Path to the input directory. This variable is used to pass the value from the reader object to the CollectionReader descriptor for initialization. The mInDir will be created from this path.

mRecurse

@LeoConfigurationParameter(description="If true then recurse in subdirectories, defaults to false.")
protected boolean mRecurse

Recurse flag we will search recursively in sub-directories if true. Defaults to false.

mEncoding

@LeoConfigurationParameter
protected String mEncoding

Encoding type for the files being read in. Defaults to system default.

fileNameFilterJSON

@LeoConfigurationParameter(description="JSON representation of the filename filter.")
protected String fileNameFilterJSON

JSON representation of the filename filter used to pass this object to the CollectionReader descriptor for initialization.

fileNameFilterName

@LeoConfigurationParameter(description="Cannonical name of the filename filter")
protected String fileNameFilterName

Class name of the file name filter this reader is using.

mInDir

protected File mInDir

Input Directory File object to be searched for available files.

mFileIndex

protected int mFileIndex

Index of the next file to be processed.

mFileCollection

protected ArrayList<File> mFileCollection

Array of File objects being processed.

filenameFilter

protected FilenameFilter filenameFilter

Filters out the files found by filename extension.

LOG

protected org.apache.log4j.Logger LOG

Logger for class.

Constructor Detail

BaseFileCollectionReader

public BaseFileCollectionReader()

Default constructor used during UIMA initialization.

BaseFileCollectionReader

public BaseFileCollectionReader(File inputDirectory,
                                boolean recurse)

Constructor that sets the input directory to be searched and the recurse flag that controls whether or not the reader will descend in to subdirectories.

Parameters:

inputDirectory - Input directory to be searched

recurse - Recurse flag will descend into subdirectories if true, defaults to false.

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 BaseLeoCollectionReader

Throws:

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

getEncoding

public String getEncoding()

Return the encoding format that this CollectionReader will use for the source data.

Returns:

encoding format String.

setEncoding

public <T extends BaseFileCollectionReader> T setEncoding(String encoding)

Set the file encoding from the encoding string provided. Determines the kind of encoding to use when reading in source data.

Parameters:

encoding - encoding format to use.

getInputDirectory

public File getInputDirectory()

Return the input directory this reader will search for files.

Returns:

File object pointing to the input directory

setInputDirectory

public <T extends BaseFileCollectionReader> T setInputDirectory(File inputDirectory)

Set the inputDirectory for this FileSubReader object.

Parameters:

inputDirectory - the input directory to load files from.

getFilenameFilter

public FilenameFilter getFilenameFilter()

Get the filename filter that will be used to filter files found in the input directory.

Returns:

FilenameFilter

setFilenameFilter

public <T extends BaseFileCollectionReader> T setFilenameFilter(FilenameFilter filenameFilter)

Set the FilenameFilter that this object will use to filter the files found in the input directory.

Parameters:

filenameFilter - FilenameFilter

- extends BaseFileCollectionReader> Type of the reader instance to return

Returns:

reference to this reader instance

findFiles

protected void findFiles(File f)

Find the list of files that meet the requirements.

Parameters:

f - the file to search. This should be a directory.

setRecurseFlag

public <T extends BaseFileCollectionReader> T setRecurseFlag(boolean recurse)

Set the recurse flag for this property. The recurse flag controls whether or not this reader will recurse through subdirectories to find files or simply search the parent directory alone.

Parameters:

recurse - if true, sub directories are also searched, otherwise just the specified directory is used for input.

getCollectionSize

public int getCollectionSize()

Return the number of documents in the set.

Returns:

the size of the collection.

getCurrentIndex

public int getCurrentIndex()

Returns:

the index of the current document in the collection.

hasNext

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

Specified by:

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

Specified by:

hasNext in class BaseLeoCollectionReader

Returns:

true if there is another document in the collection, false if not.

Throws:

IOException - if there is an error reading the data.

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

getNext

public abstract 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 BaseLeoCollectionReader

Parameters:

aCAS - the cas to populate with the next document.

Throws:

IOException - if there is an error reading the data.

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

getProgress

public org.apache.uima.util.Progress[] getProgress()

Returns:

an array of Progress objects. Each object may have different units (for example number of entities or bytes).