de.tudarmstadt.ukp.dkpro.core.io.tei

Class TeiReader

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.io.tei.TeiReader

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 TeiReader
extends ResourceCollectionReaderBase

Reader for the TEI XML.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TeiReader.Handler
class	TeiReader.TeiHandler

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
protected String	mappingPosLocation
static String	PARAM_OMIT_IGNORABLE_WHITESPACE Do not write ignoreable whitespace from the XML file to the CAS.
static String	PARAM_POS_MAPPING_LOCATION Location of the mapping file for part-of-speech tags to UIMA types.
static String	PARAM_POS_TAG_SET Use this part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data.
static String	PARAM_READ_CONSTITUENT Write constituent annotations to the CAS.
static String	PARAM_READ_LEMMA Write lemma annotations to the CAS.
static String	PARAM_READ_NAMED_ENTITY Write named entity annotations to the CAS.
static String	PARAM_READ_PARAGRAPH Write paragraphs annotations to the CAS.
static String	PARAM_READ_POS Write part-of-speech annotations to the CAS.
static String	PARAM_READ_SENTENCE Write sentence annotations to the CAS.
static String	PARAM_READ_TOKEN Write token annotations to the CAS.
static String	PARAM_USE_FILENAME_ID When not using the XML ID, use only the filename instead of the whole URL as ID.
static String	PARAM_USE_XML_ID Use the xml:id attribute on the TEI elements as document ID.
static String	PARAM_UTTERANCES_AS_SENTENCES Interpret utterances "u" as sentenes "s".
protected String	posTagset

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

Method Summary

Modifier and Type	Method and Description
void	getNext(org.apache.uima.cas.CAS aCAS)
boolean	hasNext()
void	initialize(org.apache.uima.UimaContext aContext)
protected TeiReader.Handler	newSaxHandler()

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

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

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

close, 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_READ_TOKEN

public static final String PARAM_READ_TOKEN

Write token annotations to the CAS.

See Also:

Constant Field Values

PARAM_READ_POS

public static final String PARAM_READ_POS

Write part-of-speech annotations to the CAS.

See Also:

Constant Field Values

PARAM_READ_LEMMA

public static final String PARAM_READ_LEMMA

Write lemma annotations to the CAS.

See Also:

Constant Field Values

PARAM_READ_SENTENCE

public static final String PARAM_READ_SENTENCE

Write sentence annotations to the CAS.

See Also:

Constant Field Values

PARAM_READ_CONSTITUENT

public static final String PARAM_READ_CONSTITUENT

Write constituent annotations to the CAS.

See Also:

Constant Field Values

PARAM_READ_NAMED_ENTITY

public static final String PARAM_READ_NAMED_ENTITY

Write named entity annotations to the CAS.

See Also:

Constant Field Values

PARAM_READ_PARAGRAPH

public static final String PARAM_READ_PARAGRAPH

Write paragraphs annotations to the CAS.

See Also:

Constant Field Values

PARAM_USE_XML_ID

public static final String PARAM_USE_XML_ID

Use the xml:id attribute on the TEI elements as document ID. Mind that many TEI files may not have this attribute on all TEI elements and you may end up with no document ID at all. Also mind that the IDs should be unique.

See Also:

Constant Field Values

PARAM_USE_FILENAME_ID

public static final String PARAM_USE_FILENAME_ID

When not using the XML ID, use only the filename instead of the whole URL as ID. Mind that the filenames should be unique in this case.

See Also:

Constant Field Values

PARAM_OMIT_IGNORABLE_WHITESPACE

public static final String PARAM_OMIT_IGNORABLE_WHITESPACE

Do not write ignoreable whitespace from the XML file to the CAS.

See Also:

Constant Field Values

PARAM_POS_MAPPING_LOCATION

public static final String PARAM_POS_MAPPING_LOCATION

Location of the mapping file for part-of-speech tags to UIMA types.

See Also:

Constant Field Values

mappingPosLocation

protected String mappingPosLocation

PARAM_POS_TAG_SET

public static final String PARAM_POS_TAG_SET

Use this part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

See Also:

Constant Field Values

posTagset

protected String posTagset

PARAM_UTTERANCES_AS_SENTENCES

public static final String PARAM_UTTERANCES_AS_SENTENCES

Interpret utterances "u" as sentenes "s". (EXPERIMENTAL)

See Also:

Constant Field Values

Constructor Detail

TeiReader

public TeiReader()

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

hasNext

public boolean hasNext()
                throws IOException,
                       org.apache.uima.collection.CollectionException

Specified by:

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

Overrides:

hasNext in class ResourceCollectionReaderBase

Throws:

IOException

org.apache.uima.collection.CollectionException

getNext

public void getNext(org.apache.uima.cas.CAS aCAS)
             throws IOException,
                    org.apache.uima.collection.CollectionException

Throws:

IOException

org.apache.uima.collection.CollectionException

newSaxHandler

protected TeiReader.Handler newSaxHandler()