org.apache.pdfbox.tools

Class PDFText2Markdown

java.lang.Object

org.apache.pdfbox.contentstream.PDFStreamEngine

org.apache.pdfbox.text.PDFTextStripper

org.apache.pdfbox.tools.PDFText2Markdown

public class PDFText2Markdown
extends PDFTextStripper

Convert PDF text to Markdown format. Each line in the PDF is converted to a corresponding Markdown paragraph. Bold and italic formatting is also applied based on font properties.

Author:

Saurav Rawat

Field Summary

Fields inherited from class org.apache.pdfbox.text.PDFTextStripper

charactersByArticle, document, LINE_SEPARATOR, output

Constructor Summary

Constructors

Constructor and Description
PDFText2Markdown() Constructor.

Method Summary

Modifier and Type	Method and Description
protected float	computeFontHeight(PDFont font) Compute the font height.
protected void	endArticle() Write out the article separator.
protected void	showGlyph(Matrix textRenderingMatrix, PDFont font, int code, String unicode, Vector displacement) Called when a glyph is to be processed.
protected void	startArticle(boolean isLTR) Write out the article separator with proper text direction information.
protected void	writeParagraphEnd() Writes the Markdown paragraph end to the output.
protected void	writeString(String chars) Write a string to the output stream and escape some Markdown characters.
protected void	writeString(String text, List<TextPosition> textPositions) Write a string to the output stream, maintain font state, and escape some Markdown characters.

Methods inherited from class org.apache.pdfbox.text.PDFTextStripper

beginMarkedContentSequence, endDocument, endMarkedContentSequence, endPage, getAddMoreFormatting, getArticleEnd, getArticleStart, getAverageCharTolerance, getCharactersByArticle, getCurrentPageNo, getDropThreshold, getEndBookmark, getEndPage, getIgnoreContentStreamSpaceGlyphs, getIndentThreshold, getLineSeparator, getListItemPatterns, getOutput, getPageEnd, getPageStart, getParagraphEnd, getParagraphStart, getSeparateByBeads, getSortByPosition, getSpacingTolerance, getStartBookmark, getStartPage, getSuppressDuplicateOverlappingText, getText, getWordSeparator, matchPattern, processPage, processPages, processTextPosition, setAddMoreFormatting, setArticleEnd, setArticleStart, setAverageCharTolerance, setDropThreshold, setEndBookmark, setEndPage, setIgnoreContentStreamSpaceGlyphs, setIndentThreshold, setLineSeparator, setListItemPatterns, setPageEnd, setPageStart, setParagraphEnd, setParagraphStart, setShouldSeparateByBeads, setSortByPosition, setSpacingTolerance, setStartBookmark, setStartPage, setSuppressDuplicateOverlappingText, setWordSeparator, startArticle, startDocument, startPage, writeCharacters, writeLineSeparator, writePage, writePageEnd, writePageStart, writeParagraphSeparator, writeParagraphStart, writeText, writeWordSeparator

Methods inherited from class org.apache.pdfbox.contentstream.PDFStreamEngine

addOperator, applyTextAdjustment, beginText, decreaseLevel, endText, getAppearance, getCurrentPage, getGraphicsStackSize, getGraphicsState, getInitialMatrix, getLevel, getResources, getTextLineMatrix, getTextMatrix, increaseLevel, isShouldProcessColorOperators, operatorException, processAnnotation, processChildStream, processOperator, processOperator, processSoftMask, processTilingPattern, processTilingPattern, processTransparencyGroup, processType3Stream, registerOperatorProcessor, restoreGraphicsStack, restoreGraphicsState, saveGraphicsStack, saveGraphicsState, setLineDashPattern, setTextLineMatrix, setTextMatrix, showAnnotation, showFontGlyph, showFontGlyph, showForm, showGlyph, showText, showTextString, showTextStrings, showTransparencyGroup, showType3Glyph, showType3Glyph, transformedPoint, transformWidth, unsupportedOperator

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFText2Markdown

public PDFText2Markdown()
                 throws IOException

Constructor.

Throws:

IOException - If there is an error during initialization.

Method Detail

startArticle

protected void startArticle(boolean isLTR)
                     throws IOException

Write out the article separator with proper text direction information.

Overrides:

startArticle in class PDFTextStripper

Parameters:

isLTR - true if direction of text is left to right

Throws:

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

endArticle

protected void endArticle()
                   throws IOException

Write out the article separator.

Overrides:

endArticle in class PDFTextStripper

Throws:

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

writeString

protected void writeString(String text,
                           List<TextPosition> textPositions)
                    throws IOException

Write a string to the output stream, maintain font state, and escape some Markdown characters. The font state is only preserved per word.

Overrides:

writeString in class PDFTextStripper

Parameters:

text - The text to write to the stream.

textPositions - The corresponding text positions.

Throws:

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

writeString

protected void writeString(String chars)
                    throws IOException

Write a string to the output stream and escape some Markdown characters.

Overrides:

writeString in class PDFTextStripper

Parameters:

chars - String to be written to the stream.

Throws:

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

writeParagraphEnd

protected void writeParagraphEnd()
                          throws IOException

Writes the Markdown paragraph end to the output. Furthermore, it will also clear the font state.

Write something (if defined) at the end of a paragraph.

Overrides:

writeParagraphEnd in class PDFTextStripper

Throws:

IOException - if something went wrong

showGlyph

protected void showGlyph(Matrix textRenderingMatrix,
                         PDFont font,
                         int code,
                         String unicode,
                         Vector displacement)
                  throws IOException

Called when a glyph is to be processed. The heuristic calculations here were originally written by Ben Litchfield for PDFStreamEngine.

Overrides:

showGlyph in class PDFStreamEngine

Parameters:

textRenderingMatrix - the current text rendering matrix, T_rm

font - the current font

code - internal PDF character code for the glyph

unicode - the Unicode text for this glyph, or null if the PDF does provide it

displacement - the displacement (i.e. advance) of the glyph in text space

Throws:

IOException - if the glyph cannot be processed

computeFontHeight

protected float computeFontHeight(PDFont font)
                           throws IOException

Compute the font height. Override this if you want to use own calculations.

Parameters:

font - the font.

Returns:

the font height.

Throws:

IOException - if there is an error while getting the font bounding box.