de.tudarmstadt.ukp.dkpro.core.io.tcf

Class TcfWriter

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.tcf.TcfWriter

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

public class TcfWriter
extends JCasFileWriter_ImplBase

Writer for the WebLicht TCF format.

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_EXTENSION Specify the suffix of output files.
static String	PARAM_MERGE Merge with source TCF file if one is available. Default: true
static String	PARAM_PRESERVE_IF_EMPTY If there are no annotations for a particular layer in the CAS, preserve any potentially existing annotations in the original TCF. Default: false

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

JAR_PREFIX, PARAM_COMPRESSION, PARAM_ESCAPE_DOCUMENT_ID, PARAM_OVERWRITE, PARAM_SINGULAR_TARGET, PARAM_STRIP_EXTENSION, PARAM_TARGET_LOCATION, PARAM_USE_DOCUMENT_ID

Constructor Summary

Constructors

Constructor and Description
TcfWriter()

Method Summary

Modifier and Type	Method and Description
void	casToTcfWriter(InputStream aIs, org.apache.uima.jcas.JCas aJCas, OutputStream aOs) Merge annotations from CAS into an existing TCF file.
void	casToTcfWriter(org.apache.uima.jcas.JCas aJCas, OutputStream aOs) Create TCF File from scratch
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, getTargetLocation, 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

Field Detail

PARAM_FILENAME_EXTENSION

public static final String PARAM_FILENAME_EXTENSION

Specify the suffix of output files. Default value .tcf. If the suffix is not needed, provide an empty string as value.

See Also:

Constant Field Values

PARAM_PRESERVE_IF_EMPTY

public static final String PARAM_PRESERVE_IF_EMPTY

If there are no annotations for a particular layer in the CAS, preserve any potentially existing annotations in the original TCF.
Default: false

See Also:

Constant Field Values

PARAM_MERGE

public static final String PARAM_MERGE

Merge with source TCF file if one is available.
Default: true

See Also:

Constant Field Values

Constructor Detail

TcfWriter

public TcfWriter()

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

casToTcfWriter

public void casToTcfWriter(org.apache.uima.jcas.JCas aJCas,
                           OutputStream aOs)
                    throws eu.clarin.weblicht.wlfxb.io.WLFormatException

Create TCF File from scratch

Parameters:

aJCas - the JCas.

aOs - the output stream.

Throws:

eu.clarin.weblicht.wlfxb.io.WLFormatException - if a TCF problem occurs.

casToTcfWriter

public void casToTcfWriter(InputStream aIs,
                           org.apache.uima.jcas.JCas aJCas,
                           OutputStream aOs)
                    throws eu.clarin.weblicht.wlfxb.io.WLFormatException

Merge annotations from CAS into an existing TCF file.

Parameters:

aIs - the TCF file with an existing annotation layers

aJCas - an annotated CAS object

aOs - the output stream.

Throws:

eu.clarin.weblicht.wlfxb.io.WLFormatException - if a TCF problem occurs.