de.tudarmstadt.ukp.dkpro.core.io.brat

Class BratWriter

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.brat.BratWriter

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

public class BratWriter
extends JCasFileWriter_ImplBase

Writer for the brat annotation format.

Known issues:

• Brat is unable to read relation attributes created by this writer.
• PARAM_TYPE_MAPPINGS not implemented yet

See Also:

brat standoff format, brat configuration 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_ENABLE_TYPE_MAPPINGS Enable type mappings.
static String	PARAM_EXCLUDE_TYPES Types that will not be written to the exported file.
static String	PARAM_FILENAME_EXTENSION Specify the suffix of output files.
static String	PARAM_PALETTE Colors to be used for the visual configuration that is generated for brat.
static String	PARAM_RELATION_TYPES Types that are relations.
static String	PARAM_SHORT_ATTRIBUTE_NAMES Whether to render attributes by their short name or by their qualified name.
static String	PARAM_TEXT_ANNOTATION_TYPES Types that are text annotations (aka entities or spans).
static String	PARAM_TEXT_FILENAME_EXTENSION Specify the suffix of text output files.
static String	PARAM_TYPE_MAPPINGS FIXME
static String	PARAM_WRITE_NULL_ATTRIBUTES Enable writing of features with null values.
static String	PARAM_WRITE_RELATION_ATTRIBUTES The brat web application can currently not handle attributes on relations, thus they are disabled by default.

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
BratWriter()

Method Summary

Modifier and Type	Method and Description
void	collectionProcessComplete()
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

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_TEXT_FILENAME_EXTENSION

public static final String PARAM_TEXT_FILENAME_EXTENSION

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

See Also:

Constant Field Values

PARAM_FILENAME_EXTENSION

public static final String PARAM_FILENAME_EXTENSION

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

See Also:

Constant Field Values

PARAM_EXCLUDE_TYPES

public static final String PARAM_EXCLUDE_TYPES

Types that will not be written to the exported file.

See Also:

Constant Field Values

PARAM_TEXT_ANNOTATION_TYPES

public static final String PARAM_TEXT_ANNOTATION_TYPES

Types that are text annotations (aka entities or spans).

See Also:

Constant Field Values

PARAM_RELATION_TYPES

public static final String PARAM_RELATION_TYPES

Types that are relations. It is mandatory to provide the type name followed by two feature names that represent Arg1 and Arg2 separated by colons, e.g. de.tudarmstadt.ukp.dkpro.core.api.syntax.type.dependency.Dependency:Governor:Dependent.

See Also:

Constant Field Values

PARAM_ENABLE_TYPE_MAPPINGS

public static final String PARAM_ENABLE_TYPE_MAPPINGS

Enable type mappings.

See Also:

Constant Field Values

PARAM_TYPE_MAPPINGS

public static final String PARAM_TYPE_MAPPINGS

FIXME

See Also:

Constant Field Values

PARAM_WRITE_RELATION_ATTRIBUTES

public static final String PARAM_WRITE_RELATION_ATTRIBUTES

The brat web application can currently not handle attributes on relations, thus they are disabled by default. Here they can be enabled again.

See Also:

Constant Field Values

PARAM_WRITE_NULL_ATTRIBUTES

public static final String PARAM_WRITE_NULL_ATTRIBUTES

Enable writing of features with null values.

See Also:

Constant Field Values

PARAM_PALETTE

public static final String PARAM_PALETTE

Colors to be used for the visual configuration that is generated for brat.

See Also:

Constant Field Values

PARAM_SHORT_ATTRIBUTE_NAMES

public static final String PARAM_SHORT_ATTRIBUTE_NAMES

Whether to render attributes by their short name or by their qualified name.

See Also:

Constant Field Values

Constructor Detail

BratWriter

public BratWriter()

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

collectionProcessComplete

public void collectionProcessComplete()
                               throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Specified by:

collectionProcessComplete in interface org.apache.uima.analysis_component.AnalysisComponent

Overrides:

collectionProcessComplete in class JCasFileWriter_ImplBase

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException