XmiWriter (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.xmi.XmiWriter

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent
```
public class XmiWriter
extends JCasFileWriter_ImplBase
```
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_TYPE_SYSTEM_FILE
  Location to write the type system to.
  - 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
  
  XmiWriter()
- Method Summary
  
  Methods
  Modifier and Type Method and Description
  
  void initialize(org.apache.uima.UimaContext aContext)
  
  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
  - 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_TYPE_SYSTEM_FILE` Location to write the type system to.

Constructors
Constructor and Description
`XmiWriter()`

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

- Field Detail
  - PARAM_TYPE_SYSTEM_FILE
```
public static final String PARAM_TYPE_SYSTEM_FILE
```
    Location to write the type system to. If this is not set, a file called typesystem.xml will be written to the XMI output path. If this is set, it is expected to be a file relative to the current work directory or an absolute file.
    If this parameter is set, the JCasFileWriter_ImplBase.PARAM_COMPRESSION parameter has no effect on the type system. Instead, if the file name ends in ".gz", the file will be compressed, otherwise not.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - XmiWriter
```
public XmiWriter()
```
- Method Detail
  - initialize
```
public void initialize(org.apache.uima.UimaContext aContext)
                throws org.apache.uima.resource.ResourceInitializationException
```
    Specified by:
    
    initialize in interface org.apache.uima.analysis_component.AnalysisComponent
    
    Overrides:
    
    initialize in class org.apache.uima.fit.component.JCasConsumer_ImplBase
    
    Throws:
    
    org.apache.uima.resource.ResourceInitializationException
  - 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 XmiWriter

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_TYPE_SYSTEM_FILE

Constructor Detail

XmiWriter

Method Detail

initialize

process