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

Class Pdf2CasConverter

java.lang.Object

PDFStreamEngine

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

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

public class Pdf2CasConverter
extends PdfLayoutEventStripper

Converts a PDF to a CAS. Uses a substitution table.

Nested Class Summary

Nested classes/interfaces inherited from class de.tudarmstadt.ukp.dkpro.core.io.pdf.PdfLayoutEventStripper

PdfLayoutEventStripper.Style, PdfLayoutEventStripper.Values

Field Summary

Fields inherited from class de.tudarmstadt.ukp.dkpro.core.io.pdf.PdfLayoutEventStripper

charactersByArticle

Constructor Summary

Constructors

Constructor and Description
Pdf2CasConverter()

Method Summary

Modifier and Type	Method and Description
protected void	endDocument(org.apache.pdfbox.pdmodel.PDDocument aPdf) This method is available for subclasses of this class.
protected void	endPage(int aStartPage, int aEndPage, int aCurrentPage, org.apache.pdfbox.pdmodel.PDPage page) End a page.
protected void	endRegion(PdfLayoutEventStripper.Style aStyle) End a region.
String	getHeadingType()
String	getParagraphType()
Trie<String>	getSubstitutionTable()
protected void	processLineSeparator()
protected void	processWordSeparator()
void	setHeadingType(String aHeadingType)
void	setParagraphType(String aParagraphType)
void	setSubstitutionTable(Trie<String> aSubstitutionTable)
protected void	startDocument(org.apache.pdfbox.pdmodel.PDDocument aPdf) This method is available for subclasses of this class.
protected void	startPage(int aFirstPage, int aLastPage, int aCurrentPage, org.apache.pdfbox.pdmodel.PDPage page) Start a new page.
protected void	startRegion(PdfLayoutEventStripper.Style aStyle) Start a new region.
protected void	writeCharacters(TextPosition aText) Write the string to the output stream.
void	writeText(org.apache.uima.cas.CAS aCas, InputStream aIs)

Methods inherited from class de.tudarmstadt.ukp.dkpro.core.io.pdf.PdfLayoutEventStripper

getCharactersByArticle, getCurrentPageNo, getEndPage, getStartPage, getStyle, processArticle, processPage, processPages, processTextPosition, setEndPage, setShouldSeparateByBeads, setStartPage, setSuppressDuplicateOverlappingText, shouldSeparateByBeads, shouldSuppressDuplicateOverlappingText, writeText

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pdf2CasConverter

public Pdf2CasConverter()
                 throws IOException

Throws:

IOException

Method Detail

writeText

public void writeText(org.apache.uima.cas.CAS aCas,
                      InputStream aIs)
               throws IOException

Throws:

IOException

startDocument

protected void startDocument(org.apache.pdfbox.pdmodel.PDDocument aPdf)
                      throws IOException

Description copied from class: PdfLayoutEventStripper

This method is available for subclasses of this class. It will be called before processing of the document start.

Specified by:

startDocument in class PdfLayoutEventStripper

Parameters:

aPdf - The PDF document that is being processed.

Throws:

IOException - If an IO error occurs.

endDocument

protected void endDocument(org.apache.pdfbox.pdmodel.PDDocument aPdf)
                    throws IOException

Description copied from class: PdfLayoutEventStripper

This method is available for subclasses of this class. It will be called after processing of the document finishes.

Specified by:

endDocument in class PdfLayoutEventStripper

Parameters:

aPdf - The PDF document that is being processed.

Throws:

IOException - If an IO error occurs.

processLineSeparator

protected void processLineSeparator()
                             throws IOException

Specified by:

processLineSeparator in class PdfLayoutEventStripper

Throws:

IOException

processWordSeparator

protected void processWordSeparator()
                             throws IOException

Specified by:

processWordSeparator in class PdfLayoutEventStripper

Throws:

IOException

startPage

protected void startPage(int aFirstPage,
                         int aLastPage,
                         int aCurrentPage,
                         org.apache.pdfbox.pdmodel.PDPage page)
                  throws IOException

Description copied from class: PdfLayoutEventStripper

Start a new page.

Specified by:

startPage in class PdfLayoutEventStripper

Parameters:

aFirstPage - first page.

aLastPage - last page.

aCurrentPage - current page.

page - The page we are about to process.

Throws:

IOException - If there is any error writing to the stream.

endPage

protected void endPage(int aStartPage,
                       int aEndPage,
                       int aCurrentPage,
                       org.apache.pdfbox.pdmodel.PDPage page)
                throws IOException

Description copied from class: PdfLayoutEventStripper

End a page.

Specified by:

endPage in class PdfLayoutEventStripper

Parameters:

aStartPage - first page.

aEndPage - last page.

aCurrentPage - current page.

page - The page we are about to process.

Throws:

IOException - If there is any error writing to the stream.

startRegion

protected void startRegion(PdfLayoutEventStripper.Style aStyle)
                    throws IOException

Description copied from class: PdfLayoutEventStripper

Start a new region.

Specified by:

startRegion in class PdfLayoutEventStripper

Parameters:

aStyle - the style.

Throws:

IOException - If there is any error writing to the stream.

endRegion

protected void endRegion(PdfLayoutEventStripper.Style aStyle)
                  throws IOException

Description copied from class: PdfLayoutEventStripper

End a region.

Specified by:

endRegion in class PdfLayoutEventStripper

Parameters:

aStyle - the style.

Throws:

IOException - If there is any error writing to the stream.

writeCharacters

protected void writeCharacters(TextPosition aText)
                        throws IOException

Description copied from class: PdfLayoutEventStripper

Write the string to the output stream.

Specified by:

writeCharacters in class PdfLayoutEventStripper

Parameters:

aText - The text to write to the stream.

Throws:

IOException - If there is an error when writing the text.

setSubstitutionTable

public void setSubstitutionTable(Trie<String> aSubstitutionTable)

getSubstitutionTable

public Trie<String> getSubstitutionTable()

getParagraphType

public String getParagraphType()

setParagraphType

public void setParagraphType(String aParagraphType)

getHeadingType

public String getHeadingType()

setHeadingType

public void setHeadingType(String aHeadingType)