public class FileSystemCollectionReader extends CollectionReader_ImplBase
InputDirectory
- path to directory containing filesEncoding
(optional) - character encoding of the input filesLanguage
(optional) - language of the input documentsModifier 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_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_LENIENT
Name of the configuration parameter that must be set to indicate if the
execution proceeds if an encountered type is unknown
|
static String |
PARAM_XCAS
Optional configuration parameter that specifies XCAS input files
|
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 and Description |
---|
FileSystemCollectionReader() |
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes this
CollectionReader , after which it may no longer be used. |
static CollectionReaderDescription |
getDescription()
Parses and returns the descriptor for this collection reader.
|
static URL |
getDescriptorURL() |
void |
getNext(CAS aCAS)
Gets the next element of the collection.
|
int |
getNumberOfDocuments()
Gets the total number of documents that will be returned by this collection reader.
|
Progress[] |
getProgress()
Gets information about the number of entities and/or amount of data that has been read from
this
CollectionReader , and the total amount that remains (if that information
is available). |
boolean |
hasNext()
Gets whether there are any elements remaining to be read from this
CollectionReader . |
void |
initialize()
This method is called during initialization, and does nothing by default.
|
destroy, getCasInitializer, getProcessingResourceMetaData, initialize, isConsuming, reconfigure, setCasInitializer, typeSystemInit
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue
getCasManager, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger, setMetaData
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue
getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger
public static final String PARAM_INPUTDIR
public static final String PARAM_ENCODING
public static final String PARAM_LANGUAGE
public static final String PARAM_XCAS
public static final String PARAM_LENIENT
public void initialize() throws ResourceInitializationException
CollectionReader_ImplBase
initialize
in class CollectionReader_ImplBase
ResourceInitializationException
- if a failure occurs during initialization.CollectionReader_ImplBase.initialize()
public boolean hasNext()
BaseCollectionReader
CollectionReader
.CollectionReader
.BaseCollectionReader.hasNext()
public void getNext(CAS aCAS) throws IOException, CollectionException
CollectionReader
CollectionReader
(see BaseCollectionReader.isConsuming()
), this
element will also be removed from the collection.aCAS
- the CAS to populate with the next element of the collectionIOException
- if an I/O failure occursCollectionException
- if there is some other problem with reading from the CollectionCollectionReader.getNext(org.apache.uima.cas.CAS)
public void close() throws IOException
BaseCollectionReader
CollectionReader
, after which it may no longer be used.IOException
- if an I/O failure occursBaseCollectionReader.close()
public Progress[] getProgress()
BaseCollectionReader
CollectionReader
, and the total amount that remains (if that information
is available).
This method returns an array of Progress
objects so that results can be reported
using different units. For example, the CollectionReader could report progress in terms of the
number of documents that have been read and also in terms of the number of bytes that have been
read. In many cases, it will be sufficient to return just one Progress
object.
Progress
objects. Each object may have different units (for
example number of entities or bytes).BaseCollectionReader.getProgress()
public int getNumberOfDocuments()
public static CollectionReaderDescription getDescription() throws InvalidXMLException
InvalidXMLException
- if the descriptor is invalid or missingpublic static URL getDescriptorURL()
Copyright © 2019. All rights reserved.