TextWriter (DKPro Core - Master Aggregator 1.7.0 API)

java.lang.Object
- org.apache.uima.analysis_component.AnalysisComponent_ImplBase
- - org.apache.uima.analysis_component.Annotator_ImplBase
  - - org.apache.uima.analysis_component.JCasAnnotator_ImplBase
    - - org.apache.uima.fit.component.JCasConsumer_ImplBase
      - de.tudarmstadt.ukp.dkpro.core.api.io.JCasFileWriter_ImplBase
        
        de.tudarmstadt.ukp.dkpro.core.io.text.TextWriter

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent
```
public class TextWriter
extends JCasFileWriter_ImplBase
```
UIMA CAS consumer writing the CAS document text as plain text file.

Author:

Richard Eckart de Castilho

- Nested Class Summary
  - Nested classes/interfaces inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.JCasFileWriter_ImplBase
    JCasFileWriter_ImplBase.NamedOutputStream
- Field Summary
  
  Fields
  Modifier and Type Field and Description
  
  static String PARAM_FILENAME_SUFFIX
  Specify the suffix of output files.
  - Fields inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.JCasFileWriter_ImplBase
    JAR_PREFIX, PARAM_COMPRESSION, PARAM_ESCAPE_DOCUMENT_ID, PARAM_STRIP_EXTENSION, PARAM_TARGET_LOCATION, PARAM_USE_DOCUMENT_ID
- Constructor Summary
  
  Constructors
  Constructor and Description
  
  TextWriter()
- Method Summary
  
  Methods
  Modifier and Type Method and Description
  
  void process(org.apache.uima.jcas.JCas aJCas)
  - Methods inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.JCasFileWriter_ImplBase
    collectionProcessComplete, getCompressionMethod, getOutputStream, getOutputStream, getRelativePath, getTargetPath, getTargetPath, isStripExtension, isUseDocumentId
  - Methods inherited from class org.apache.uima.fit.component.JCasConsumer_ImplBase
    getLogger, initialize
  - Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase
    getRequiredCasInterface, process
  - Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase
    getCasInstancesRequired, hasNext, next
  - Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase
    batchProcessComplete, destroy, getContext, getResultSpecification, reconfigure, setResultSpecification
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Fields
Modifier and Type	Field and Description
`static String`	`PARAM_FILENAME_SUFFIX` Specify the suffix of output files.

Constructors
Constructor and Description
`TextWriter()`

Methods
Modifier and Type	Method and Description
`void`	`process(org.apache.uima.jcas.JCas aJCas)`

- Field Detail
  - PARAM_FILENAME_SUFFIX
```
public static final String PARAM_FILENAME_SUFFIX
```
    Specify the suffix of output files. Default value .txt. If the suffix is not needed, provide an empty string as value.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - TextWriter
```
public TextWriter()
```
- Method Detail
  - process
```
public void process(org.apache.uima.jcas.JCas aJCas)
             throws org.apache.uima.analysis_engine.AnalysisEngineProcessException
```
    Specified by:
    
    process in class org.apache.uima.analysis_component.JCasAnnotator_ImplBase
    
    Throws:
    
    org.apache.uima.analysis_engine.AnalysisEngineProcessException

Class TextWriter

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

Methods inherited from class java.lang.Object

Field Detail

PARAM_FILENAME_SUFFIX

Constructor Detail

TextWriter

Method Detail

process