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

Class BratReader

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.api.io.JCasResourceCollectionReader_ImplBase

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

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 BratReader
extends JCasResourceCollectionReader_ImplBase

Reader for the brat format.

See Also:

brat standoff format, brat configuration format

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	PARAM_RELATION_TYPES Types that are relations.
static String	PARAM_SOURCE_ENCODING Name of configuration parameter that contains the character encoding used by the input files.
static String	PARAM_TEXT_ANNOTATION_TYPES Types that are text annotations.
static String	PARAM_TYPE_MAPPINGS

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_LOG_FREQ, 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
BratReader()

Method Summary

Modifier and Type	Method and Description
void	close()
void	getNext(org.apache.uima.jcas.JCas aJCas) Subclasses implement this method rather than JCasResourceCollectionReader_ImplBase.getNext(CAS)
void	initialize(org.apache.uima.UimaContext aContext)

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

getNext, initCas, initCas

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

getBase, getBase, getDefaultExcludes, getLanguage, getProgress, getResolver, getResourceIterator, getResources, getSourceLocation, hasNext, initCas, initCas, isSingleLocation, locationToUrl, nextFile, scan

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

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, getRelativePathResolver, 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

Field Detail

PARAM_SOURCE_ENCODING

public static final String PARAM_SOURCE_ENCODING

Name of configuration parameter that contains the character encoding used by the input files.

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{A}. Additionally, a subcategorization feature may be specified.

See Also:

Constant Field Values

PARAM_TEXT_ANNOTATION_TYPES

public static final String PARAM_TEXT_ANNOTATION_TYPES

Types that are text annotations. It is mandatory to provide the type name which can optionally be followed by a subcategorization feature. Using this parameter is only necessary to specify a subcategorization feature. Otherwise, text annotation types are automatically detected.

See Also:

Constant Field Values

PARAM_TYPE_MAPPINGS

public static final String PARAM_TYPE_MAPPINGS

See Also:

Constant Field Values

Constructor Detail

BratReader

public BratReader()

Method Detail

initialize

public void initialize(org.apache.uima.UimaContext aContext)
                throws org.apache.uima.resource.ResourceInitializationException

Overrides:

initialize in class ResourceCollectionReaderBase

Throws:

org.apache.uima.resource.ResourceInitializationException

close

public void close()
           throws IOException

Specified by:

close in interface org.apache.uima.collection.base_cpm.BaseCollectionReader

Overrides:

close in class org.apache.uima.fit.component.CasCollectionReader_ImplBase

Throws:

IOException

getNext

public void getNext(org.apache.uima.jcas.JCas aJCas)
             throws IOException,
                    org.apache.uima.collection.CollectionException

Description copied from class: JCasResourceCollectionReader_ImplBase

Subclasses implement this method rather than JCasResourceCollectionReader_ImplBase.getNext(CAS)

Specified by:

getNext in class JCasResourceCollectionReader_ImplBase

Parameters:

aJCas - the JCas.

Throws:

IOException - if an i/o error occurs reading the data.

org.apache.uima.collection.CollectionException - if another type of error occurs.