TextReader (DKPro Core - Master Aggregator 1.7.0 API)

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.CasCollectionReader_ImplBase
      - de.tudarmstadt.ukp.dkpro.core.api.io.ResourceCollectionReaderBase
        
        de.tudarmstadt.ukp.dkpro.core.io.text.TextReader

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
```
public class TextReader
extends ResourceCollectionReaderBase
```
UIMA collection reader for plain text files.

Author:

Richard Eckart de Castilho

Nested Class Summary
- Nested classes/interfaces inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.ResourceCollectionReaderBase
  ResourceCollectionReaderBase.Resource

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ENCODING_AUTO` Automatically detect encoding.
`static String`	`PARAM_ENCODING` Name of configuration parameter that contains the character encoding used by the input files.

Fields inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.ResourceCollectionReaderBase
EXCLUDE_PREFIX, INCLUDE_PREFIX, JAR_PREFIX, KEY_RESOURCE_RESOLVER, PARAM_INCLUDE_HIDDEN, PARAM_LANGUAGE, PARAM_PATH, PARAM_PATTERNS, PARAM_SOURCE_LOCATION, PARAM_USE_DEFAULT_EXCLUDES

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

TextReader()

Constructors
Constructor and Description
`TextReader()`

Method Summary

Methods
Modifier and Type Method and Description

void getNext(org.apache.uima.cas.CAS aCAS)
- Methods inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.ResourceCollectionReaderBase
  getBase, getBase, getDefaultExcludes, getLanguage, getProgress, getResolver, getResourceIterator, getResources, getSourceLocation, hasNext, initCas, initCas, initialize, isSingleLocation, locationToUrl, nextFile, scan
- Methods inherited from class org.apache.uima.fit.component.CasCollectionReader_ImplBase
  close, getLogger, 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

Methods
Modifier and Type	Method and Description
`void`	`getNext(org.apache.uima.cas.CAS aCAS)`

- Field Detail
  - ENCODING_AUTO
```
public static final String ENCODING_AUTO
```
    Automatically detect encoding.
    
    See Also:
    CharsetDetector, 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.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - TextReader
```
public TextReader()
```
- Method Detail
  - getNext
```
public void getNext(org.apache.uima.cas.CAS aCAS)
             throws IOException,
                    org.apache.uima.collection.CollectionException
```
    Throws:
    
    IOException
    
    org.apache.uima.collection.CollectionException

Class TextReader

Nested Class Summary

Nested classes/interfaces inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.ResourceCollectionReaderBase

Field Summary

Fields inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.ResourceCollectionReaderBase

Fields inherited from interface org.apache.uima.resource.Resource

Constructor Summary

Method Summary

Methods inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.ResourceCollectionReaderBase

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

Methods inherited from class org.apache.uima.collection.CollectionReader_ImplBase

Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase

Methods inherited from class org.apache.uima.resource.Resource_ImplBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.uima.resource.ConfigurableResource

Methods inherited from interface org.apache.uima.resource.Resource

Field Detail

ENCODING_AUTO

PARAM_ENCODING

Constructor Detail

TextReader

Method Detail

getNext