de.tudarmstadt.ukp.dkpro.core.io.pdf

Class PdfReader

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.pdf.PdfReader

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

Collection reader for PDF files. Uses simple heuristics to detect headings and paragraphs.

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
static String	BUILT_IN
static String	PARAM_END_PAGE The last page to be extracted from the PDF.
static String	PARAM_HEADING_TYPE The type used to annotate headings.
static String	PARAM_PARAGRAPH_TYPE The type used to annotate paragraphs.
static String	PARAM_START_PAGE The first page to be extracted from the PDF.
static String	PARAM_SUBSTITUTION_TABLE_LOCATION The location of the substitution table use to post-process the text extracted form the PDF, e.g.

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

Method Summary

Modifier and Type	Method and Description
void	getNext(org.apache.uima.cas.CAS aCAS)
void	initialize(org.apache.uima.UimaContext aContext)

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

Field Detail

BUILT_IN

public static final String BUILT_IN

See Also:

Constant Field Values

PARAM_SUBSTITUTION_TABLE_LOCATION

public static final String PARAM_SUBSTITUTION_TABLE_LOCATION

The location of the substitution table use to post-process the text extracted form the PDF, e.g. to convert ligatures to separate characters.

See Also:

Constant Field Values

PARAM_HEADING_TYPE

public static final String PARAM_HEADING_TYPE

The type used to annotate headings.

See Also:

Constant Field Values

PARAM_PARAGRAPH_TYPE

public static final String PARAM_PARAGRAPH_TYPE

The type used to annotate paragraphs.

See Also:

Constant Field Values

PARAM_START_PAGE

public static final String PARAM_START_PAGE

The first page to be extracted from the PDF.

See Also:

Constant Field Values

PARAM_END_PAGE

public static final String PARAM_END_PAGE

The last page to be extracted from the PDF.

See Also:

Constant Field Values

Constructor Detail

PdfReader

public PdfReader()

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