com.screenscraper.util.parsing.pdf.pdftohtml

Class PdfManipulatorBuilder

java.lang.Object

com.screenscraper.util.parsing.pdf.pdftohtml.PdfManipulatorBuilder

public class PdfManipulatorBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PdfManipulatorBuilder()

Method Summary

Modifier and Type	Method and Description
PdfManipulator	build() Builds the manipulator based on the input set on the builder
PdfManipulatorBuilder	setBlockMergeChecker(PdfBlockMergeChecker blockMergeChecker) Used to determine if two adjacent blocks should be merged or not
PdfManipulatorBuilder	setColumnDeterminer(PdfColumnDeterminer columnDeterminer) Used to determine the column number for an element (if a column split was requested)
PdfManipulatorBuilder	setConvertFontStylesToAttributes(boolean convertFontStylesToAttributes) Flag to indicate stripping bold and italic tags and placing attributes on the element for them (also removing them from the element)
PdfManipulatorBuilder	setConvertPageBlockToAttribute(boolean convertPageBlockToAttribute) Flag to indicate removing pages and instead putting a page number attribute on each element
PdfManipulatorBuilder	setLocationTolerance(int locationTolerance) The amount of tolerance for the location of elements.
PdfManipulatorBuilder	setMaxColumnSpan(int maxColumnSpan) Maximum number of columns an element is allowed to be in before being stripped from the output as a bad element (default value is 1 meaning just the one cell).
PdfManipulatorBuilder	setPageValidator(PdfPageValidator pageValidator) Used to determine if the current page should be discarded or kept.
PdfManipulatorBuilder	setPostColumnsPageValidator(PdfPageValidator postColumnsPageValidator) Used to determine if the current page should be discarded or kept.
PdfManipulatorBuilder	setPredeterminedColumnLocations(java.util.Collection<java.lang.Integer> predeterminedColumnLocations) Collection of the left value for each column.
PdfManipulatorBuilder	setPredeterminedColumnLocations(int[] predeterminedColumnLocations) Array of the left value for each column.
PdfManipulatorBuilder	setPredeterminedColumnLocationsAndWidths(java.util.Map<java.lang.Integer,java.lang.Integer> predeterminedColumnLocationsAndWidths) Map of column locations and widths to use (don't try to calculate them)
PdfManipulatorBuilder	setPreserveFontFaceInformation(boolean preserveFontFaceInformation) Flag to indicate the desire to preserve font face information as additional tag attributes on each element
PdfManipulatorBuilder	setPreserveImages(boolean preserveImages) Sets whether or not image tags should be preserved in the output
PdfManipulatorBuilder	setPreSortElementsBeforePageAndTextValidation(boolean sortBeforePageAndTextValidation) Flag to indicate if sorting of elements should occur before the page and text validation code is run.
PdfManipulatorBuilder	setRemoveEmptyTextElements(boolean removeEmptyTextElements) Flag to indicate whether empty (and whitespace only) text elements should be removed automatically
PdfManipulatorBuilder	setRemoveItemsNotInColumns(boolean removeItemsNotInColumns) Flag to indicate to remove text elements that don't fit into a column (when column splitting is enabled)
PdfManipulatorBuilder	setResortBlocksRowOrder(java.lang.Boolean resortBlocksRowOrder) Flag to indicate that after whitespace has separated things into blocks, and the block merger has run, elements inside the block should be resorted.
PdfManipulatorBuilder	setSortElements(boolean sortElements) Flag to indicate if sorting of elements should occur
PdfManipulatorBuilder	setSortRowOrder(boolean sortRowOrder) Flag to indicate sorting rows over columns if split into columns.
PdfManipulatorBuilder	setSplitIntoColumns(boolean splitIntoColumns) Flag to indicate trying to split into columns (and add a column attribute)
PdfManipulatorBuilder	setTextValidator(PdfTextValidator textValidator) Used to determine if a given text element should be saved or not.
PdfManipulatorBuilder	setWhiteSpaceDividerHeightAmount(int whiteSpaceDividerHeightAmount) Amount to consider as white space between elements (height wise).

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfManipulatorBuilder

public PdfManipulatorBuilder()

Method Detail

setResortBlocksRowOrder

@NotNull
public PdfManipulatorBuilder setResortBlocksRowOrder(@Nullable
                                                               java.lang.Boolean resortBlocksRowOrder)

Flag to indicate that after whitespace has separated things into blocks, and the block merger has run, elements inside the block should be resorted.

Parameters:

resortBlocksRowOrder - Flag to indicate that after whitespace has separated things into blocks, and the block merger has run, elements inside the block should be resorted. True to resort block elements into row order, false to resort them to column order, or null to leave unchanged from the order they were in when put into a block

Returns:

Builder for chaining

Since:

7.0.5a

setPreserveFontFaceInformation

@NotNull
public PdfManipulatorBuilder setPreserveFontFaceInformation(boolean preserveFontFaceInformation)

Flag to indicate the desire to preserve font face information as additional tag attributes on each element

Parameters:

preserveFontFaceInformation - Flag to indicate the desire to preserve font face information as additional tag attributes on each element

Returns:

Builder for chaining

setRemoveEmptyTextElements

@NotNull
public PdfManipulatorBuilder setRemoveEmptyTextElements(boolean removeEmptyTextElements)

Flag to indicate whether empty (and whitespace only) text elements should be removed automatically

Parameters:

removeEmptyTextElements - Flag to indicate whether empty (and whitespace only) text elements should be removed automatically

Returns:

Builder for chaining

Since:

7.0.7a

setConvertPageBlockToAttribute

@NotNull
public PdfManipulatorBuilder setConvertPageBlockToAttribute(boolean convertPageBlockToAttribute)

Flag to indicate removing pages and instead putting a page number attribute on each element

Parameters:

convertPageBlockToAttribute - Flag to indicate removing pages and instead putting a page number attribute on each element

Returns:

Builder for chaining

setConvertFontStylesToAttributes

@NotNull
public PdfManipulatorBuilder setConvertFontStylesToAttributes(boolean convertFontStylesToAttributes)

Flag to indicate stripping bold and italic tags and placing attributes on the element for them (also removing them from the element)

Parameters:

convertFontStylesToAttributes - Flag to indicate stripping bold and italic tags and placing attributes on the element for them (also removing them from the element)

Returns:

Builder for chaining

setPreSortElementsBeforePageAndTextValidation

@NotNull
public PdfManipulatorBuilder setPreSortElementsBeforePageAndTextValidation(boolean sortBeforePageAndTextValidation)

Flag to indicate if sorting of elements should occur before the page and text validation code is run. Regardless of this setting the sort will be called after it is run

Parameters:

sortBeforePageAndTextValidation - Flag to indicate if sorting of elements should occur before the page and text validation code is run. Regardless of this setting the sort will be called after it is run

Returns:

Builder for chaining

Since:

7.0.4a

setSortElements

@NotNull
public PdfManipulatorBuilder setSortElements(boolean sortElements)

Flag to indicate if sorting of elements should occur

Parameters:

sortElements - Flag to indicate if sorting of elements should occur

Returns:

Builder for chaining

setSortRowOrder

@NotNull
public PdfManipulatorBuilder setSortRowOrder(boolean sortRowOrder)

Flag to indicate sorting rows over columns if split into columns. Otherwise this is the default sort order anyway

Parameters:

sortRowOrder - Flag to indicate sorting rows over columns if split into columns. Otherwise this is the default sort order anyway. True to sort by row, false to sort by column

Returns:

Builder for chaining

setSplitIntoColumns

@NotNull
public PdfManipulatorBuilder setSplitIntoColumns(boolean splitIntoColumns)

Flag to indicate trying to split into columns (and add a column attribute)

Parameters:

splitIntoColumns - Flag to indicate trying to split into columns (and add a column attribute)

Returns:

Builder for chaining

setRemoveItemsNotInColumns

@NotNull
public PdfManipulatorBuilder setRemoveItemsNotInColumns(boolean removeItemsNotInColumns)

Flag to indicate to remove text elements that don't fit into a column (when column splitting is enabled)

Parameters:

removeItemsNotInColumns - Flag to indicate to remove text elements that don't fit into a column (when column splitting is enabled)

Returns:

Builder for chaining

Since:

7.0.1a

setWhiteSpaceDividerHeightAmount

@NotNull
public PdfManipulatorBuilder setWhiteSpaceDividerHeightAmount(int whiteSpaceDividerHeightAmount)

Amount to consider as white space between elements (height wise). If set to greater than Integer.MIN_VALUE this indicates we should break into blocks

Parameters:

whiteSpaceDividerHeightAmount - Amount to consider as white space between elements (height wise). If set to greater than Integer.MIN_VALUE this indicates we should break into blocks

Returns:

Builder for chaining

setLocationTolerance

@NotNull
public PdfManipulatorBuilder setLocationTolerance(int locationTolerance)

The amount of tolerance for the location of elements. For example, if most of your elements are at 200, but you set tolerance to 2, then elements at 202 would also be included in the same location

Parameters:

locationTolerance - The amount of tolerance for the location of elements. For example, if most of your elements are at 200, but you set tolerance to 2, then elements at 202 would also be included in the same location

Returns:

Builder for chaining

setPreserveImages

@NotNull
public PdfManipulatorBuilder setPreserveImages(boolean preserveImages)

Sets whether or not image tags should be preserved in the output

Parameters:

preserveImages - True iff image tags should be preserved, false otherwise

Returns:

Builder for chaining

setPageValidator

@NotNull
public PdfManipulatorBuilder setPageValidator(@Nullable
                                                        PdfPageValidator pageValidator)

Used to determine if the current page should be discarded or kept. Note that if you opt to keep images the elements passed in will include them. This is called BEFORE columns are marked on elements (if column marking occurs)

Parameters:

pageValidator - Used to determine if the current page should be discarded or kept

Returns:

Builder for chaining

setPostColumnsPageValidator

@NotNull
public PdfManipulatorBuilder setPostColumnsPageValidator(@Nullable
                                                                   PdfPageValidator postColumnsPageValidator)

Used to determine if the current page should be discarded or kept. Note that if you opt to keep images the elements passed in will include them. This is called AFTER columns are marked on elements (if column marking occurs)

Parameters:

postColumnsPageValidator - Used to determine if the current page should be discarded or kept

Returns:

Builder for chaining

Since:

7.0.11a

setTextValidator

@NotNull
public PdfManipulatorBuilder setTextValidator(@Nullable
                                                        PdfTextValidator textValidator)

Used to determine if a given text element should be saved or not. Note that if you opt to keep images the elements passed in will include them. This is called BEFORE columns are marked on elements (if column marking occurs)

Parameters:

textValidator - Used to determine if a given element should be saved or not

Returns:

Builder for chaining

setBlockMergeChecker

@NotNull
public PdfManipulatorBuilder setBlockMergeChecker(@Nullable
                                                            PdfBlockMergeChecker blockMergeChecker)

Used to determine if two adjacent blocks should be merged or not

Parameters:

blockMergeChecker - The checker that will be called to potentially merge blocks after they've been separated

Returns:

Builder for chaining

Since:

7.0.5a

setColumnDeterminer

@NotNull
public PdfManipulatorBuilder setColumnDeterminer(@Nullable
                                                           PdfColumnDeterminer columnDeterminer)

Used to determine the column number for an element (if a column split was requested)

Parameters:

columnDeterminer - Used to determine the column number for an element (if a column split was requested)

Returns:

Builder for chaining

setPredeterminedColumnLocations

@NotNull
public PdfManipulatorBuilder setPredeterminedColumnLocations(@NotNull
                                                                       int[] predeterminedColumnLocations)

Array of the left value for each column. The widths will be determined as (location[i + 1] - location[i]) and a really large width for the final column

Parameters:

predeterminedColumnLocations - Collection of the left value for each column

Returns:

Builder for chaining

setPredeterminedColumnLocations

@NotNull
public PdfManipulatorBuilder setPredeterminedColumnLocations(@NotNull
                                                                       java.util.Collection<java.lang.Integer> predeterminedColumnLocations)

Collection of the left value for each column. The widths will be determined as (location[i + 1] - location[i]) and a really large width for the final column

Parameters:

predeterminedColumnLocations - Collection of the left value for each column

Returns:

Builder for chaining

setPredeterminedColumnLocationsAndWidths

@NotNull
public PdfManipulatorBuilder setPredeterminedColumnLocationsAndWidths(java.util.Map<java.lang.Integer,java.lang.Integer> predeterminedColumnLocationsAndWidths)

Map of column locations and widths to use (don't try to calculate them)

Parameters:

predeterminedColumnLocationsAndWidths - Map of column locations and widths to use (don't try to calculate them)

Returns:

Builder for chaining

setMaxColumnSpan

@NotNull
public PdfManipulatorBuilder setMaxColumnSpan(int maxColumnSpan)

Maximum number of columns an element is allowed to be in before being stripped from the output as a bad element (default value is 1 meaning just the one cell). This setting only has meaning when column splitting has been set to occur

Parameters:

maxColumnSpan - Maximum number of columns an element is allowed to be in before being stripped from the output as a bad element (default value is 1 meaning just the one cell). Must be greater than 0

Returns:

Builder for chaining

Since:

7.0.4a

build

@Nullable
public PdfManipulator build()

Builds the manipulator based on the input set on the builder

Returns:

The built manipulator