Package io.goobi.viewer.controller.imaging

Class PdfHandler

java.lang.Object

io.goobi.viewer.controller.imaging.PdfHandler

public class PdfHandler
extends Object

PdfHandler class.

Author:

Florian Alpers

Constructor Summary

Constructors

Constructor	Description
PdfHandler(WatermarkHandler watermarkHandler, AbstractApiUrlManager urls)	Constructor for PdfHandler.
PdfHandler(WatermarkHandler watermarkHandler, Configuration configuration)	Constructor for PdfHandler.

Method Summary

Modifier and Type	Method	Description
String	getPdfUrl(StructElement doc, PhysicalElement page)	Return the pdf-download url for the given StructElement and PhysicalElement
String	getPdfUrl(StructElement se, PhysicalElement[] pages)	Return the pdf-download url for the given StructElement and a number of PhysicalElements
String	getPdfUrl(StructElement doc, String label)	Gets the url to the pdf for the given StructElement.
String	getPdfUrl(StructElement doc, String pi, String label)	Gets the url to the pdf for the given pi and divId
String	getPdfUrl(String pi, String filename)	Returns an existing pdf file from the media folder
String	getPdfUrl(String pi, Optional<String> divID, Optional<String> label)	Returns the url to a PDF build from the mets file for the given pi
WatermarkHandler	getWatermarkHandler()

Methods inherited from class java.lang.Object

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

Constructor Details

PdfHandler

public PdfHandler(WatermarkHandler watermarkHandler,
 Configuration configuration)

Constructor for PdfHandler.

Parameters:

watermarkHandler - a WatermarkHandler object.

configuration - a Configuration object.

PdfHandler

public PdfHandler(WatermarkHandler watermarkHandler,
 AbstractApiUrlManager urls)

Constructor for PdfHandler.

Parameters:

watermarkHandler - a WatermarkHandler object.

urls -

Method Details

getPdfUrl

public String getPdfUrl(StructElement doc,
 PhysicalElement page)

Return the pdf-download url for the given StructElement and PhysicalElement

Parameters:

doc - a StructElement object.

page - a PhysicalElement object.

Returns:

a String object.

getPdfUrl

public String getPdfUrl(StructElement se,
 PhysicalElement[] pages)

Return the pdf-download url for the given StructElement and a number of PhysicalElements

Parameters:

se - a StructElement object.

pages - an array of PhysicalElement objects.

Returns:

a String object.

getPdfUrl

public String getPdfUrl(String pi,
 String filename)

Returns an existing pdf file from the media folder

Parameters:

pi - a String object.

filename - a String object.

Returns:

a String object.

getPdfUrl

public String getPdfUrl(StructElement doc,
 String label)
                 throws PresentationException,
IndexUnreachableException

Gets the url to the pdf for the given StructElement. The pi is the one of the topStruct element of the given StructElement

Parameters:

doc - a StructElement object.

label - The name for the output file (.pdf-extension excluded). If this is null or empty, the label will be generated from pi and divId

Returns:

a String object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getPdfUrl

public String getPdfUrl(StructElement doc,
 String pi,
 String label)
                 throws PresentationException,
IndexUnreachableException

Gets the url to the pdf for the given pi and divId

Parameters:

doc - a StructElement object.

pi - PI of the process from which to build pdf. Must be provided

label - The name for the output file (.pdf-extension excluded). If this is null or empty, the label will be generated from pi and divId

Returns:

a String object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getPdfUrl

public String getPdfUrl(String pi,
 Optional<String> divID,
 Optional<String> label)

Returns the url to a PDF build from the mets file for the given pi

Parameters:

pi - a String object.

divID - a Optional object.

label - a Optional object.

Returns:

a String object.

getWatermarkHandler

public WatermarkHandler getWatermarkHandler()

Returns:

the watermarkHandler