com.screenscraper.util.parsing.pdf.pdftohtml

Class PdfFileConverter

java.lang.Object

com.screenscraper.util.parsing.pdf.pdftohtml.PdfFileConverter

public class PdfFileConverter
extends java.lang.Object

Class used to do a basic conversion on the file

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
PdfFileConverter(ScrapingSession session, java.lang.String pathToPdfToHtmlExecutable) Creates the processor

Method Summary

Modifier and Type	Method and Description
java.lang.String	outputPrettyXML(org.jdom2.Element root) Outputs the root as pretty XML
PdfToHtmlParseData	parsePdfFile(java.io.File file) Parses the given file, and returns the root Element of the document, or null if the document failed to parse or had no root.
PdfToHtmlParseData	parsePdfFile(java.lang.String file) Parses the given file, and returns the root Element of the document, or null if the document failed to parse or had no root.
org.jdom2.Element	parseString(java.lang.String xmlString) Parses the string and returns the XML Element
org.jdom2.Element	parseXmlFile(java.io.File file, java.lang.String encoding) Parses the given file, and returns the root Element of the document, or null if the document failed to parse or had no root.
org.jdom2.Element	parseXmlFile(java.lang.String file, java.lang.String encoding) Parses the given file, and returns the root Element of the document, or null if the document failed to parse or had no root.

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfFileConverter

public PdfFileConverter(@Nullable
                        ScrapingSession session,
                        @NotNull
                        java.lang.String pathToPdfToHtmlExecutable)

Creates the processor

Parameters:

session - The current session (for logging purposes)

pathToPdfToHtmlExecutable - The location of PDF to HTML

Method Detail

outputPrettyXML

public java.lang.String outputPrettyXML(@NotNull
                                        org.jdom2.Element root)

Outputs the root as pretty XML

Parameters:

root - The root node

Returns:

A String of pretty XML representing the root

parseString

@Nullable
public org.jdom2.Element parseString(@NotNull
                                                java.lang.String xmlString)
                                         throws org.jdom2.JDOMException,
                                                java.io.IOException

Parses the string and returns the XML Element

Parameters:

xmlString - The xml string

Returns:

An Element representing the root of the xml

Throws:

java.io.IOException - On error with IO (shouldn't happen)

org.jdom2.JDOMException - On error parsing the input string

parseXmlFile

@Nullable
public org.jdom2.Element parseXmlFile(@NotNull
                                                 java.lang.String file,
                                                 @Nullable
                                                 java.lang.String encoding)
                                          throws java.io.IOException,
                                                 org.jdom2.JDOMException

Parses the given file, and returns the root Element of the document, or null if the document failed to parse or had no root.

Parameters:

file - The file to parse

encoding - The encoding of the file, or null to use the System default

Returns:

The Parsed Data

Throws:

java.io.IOException - On error reading the file

org.jdom2.JDOMException - On error parsing the file

parseXmlFile

@Nullable
public org.jdom2.Element parseXmlFile(@NotNull
                                                 java.io.File file,
                                                 @Nullable
                                                 java.lang.String encoding)
                                          throws java.io.IOException,
                                                 org.jdom2.JDOMException

Parses the given file, and returns the root Element of the document, or null if the document failed to parse or had no root.

Parameters:

file - The file to parse

encoding - The encoding of the file, or null to use the system default

Returns:

The Parsed Data

Throws:

java.io.IOException - On error reading the file

org.jdom2.JDOMException - On error parsing the file

parsePdfFile

@Nullable
public PdfToHtmlParseData parsePdfFile(@NotNull
                                                  java.lang.String file)

Parses the given file, and returns the root Element of the document, or null if the document failed to parse or had no root.

Parameters:

file - The file to parse

Returns:

The Parsed Data

parsePdfFile

@Nullable
public PdfToHtmlParseData parsePdfFile(@NotNull
                                                  java.io.File file)

Parses the given file, and returns the root Element of the document, or null if the document failed to parse or had no root.

Parameters:

file - The file to parse

Returns:

The Parsed Data