de.tudarmstadt.ukp.dkpro.core.io.negra

Class NegraExportReader

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.JCasCollectionReader_ImplBase

de.tudarmstadt.ukp.dkpro.core.io.negra.NegraExportReader

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 NegraExportReader
extends org.apache.uima.fit.component.JCasCollectionReader_ImplBase

This CollectionReader reads a file which is formatted in the NEGRA export format. The texts and add. information like constituent structure is reproduced in CASes, one CAS per text (article) .

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NegraExportReader.DocumentUnit

Field Summary

Fields

Modifier and Type	Field and Description
protected String	mappingPosLocation
static String	PARAM_COLLECTION_ID The collection ID to the written to the document meta data.
static String	PARAM_DOCUMENT_UNIT What indicates if a new CAS should be started.
static String	PARAM_GENERATE_NEW_IDS If true, the unit IDs are used only to detect if a new document (CAS) needs to be created, but for the purpose of setting the document ID, a new ID is generated.
static String	PARAM_LANGUAGE The language.
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_LEMMA Write lemma information.
static String	PARAM_READ_PENN_TREE Write Penn Treebank bracketed structure information.
static String	PARAM_READ_POS Write part-of-speech information.
static String	PARAM_SOURCE_ENCODING Character encoding of the input data.
static String	PARAM_SOURCE_LOCATION Location from which the input is read.
protected String	posTagset

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

Method Summary

Modifier and Type	Method and Description
void	close()
void	getNext(org.apache.uima.jcas.JCas aJCas)
org.apache.uima.util.Progress[]	getProgress()
boolean	hasNext()
void	initialize(org.apache.uima.UimaContext aContext)

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

getLogger, getNext, 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_LOCATION

public static final String PARAM_SOURCE_LOCATION

Location from which the input is read.

See Also:

Constant Field Values

PARAM_LANGUAGE

public static final String PARAM_LANGUAGE

The language.

See Also:

Constant Field Values

PARAM_SOURCE_ENCODING

public static final String PARAM_SOURCE_ENCODING

Character encoding of the input data.

See Also:

Constant Field Values

PARAM_READ_POS

public static final String PARAM_READ_POS

Write part-of-speech information. Default: true

See Also:

Constant Field Values

PARAM_READ_LEMMA

public static final String PARAM_READ_LEMMA

Write lemma information. Default: true

See Also:

Constant Field Values

PARAM_READ_PENN_TREE

public static final String PARAM_READ_PENN_TREE

Write Penn Treebank bracketed structure information. Mind this may not work with all tagsets, in particular not with such that contain "(" or ")" in their tags. The tree is generated using the original tag set in the corpus, not using the mapped tagset! Default: false

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_COLLECTION_ID

public static final String PARAM_COLLECTION_ID

The collection ID to the written to the document meta data. (Default: none)

See Also:

Constant Field Values

PARAM_GENERATE_NEW_IDS

public static final String PARAM_GENERATE_NEW_IDS

If true, the unit IDs are used only to detect if a new document (CAS) needs to be created, but for the purpose of setting the document ID, a new ID is generated. (Default: false)

See Also:

Constant Field Values

PARAM_DOCUMENT_UNIT

public static final String PARAM_DOCUMENT_UNIT

What indicates if a new CAS should be started. E.g., if set to ORIGIN_NAME, a new CAS is generated whenever the origin name of the current sentence differs from the origin name of the last sentence. (Default: ORIGIN_NAME)

See Also:

Constant Field Values

Constructor Detail

NegraExportReader

public NegraExportReader()

Method Detail

initialize

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

Overrides:

initialize in class org.apache.uima.fit.component.JCasCollectionReader_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

getNext

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

Specified by:

getNext in class org.apache.uima.fit.component.JCasCollectionReader_ImplBase

Throws:

IOException

hasNext

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

Throws:

IOException

org.apache.uima.collection.CollectionException

getProgress

public org.apache.uima.util.Progress[] getProgress()

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.JCasCollectionReader_ImplBase

Throws:

IOException