org.grobid.core.document

Class DocumentSource

java.lang.Object

org.grobid.core.document.DocumentSource

public class DocumentSource
extends java.lang.Object

Input document to be processed, which could come from a PDF or directly be an XML file. If from a PDF document, this is the place where pdftoxml is called.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PDFTOXML_FILES_AMOUNT_LIMIT

Method Summary

Modifier and Type	Method and Description
void	close(boolean cleanImages, boolean cleanAnnotations, boolean cleanOutline)
static void	close(DocumentSource source, boolean cleanImages, boolean cleanAnnotations, boolean cleanOutline)
static DocumentSource	fromPdf(java.io.File pdfFile)
static DocumentSource	fromPdf(java.io.File pdfFile, int startPage, int endPage) By default the XML extracted from the PDF is without images, to avoid flooding the grobid-home/tmp directory, but with the extra annotation file and with outline
static DocumentSource	fromPdf(java.io.File pdfFile, int startPage, int endPage, boolean withImages, boolean withAnnotations, boolean withOutline)
java.io.File	getPdfFile()
java.io.File	getXmlFile()
java.io.File	pdf2xml(java.lang.Integer timeout, boolean force, int startPage, int endPage, java.io.File pdfPath, java.io.File tmpPath, boolean withImages, boolean withAnnotations, boolean withOutline) Create an XML representation from a pdf file.
void	setPdfFile(java.io.File pdfFile)
void	setXmlFile(java.io.File xmlFile)

Methods inherited from class java.lang.Object

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

Field Detail

PDFTOXML_FILES_AMOUNT_LIMIT

public static final int PDFTOXML_FILES_AMOUNT_LIMIT

See Also:

Constant Field Values

Method Detail

fromPdf

public static DocumentSource fromPdf(java.io.File pdfFile)

fromPdf

public static DocumentSource fromPdf(java.io.File pdfFile,
                                     int startPage,
                                     int endPage)

By default the XML extracted from the PDF is without images, to avoid flooding the grobid-home/tmp directory, but with the extra annotation file and with outline

fromPdf

public static DocumentSource fromPdf(java.io.File pdfFile,
                                     int startPage,
                                     int endPage,
                                     boolean withImages,
                                     boolean withAnnotations,
                                     boolean withOutline)

pdf2xml

public java.io.File pdf2xml(java.lang.Integer timeout,
                            boolean force,
                            int startPage,
                            int endPage,
                            java.io.File pdfPath,
                            java.io.File tmpPath,
                            boolean withImages,
                            boolean withAnnotations,
                            boolean withOutline)

Create an XML representation from a pdf file. If tout is true (default), a timeout is used. If force is true, the xml file is always regenerated, even if already present (default is false, it can save up to 50% overall runtime). If full is true, the extraction covers also images within the pdf, which is relevant for fulltext extraction.

close

public void close(boolean cleanImages,
                  boolean cleanAnnotations,
                  boolean cleanOutline)

close

public static void close(DocumentSource source,
                         boolean cleanImages,
                         boolean cleanAnnotations,
                         boolean cleanOutline)

getPdfFile

public java.io.File getPdfFile()

setPdfFile

public void setPdfFile(java.io.File pdfFile)

getXmlFile

public java.io.File getXmlFile()

setXmlFile

public void setXmlFile(java.io.File xmlFile)