com.screenscraper.util.parsing.pdf.pdftohtml

Class PdfManipulator

java.lang.Object

com.screenscraper.util.parsing.pdf.pdftohtml.PdfManipulator

public class PdfManipulator
extends java.lang.Object

Class used to manipulate the data from the PDF conversion, making it easier to deal with

Version:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BOLD_ATTRIBUTE The attribute name that will indicate the bold effect for contained text
static java.lang.String	COLUMN_NUMBER_ATTRIBUTE The attribute name that will indicate the column number
static java.util.Comparator<org.jdom2.Element>	COLUMN_ORDER Comparator to sort elements by column number
static java.lang.String	END_COLUMN_NUMBER_ATTRIBUTE The attribute name that will indicate the end column number.
static java.lang.String	FONT_COLOR_ATTRIBUTE The attribute name that will indicate the font color for the contained text
static java.lang.String	FONT_FAMILY_ATTRIBUTE The attribute name that will indicate the font family for the contained text
static java.lang.String	FONT_SIZE_ATTRIBUTE The attribute name that will indicate the font size for the contained text
static java.lang.String	ITALIC_ATTRIBUTE The attribute name that will indicate the italic effect for contained text
java.util.Comparator<org.jdom2.Element>	LEFT_TO_RIGHT_ORDER Comparator to sort elements by left value with the tolerance for this manipulator
static java.util.Comparator<org.jdom2.Element>	LEFT_TO_RIGHT_ORDER_NO_TOLERANCE Comparator to sort elements by left value
static java.lang.String	PAGE_NUMBER_ATTRIBUTE The attribute name that will indicate the page number
static java.util.Comparator<org.jdom2.Element>	PAGE_ORDER Comparator to sort elements by page number
java.util.Comparator<org.jdom2.Element>	TOP_ORDER Comparator to sort elements by top value with the tolerance for this manipulator
static java.util.Comparator<org.jdom2.Element>	TOP_ORDER_NO_TOLERANCE Comparator to sort elements by top value
java.util.Comparator<org.jdom2.Element>	TOP_TO_RIGHT_ORDER Comparator to sort elements by top value, then left value (top to bottom, left to right) with the tolerance for this manipulator
static java.util.Comparator<org.jdom2.Element>	TOP_TO_RIGHT_ORDER_NO_TOLERANCE Comparator to sort elements by top value, then left value (top to bottom, left to right)
static java.lang.String	UNDERLINE_ATTRIBUTE The attribute name that will indicate the underline effect for contained text

Constructor Summary

Constructors

Constructor and Description

PdfManipulator(boolean preserveFontFaceInformation, boolean convertPageBlockToAttribute, boolean convertFontStylesToAttributes, boolean sortElements, boolean sortRowOrder, java.lang.Boolean resortBlocksRowOrder, boolean splitIntoColumns, boolean removeItemsNotInColumns, boolean sortBeforePageAndTextValidation, boolean preserveImages, int whiteSpaceDividerHeightAmount, int locationTolerance, PdfPageValidator pageValidator, PdfPageValidator postColumnsPageValidator, PdfTextValidator textValidator, PdfBlockMergeChecker blockMergeChecker, PdfColumnDeterminer columnDeterminer, java.util.Map<java.lang.Integer,java.lang.Integer> predeterminedColumnLocationsAndWidths, int maxColumnSpan, boolean removeEmptyTextElements) Create the manipulator

Method Summary

Modifier and Type	Method and Description
org.jdom2.Element	process(org.jdom2.Element element) Perform the desired operations on the element.
org.jdom2.Element	process(org.jdom2.Element element, boolean cloneElementFirst) Perform the desired operations on the element.

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_NUMBER_ATTRIBUTE

public static final java.lang.String PAGE_NUMBER_ATTRIBUTE

The attribute name that will indicate the page number

See Also:

Constant Field Values

COLUMN_NUMBER_ATTRIBUTE

public static final java.lang.String COLUMN_NUMBER_ATTRIBUTE

The attribute name that will indicate the column number

See Also:

Constant Field Values

END_COLUMN_NUMBER_ATTRIBUTE

public static final java.lang.String END_COLUMN_NUMBER_ATTRIBUTE

The attribute name that will indicate the end column number. This is the same as the column number unless a cell spanned multiple columns

Since:

7.0.4a

See Also:

Constant Field Values

FONT_SIZE_ATTRIBUTE

public static final java.lang.String FONT_SIZE_ATTRIBUTE

The attribute name that will indicate the font size for the contained text

See Also:

Constant Field Values

FONT_FAMILY_ATTRIBUTE

public static final java.lang.String FONT_FAMILY_ATTRIBUTE

The attribute name that will indicate the font family for the contained text

See Also:

Constant Field Values

FONT_COLOR_ATTRIBUTE

public static final java.lang.String FONT_COLOR_ATTRIBUTE

The attribute name that will indicate the font color for the contained text

See Also:

Constant Field Values

BOLD_ATTRIBUTE

public static final java.lang.String BOLD_ATTRIBUTE

The attribute name that will indicate the bold effect for contained text

See Also:

Constant Field Values

ITALIC_ATTRIBUTE

public static final java.lang.String ITALIC_ATTRIBUTE

The attribute name that will indicate the italic effect for contained text

See Also:

Constant Field Values

UNDERLINE_ATTRIBUTE

public static final java.lang.String UNDERLINE_ATTRIBUTE

The attribute name that will indicate the underline effect for contained text

See Also:

Constant Field Values

PAGE_ORDER

public static final java.util.Comparator<org.jdom2.Element> PAGE_ORDER

Comparator to sort elements by page number

COLUMN_ORDER

public static final java.util.Comparator<org.jdom2.Element> COLUMN_ORDER

Comparator to sort elements by column number

TOP_ORDER_NO_TOLERANCE

public static final java.util.Comparator<org.jdom2.Element> TOP_ORDER_NO_TOLERANCE

Comparator to sort elements by top value

LEFT_TO_RIGHT_ORDER_NO_TOLERANCE

public static final java.util.Comparator<org.jdom2.Element> LEFT_TO_RIGHT_ORDER_NO_TOLERANCE

Comparator to sort elements by left value

TOP_TO_RIGHT_ORDER_NO_TOLERANCE

public static final java.util.Comparator<org.jdom2.Element> TOP_TO_RIGHT_ORDER_NO_TOLERANCE

Comparator to sort elements by top value, then left value (top to bottom, left to right)

TOP_ORDER

public final java.util.Comparator<org.jdom2.Element> TOP_ORDER

Comparator to sort elements by top value with the tolerance for this manipulator

LEFT_TO_RIGHT_ORDER

public final java.util.Comparator<org.jdom2.Element> LEFT_TO_RIGHT_ORDER

Comparator to sort elements by left value with the tolerance for this manipulator

TOP_TO_RIGHT_ORDER

public final java.util.Comparator<org.jdom2.Element> TOP_TO_RIGHT_ORDER

Comparator to sort elements by top value, then left value (top to bottom, left to right) with the tolerance for this manipulator

Constructor Detail

PdfManipulator

PdfManipulator(boolean preserveFontFaceInformation,
               boolean convertPageBlockToAttribute,
               boolean convertFontStylesToAttributes,
               boolean sortElements,
               boolean sortRowOrder,
               @Nullable
               java.lang.Boolean resortBlocksRowOrder,
               boolean splitIntoColumns,
               boolean removeItemsNotInColumns,
               boolean sortBeforePageAndTextValidation,
               boolean preserveImages,
               int whiteSpaceDividerHeightAmount,
               int locationTolerance,
               @Nullable
               PdfPageValidator pageValidator,
               @Nullable
               PdfPageValidator postColumnsPageValidator,
               @Nullable
               PdfTextValidator textValidator,
               @Nullable
               PdfBlockMergeChecker blockMergeChecker,
               @Nullable
               PdfColumnDeterminer columnDeterminer,
               @Nullable
               java.util.Map<java.lang.Integer,java.lang.Integer> predeterminedColumnLocationsAndWidths,
               int maxColumnSpan,
               boolean removeEmptyTextElements)

Create the manipulator

Parameters:

preserveFontFaceInformation - True to preserve information about the font face (font size, family, color, etc...), false otherwise

convertPageBlockToAttribute - True to convert pages to simple text elements with a page-number attribute

convertFontStylesToAttributes - True to convert font information to an attribute on the text tag (and strip it out of the text as well)

sortElements - True to sort elements by location. In the event of tables, it will sort it into column order -- all data in column 1 will be before the data in column 2

sortRowOrder - True to sort to row order, false to sort to column order. This only has effect if the sortElements flag is true, and also if we are splitting into columns

resortBlocksRowOrder - True to sort to row order inside blocks after they've been split and merged, false to sort column order, null to leave unmodified

splitIntoColumns - True to split into columns

removeItemsNotInColumns - True to remove text elements that didn't fit into a column, false otherwise

sortBeforePageAndTextValidation - True to sort elements before passing them through the page and text validators, false otherwise

preserveImages - True if image elements should be preserved, false otherwise

whiteSpaceDividerHeightAmount - True to attempt to split elements by whitespace in height. This will wrap each text element in a block tag

locationTolerance - The amount of tolerance between locations

pageValidator - The validator for checking if a page should be included or not

textValidator - The validator for checking if a text element should be included or not

blockMergeChecker - Block merge checker to see if blocks should be merged or not

columnDeterminer - The object to determine (override) the column for text elements

predeterminedColumnLocationsAndWidths - The suggested column locations and width

maxColumnSpan - The maximum number of columns an element can span (1 is efficient, more is less so for memory)

Method Detail

process

@Contract(value="!null -> !null; null -> null")
 @Nullable
public org.jdom2.Element process(@Nullable
                                                                                              org.jdom2.Element element)

Perform the desired operations on the element. The input element will not be modified, and the result will be returned as a new element

Parameters:

element - The root element (this can contain a list of page tags or a list of text tags).

Returns:

The new element, or null if the input was null

process

@Contract(value="!null, _ -> !null; null, _ -> null")
 @Nullable
public org.jdom2.Element process(@Nullable
                                                                                                    org.jdom2.Element element,
                                                                                                    boolean cloneElementFirst)

Perform the desired operations on the element. The input element will not be modified, and the result will be returned as a new element

Parameters:

element - The root element (this can contain a list of page tags or a list of text tags).

cloneElementFirst - True if the element should be cloned and we process a copy of it, false to modify the element itself (modifying the actual element will reduce overall memory use, but also loses the original element's extra data)

Returns:

The new element, or null if the input was null

Since:

7.0.6a