de.tudarmstadt.ukp.dkpro.core.io.imscwb

Class ImsCwbReader

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.imscwb.ImsCwbReader

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

Reads a tab-separated format including pseudo-XML tags.

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_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_ID_IS_URL If true, the unit text ID encoded in the corpus file is stored as the URI in the document meta 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 Specify which tag set should be used to locate the mapping file.
static String	PARAM_READ_LEMMA Read lemmas.
static String	PARAM_READ_POS Read part-of-speech tags and generate POS annotations or subclasses if a tag set or mapping file is used.
static String	PARAM_READ_SENTENCES Read sentences.
static String	PARAM_READ_TOKEN Read tokens and generate Token annotations.
static String	PARAM_REPLACE_NON_XML Replace non-XML characters with spaces.
static String	PARAM_SOURCE_ENCODING Character encoding of the output.
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
ImsCwbReader()

Method Summary

Modifier and Type	Method and Description
void	getNext(org.apache.uima.cas.CAS aCAS)
org.apache.uima.util.Progress[]	getProgress()
boolean	hasNext()
void	initialize(org.apache.uima.UimaContext aContext)

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

getBase, getBase, getDefaultExcludes, getLanguage, 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_SOURCE_ENCODING

public static final String PARAM_SOURCE_ENCODING

Character encoding of the output.

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

Specify which tag set should be used to locate the mapping file.

See Also:

Constant Field Values

posTagset

protected String posTagset

PARAM_READ_TOKEN

public static final String PARAM_READ_TOKEN

Read tokens and generate Token annotations. Default: true

See Also:

Constant Field Values

PARAM_READ_POS

public static final String PARAM_READ_POS

Read part-of-speech tags and generate POS annotations or subclasses if a tag set or mapping file is used. Default: true

See Also:

Constant Field Values

PARAM_READ_SENTENCES

public static final String PARAM_READ_SENTENCES

Read sentences. Default: true

See Also:

Constant Field Values

PARAM_READ_LEMMA

public static final String PARAM_READ_LEMMA

Read lemmas. Default: true

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_ID_IS_URL

public static final String PARAM_ID_IS_URL

If true, the unit text ID encoded in the corpus file is stored as the URI in the document meta data. This setting has is not affected by PARAM_GENERATE_NEW_IDS (Default: false)

See Also:

Constant Field Values

PARAM_REPLACE_NON_XML

public static final String PARAM_REPLACE_NON_XML

Replace non-XML characters with spaces. (Default: true)

See Also:

Constant Field Values

Constructor Detail

ImsCwbReader

public ImsCwbReader()

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

getProgress

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

Specified by:

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

Overrides:

getProgress in class ResourceCollectionReaderBase