org.apache.ctakes.core.cr

Class FilesInDirectoryCollectionCyclicalReads

java.lang.Object

org.apache.uima.resource.Resource_ImplBase

org.apache.uima.resource.ConfigurableResource_ImplBase

org.apache.uima.collection.CollectionReader_ImplBase

org.apache.ctakes.core.cr.FilesInDirectoryCollectionReader

org.apache.ctakes.core.cr.FilesInDirectoryCollectionCyclicalReads

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 Cycle Reader",
             description="Reads document texts from text files in a directory, repeating for a number of iterations.",
             role=READER,
             products=DOCUMENT_ID)
public class FilesInDirectoryCollectionCyclicalReads
extends FilesInDirectoryCollectionReader

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.
static String	PARAM_INPUTDIR Name of configuration parameter that must be set to the path of a directory containing input files.
static String	PARAM_LANGUAGE Name of optional configuration parameter that contains the language of the documents in the input directory.
static String	PARAM_NUMREADS Arguement to equate to # of times it should read the files.
static String	PARAM_RECURSE

Fields inherited from class org.apache.ctakes.core.cr.FilesInDirectoryCollectionReader

iv_currentIndex, iv_files

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

Method Summary

Modifier and Type	Method and Description
void	close()
void	getNext(org.apache.uima.cas.CAS aCAS)
int	getNumberOfDocuments() Gets the total number of documents that will be returned by this collection reader.
org.apache.uima.util.Progress[]	getProgress()
boolean	hasNext() Similar to 'org.apache.uima.collection.CollectionReader' method hasNext() except interations represents the actual number of documents to be processed, so if the total number of documents in a queue is more than the 'Iterations' value then only the iteration amount will be processed.
void	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, 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

PARAM_INPUTDIR

public static final String PARAM_INPUTDIR

Name of configuration parameter that must be set to the path of a directory containing input files.

See Also:

Constant Field Values

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_LANGUAGE

public static final String PARAM_LANGUAGE

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified this information will be added to the CAS.

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

PARAM_NUMREADS

public static final String PARAM_NUMREADS

Arguement to equate to # of times it should read the files. Takes this argument to equate to # of times it should read the files.

See Also:

Constant Field Values

PARAM_RECURSE

public static final String PARAM_RECURSE

See Also:

Constant Field Values

Constructor Detail

FilesInDirectoryCollectionCyclicalReads

public FilesInDirectoryCollectionCyclicalReads()

Method Detail

initialize

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

Overrides:

initialize in class FilesInDirectoryCollectionReader

Throws:

org.apache.uima.resource.ResourceInitializationException

See Also:

CollectionReader_ImplBase.initialize()

hasNext

public boolean hasNext()

Similar to 'org.apache.uima.collection.CollectionReader' method hasNext() except interations represents the actual number of documents to be processed, so if the total number of documents in a queue is more than the 'Iterations' value then only the iteration amount will be processed. Multiples of the total available documents will be provided to supplement the list required to meet the total iteration value.

Specified by:

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

Overrides:

hasNext in class FilesInDirectoryCollectionReader

See Also:

BaseCollectionReader.hasNext()

getNext

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

Specified by:

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

Overrides:

getNext in class FilesInDirectoryCollectionReader

Throws:

IOException

org.apache.uima.collection.CollectionException

See Also:

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

close

public void close()
           throws IOException

Specified by:

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

Overrides:

close in class FilesInDirectoryCollectionReader

Throws:

IOException

See Also:

BaseCollectionReader.close()

getProgress

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

Specified by:

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

Overrides:

getProgress in class FilesInDirectoryCollectionReader

See Also:

BaseCollectionReader.getProgress()

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.

Overrides:

getNumberOfDocuments in class FilesInDirectoryCollectionReader

Returns:

the number of documents in the collection