gov.va.vinci.leo.cr

Class XmiFileCollectionReader

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.XmiFileCollectionReader

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 XmiFileCollectionReader
extends BaseFileCollectionReader

Get a list of the XMI files in a directory and populate the CAS when getNext(Cas) is called on the reader. 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:

 

     CollectionReader reader = CollectionReaderFactory
                                  .generateXmiFileSubReader(new File("my-input-directory/xmi/"), true);

  

XMI Sub reader

Author:

DNS cornir

Field Summary

Fields

Modifier and Type	Field and Description
static String	fileExtenstionString The default file name extension to filter on.

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

filenameFilter, fileNameFilterJSON, fileNameFilterName, inputDirectoryPath, 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
XmiFileCollectionReader() Default constructor used during UIMA initialization.
XmiFileCollectionReader(File inputDirectory, boolean recurse) Constructor that sets the inputDirectory and recurse flag.

Method Summary

Modifier and Type	Method and Description
void	getNext(org.apache.uima.cas.CAS aCAS) De-serialize the next XMI file in the collection.

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

fileExtenstionString

public static final String fileExtenstionString

The default file name extension to filter on.

See Also:

Constant Field Values

Constructor Detail

XmiFileCollectionReader

public XmiFileCollectionReader()

Default constructor used during UIMA initialization.

XmiFileCollectionReader

public XmiFileCollectionReader(File inputDirectory,
                               boolean recurse)

Constructor that sets the inputDirectory and recurse flag.

Parameters:

inputDirectory - Path to the directory that will be searched for files to process

recurse - If true then recurse into subdirectories.

Method Detail

getNext

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

De-serialize the next XMI file in the collection.

Specified by:

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

Specified by:

getNext in class BaseFileCollectionReader

Parameters:

aCAS - the CAS to populate with the next element of the collection.

Throws:

IOException - if there is an error reading from the files.

org.apache.uima.collection.CollectionException - if there is an error deserializing the XMI.

See Also:

BaseFileCollectionReader.getNext(org.apache.uima.cas.CAS)