TueppReader (DKPro Core - Master Aggregator 1.7.0 API)

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.tuepp.TueppReader

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 TueppReader
extends JCasResourceCollectionReader_ImplBase
```
UIMA collection reader for Tübingen Partially Parsed Corpus of Written German (TüPP-D/Z) XML files.
- Only the part-of-speech with the best rank (rank 1) is read, if there is a tie between multiple tags, the first one from the XML file is read.
- Only the first lemma (baseform) from the XML file is read.
- Token are read, but not the specific kind of token (e.g. TEL, AREA, etc.).
- Article boundaries are not read.
- Paragraph boundaries are not read.
- Lemma information is read, but morphological information is not read.
- Chunk, field, and clause information is not read.
- Meta data headers are not read.

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
`protected String`	`mappingPosLocation`
`static String`	`PARAM_ENCODING` Character encoding of the input data.
`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.
`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_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

TueppReader()

Constructors
Constructor and Description
`TueppReader()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`destroy()`
`void`	`getNext(org.apache.uima.jcas.JCas aJCas)` Subclasses implement this method rather than `JCasResourceCollectionReader_ImplBase.getNext(CAS)`
`boolean`	`hasNext()`
`void`	`initialize(org.apache.uima.UimaContext aContext)`
`static boolean`	`isEndElement(XMLEvent aEvent, String aElement)`
`static boolean`	`isStartElement(XMLEvent aEvent, String aElement)`
`protected void`	`readToken(org.apache.uima.fit.factory.JCasBuilder aBuilder, de.tudarmstadt.ukp.dkpro.core.io.tuepp.internal.model.TueppToken aToken)`

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, 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
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, 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_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_ENCODING
```
public static final String PARAM_ENCODING
```
    Character encoding of the input data.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - TueppReader
```
public TueppReader()
```
- 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
  - destroy
```
public void destroy()
```
    Specified by:
    
    destroy in interface org.apache.uima.resource.Resource
    
    Overrides:
    
    destroy in class org.apache.uima.collection.CollectionReader_ImplBase
  - 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.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.
  - readToken
```
protected void readToken(org.apache.uima.fit.factory.JCasBuilder aBuilder,
             de.tudarmstadt.ukp.dkpro.core.io.tuepp.internal.model.TueppToken aToken)
```
  - isStartElement
```
public static boolean isStartElement(XMLEvent aEvent,
                     String aElement)
```
  - isEndElement
```
public static boolean isEndElement(XMLEvent aEvent,
                   String aElement)
```

Class TueppReader

Nested Class Summary

Nested classes/interfaces inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.ResourceCollectionReaderBase

Field Summary

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

Fields inherited from interface org.apache.uima.resource.Resource

Constructor Summary

Method Summary

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

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

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

Methods inherited from class org.apache.uima.collection.CollectionReader_ImplBase

Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase

Methods inherited from class org.apache.uima.resource.Resource_ImplBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.uima.resource.ConfigurableResource

Methods inherited from interface org.apache.uima.resource.Resource

Field Detail

PARAM_POS_MAPPING_LOCATION

mappingPosLocation

PARAM_POS_TAG_SET

posTagset

PARAM_ENCODING

Constructor Detail

TueppReader

Method Detail

initialize

destroy

hasNext

getNext

readToken

isStartElement

isEndElement