de.tudarmstadt.ukp.dkpro.core.io.rtf

Class RTFReader

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.rtf.RTFReader

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

Read RTF (Rich Text Format) files. Uses RTFEditorKit for parsing RTF.

Nested Class Summary

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

ResourceCollectionReaderBase.Resource

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	getNext(org.apache.uima.cas.CAS aCas)
void	initialize(org.apache.uima.UimaContext aContext)
protected Document	readRTF(ResourceCollectionReaderBase.Resource resource) Read the RTF file contained in the given resource.

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

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

Constructor Detail

RTFReader

public RTFReader()

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

getNext

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

Throws:

IOException

org.apache.uima.collection.CollectionException

readRTF

protected Document readRTF(ResourceCollectionReaderBase.Resource resource)
                    throws IOException,
                           BadLocationException

Read the RTF file contained in the given resource.

Parameters:

resource - A Resource containing an RTF input stream.

Returns:

a Document containing the text of the RTF input.

Throws:

IOException - on any I/O error

BadLocationException - if RTFEditorKit.read(java.io.InputStream, Document, int) is called with an invalid location argument