org.grobid.core.visualization

Class CitationsVisualizer

java.lang.Object

org.grobid.core.visualization.CitationsVisualizer

public class CitationsVisualizer
extends java.lang.Object

Utilities for visualizing citation markers and biblographical references, wither directly in the PDF using the PDF annotation layer or as annotations in JSON for supporting web based rendering (e.g. with PDF.js) and interactive HTML layer. See the web console/demo for actual examples of usage.

Constructor Summary

Constructors

Constructor and Description
CitationsVisualizer()

Method Summary

Modifier and Type	Method and Description
static PDDocument	annotatePdfWithCitations(PDDocument document, Document teiDoc, java.util.List<java.lang.String> resolvedBibRefUrl) Augment a PDF with bibliographical annotation, for bib.
static java.lang.String	getJsonAnnotations(Document teiDoc, java.util.List<java.lang.String> resolvedBibRefUrl) Produce JSON annotations with PDF coordinates for web based PDF rendering.
static java.lang.String	getJsonAnnotationsPerPage(Document teiDoc, java.util.List<java.lang.String> resolvedBibRefUrl)

Methods inherited from class java.lang.Object

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

Constructor Detail

CitationsVisualizer

public CitationsVisualizer()

Method Detail

annotatePdfWithCitations

public static PDDocument annotatePdfWithCitations(PDDocument document,
                                                  Document teiDoc,
                                                  java.util.List<java.lang.String> resolvedBibRefUrl)
                                           throws java.io.IOException,
                                                  XPathException

Augment a PDF with bibliographical annotation, for bib. ref. and bib markers. The PDF annotation layer is used with "GoTo" and "URI" action links. The annotations of the bibliographical references can be associated to an URL in order to have clickable references direclty in the PDF. The Apache PDFBox library is used.

Parameters:

document - PDDocument object resulting from the PDF parsing with PDFBox

teiDoc - the Document object resulting from the full document structuring

resolvedBibRefUrl - the list of URL to be added to the bibliographical reference annotations, if null the bib. ref. annotations are not associated to external URL.

Throws:

java.io.IOException

XPathException

getJsonAnnotations

public static java.lang.String getJsonAnnotations(Document teiDoc,
                                                  java.util.List<java.lang.String> resolvedBibRefUrl)
                                           throws java.io.IOException,
                                                  XPathException

Produce JSON annotations with PDF coordinates for web based PDF rendering. Annotations are given for bib. ref. and bib markers separately, together with the dimension of the different pages for client resizing. The annotations of the bibliographical references can be associated to an URL in order to support "clickable" bib. ref. annotations.

Parameters:

teiDoc - the Document object resulting from the full document structuring

resolvedBibRefUrl - the list of URL to be added to the bibliographical reference annotations, if null the bib. ref. annotations are not associated to external URL.

Throws:

java.io.IOException

XPathException

getJsonAnnotationsPerPage

public static java.lang.String getJsonAnnotationsPerPage(Document teiDoc,
                                                         java.util.List<java.lang.String> resolvedBibRefUrl)
                                                  throws java.io.IOException,
                                                         XPathException

Throws:

java.io.IOException

XPathException