org.apache.ctakes.core.cr

Class FileTreeReader

java.lang.Object

org.apache.uima.resource.Resource_ImplBase

org.apache.uima.resource.ConfigurableResource_ImplBase

org.apache.uima.collection.CollectionReader_ImplBase

org.apache.uima.fit.component.JCasCollectionReader_ImplBase

org.apache.ctakes.core.cr.FileTreeReader

All Implemented Interfaces:

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

@PipeBitInfo(name="Files in Dir Tree Reader",
             description="Reads document texts from text files in a directory tree.",
             role=READER,
             products={DOCUMENT_ID,DOCUMENT_ID_PREFIX})
public final class FileTreeReader
extends org.apache.uima.fit.component.JCasCollectionReader_ImplBase

Recursively reads a directory tree of files, sorted by level (root first), creating the DocumentID from the file name and the DocumentIdPrefix by the subdirectory path between the root and the leaf file

Since:

2/10/2016

Version:

%I%

Author:

SPF , chip-nlp

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_ENCODING Name of configuration parameter that contains the character encoding used by the input files.
static String	PARAM_EXTENSIONS Name of optional configuration parameter that specifies the extensions of the files that the collection reader will read.

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
FileTreeReader()

Method Summary

Modifier and Type	Method and Description
void	close()
static org.apache.uima.collection.CollectionReader	createReader(String inputDirectory) Convenience method to create a reader with an input directory
void	getNext(org.apache.uima.jcas.JCas jcas)
int	getNumberOfDocuments() Gets the total number of documents that will be returned by this collection reader.
org.apache.uima.util.Progress[]	getProgress()
boolean	hasNext()
void	initialize(org.apache.uima.UimaContext context)

Methods inherited from class org.apache.uima.fit.component.JCasCollectionReader_ImplBase

getLogger, getNext, initialize

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, 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

getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

Field Detail

PARAM_ENCODING

public static final String PARAM_ENCODING

Name of configuration parameter that contains the character encoding used by the input files. If not specified, the default system encoding will be used.

See Also:

Constant Field Values

PARAM_EXTENSIONS

public static final String PARAM_EXTENSIONS

Name of optional configuration parameter that specifies the extensions of the files that the collection reader will read. Values for this parameter should not begin with a dot '.'.

See Also:

Constant Field Values

Constructor Detail

FileTreeReader

public FileTreeReader()

Method Detail

initialize

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

Overrides:

initialize in class org.apache.uima.fit.component.JCasCollectionReader_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

getNumberOfDocuments

public int getNumberOfDocuments()

Gets the total number of documents that will be returned by this collection reader. This is not part of the general collection reader interface.

Returns:

the number of documents in the collection

hasNext

public boolean hasNext()

getNext

public void getNext(org.apache.uima.jcas.JCas jcas)
             throws IOException,
                    org.apache.uima.collection.CollectionException

Specified by:

getNext in class org.apache.uima.fit.component.JCasCollectionReader_ImplBase

Throws:

IOException

org.apache.uima.collection.CollectionException

close

public void close()
           throws IOException

Specified by:

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

Overrides:

close in class org.apache.uima.fit.component.JCasCollectionReader_ImplBase

Throws:

IOException

getProgress

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

createReader

public static org.apache.uima.collection.CollectionReader createReader(String inputDirectory)
                                                                throws org.apache.uima.resource.ResourceInitializationException

Convenience method to create a reader with an input directory

Parameters:

inputDirectory - -

Returns:

new reader

Throws:

org.apache.uima.resource.ResourceInitializationException - -