Package io.goobi.viewer.controller.imaging

Class WatermarkHandler

java.lang.Object

io.goobi.viewer.controller.imaging.WatermarkHandler

All Implemented Interfaces:

Serializable

public class WatermarkHandler
extends Object
implements Serializable

WatermarkHandler class.

Author:

Florian Alpers

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	REQUIRED_SOLR_FIELDS	Constant REQUIRED_SOLR_FIELDS.
static final String	WATERMARK_TEXT_TYPE_PURL	Constant WATERMARK_TEXT_TYPE_PURL="PURL".
static final String	WATERMARK_TEXT_TYPE_SOLR	Constant WATERMARK_TEXT_TYPE_SOLR="SOLR:".
static final String	WATERMARK_TEXT_TYPE_URN	Constant WATERMARK_TEXT_TYPE_URN="URN".

Constructor Summary

Constructors

Constructor	Description
WatermarkHandler(Configuration configuration, String servletPath)	Constructor for WatermarkHandler.

Method Summary

Modifier and Type	Method	Description
Optional<String>	getFooterIdIfExists(StructElement topDocument)	Return the watermark id for the given StructElement.
Optional<String>	getWatermarkTextIfExists(PhysicalElement page)	Optionally returns the watermark text for the given page.
Optional<String>	getWatermarkTextIfExists(StructElement doc)	Optionally returns the watermark text for the given pi.
Optional<String>	getWatermarkUrl(de.unigoettingen.sub.commons.contentlib.imagelib.transform.Scale scale, Optional<PageType> pageType, Optional<de.unigoettingen.sub.commons.contentlib.imagelib.ImageType> imageType, Optional<String> watermarkId, Optional<String> watermarkText)	Creates the watermark url for the given pageType, adding watermarkId for the current ActiveDocumentBean.getTopDocument() and watermarkText for the current PhysicalElement page.
Optional<String>	getWatermarkUrl(Optional<PhysicalElement> page, Optional<StructElement> doc, Optional<PageType> pageType)	Creates the watermark url for the given pageType, adding watermarkId for the given StructElement and PhysicalElement page.

Methods inherited from class java.lang.Object

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

Field Details

WATERMARK_TEXT_TYPE_URN

public static final String WATERMARK_TEXT_TYPE_URN

Constant WATERMARK_TEXT_TYPE_URN="URN".

See Also:

• Constant Field Values

WATERMARK_TEXT_TYPE_PURL

public static final String WATERMARK_TEXT_TYPE_PURL

Constant WATERMARK_TEXT_TYPE_PURL="PURL".

See Also:

• Constant Field Values

WATERMARK_TEXT_TYPE_SOLR

public static final String WATERMARK_TEXT_TYPE_SOLR

Constant WATERMARK_TEXT_TYPE_SOLR="SOLR:".

See Also:

• Constant Field Values

REQUIRED_SOLR_FIELDS

public static final String[] REQUIRED_SOLR_FIELDS

Constant REQUIRED_SOLR_FIELDS.

Constructor Details

WatermarkHandler

public WatermarkHandler(Configuration configuration,
 String servletPath)

Constructor for WatermarkHandler.

Parameters:

configuration - a Configuration object.

servletPath - a String object.

Method Details

getWatermarkUrl

public Optional<String> getWatermarkUrl(Optional<PhysicalElement> page,
 Optional<StructElement> doc,
 Optional<PageType> pageType)
                                 throws ViewerConfigurationException,
IndexUnreachableException,
DAOException

Creates the watermark url for the given pageType, adding watermarkId for the given StructElement and PhysicalElement page. If the watermark height of the given pageType and image is 0, an empty optional is returned

Parameters:

page - a Optional object.

doc - a Optional object.

pageType - The pageType of the currentView. Taken into consideration for footer height, if not null

Returns:

a Optional object.

Throws:

ViewerConfigurationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

getWatermarkUrl

public Optional<String> getWatermarkUrl(de.unigoettingen.sub.commons.contentlib.imagelib.transform.Scale scale,
 Optional<PageType> pageType,
 Optional<de.unigoettingen.sub.commons.contentlib.imagelib.ImageType> imageType,
 Optional<String> watermarkId,
 Optional<String> watermarkText)
                                 throws IndexUnreachableException,
DAOException,
ViewerConfigurationException

Creates the watermark url for the given pageType, adding watermarkId for the current ActiveDocumentBean.getTopDocument() and watermarkText for the current PhysicalElement page. If the watermark height of the given pageType and image is 0, an empty optional is returned.

Parameters:

pageType - The pageType of the currentView. Taken into consideration for footer height, if not null

scale - a Scale object.

imageType - a Optional object.

watermarkId - a Optional object.

watermarkText - a Optional object.

Returns:

a Optional object.

Throws:

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getWatermarkTextIfExists

public Optional<String> getWatermarkTextIfExists(PhysicalElement page)

Optionally returns the watermark text for the given page. If the text is empty or none is configures, an empty optional is returned

Parameters:

page - a PhysicalElement object.

Returns:

a Optional object.

getWatermarkTextIfExists

public Optional<String> getWatermarkTextIfExists(StructElement doc)

Optionally returns the watermark text for the given pi. If the text is empty or none is configures, an empty optional is returned

Parameters:

doc - a StructElement object.

Returns:

a Optional object.

getFooterIdIfExists

public Optional<String> getFooterIdIfExists(StructElement topDocument)

Return the watermark id for the given StructElement.

Parameters:

topDocument - a StructElement object.

Returns:

a Optional object.