de.digitalcollections.iiif.image.business.api.service.v2_0_0

Interface IiifParameterParserService

public interface IiifParameterParserService

Method Summary

Modifier and Type	Method and Description
ImageFormat	parseIiifFormat(String targetFormat) Parse the target image format.
ImageBitDepth	parseIiifQuality(String targetQuality) Parse the quality parameter (determines whether the image is delivered in color, grayscale or black and white).
RegionParameters	parseIiifRegion(String region) The region parameter defines the rectangular portion of the full image to be returned.
RotationParameters	parseIiifRotation(String rotation) The rotation parameter specifies mirroring and rotation.
ResizeParameters	parseIiifSize(String size) Parses parameters for resizing.

Method Detail

parseIiifFormat

ImageFormat parseIiifFormat(String targetFormat)
                     throws UnsupportedFormatException

Parse the target image format.

Parameters:

targetFormat - target image format (jpg, png, ...)

Returns:

parsed image format

Throws:

UnsupportedFormatException - if format/extension can not be parsed

parseIiifQuality

ImageBitDepth parseIiifQuality(String targetQuality)
                        throws InvalidParametersException

Parse the quality parameter (determines whether the image is delivered in color, grayscale or black and white).

Parameters:

targetQuality - target image quality

Returns:

parsed image quality

Throws:

InvalidParametersException - if quality can not be parsed

parseIiifRegion

RegionParameters parseIiifRegion(String region)
                          throws InvalidParametersException

The region parameter defines the rectangular portion of the full image to be returned. Region can be specified by pixel coordinates, percentage or by the value “full”, which specifies that the entire image should be returned.

Relative definition "pct:x,y,w,h": The region to be returned is specified as a sequence of percentages of the full image’s dimensions, as reported in the Image Information document. Thus, x represents the number of pixels from the 0 position on the horizontal axis, calculated as a percentage of the reported width. w represents the width of the region, also calculated as a percentage of the reported width. The same applies to y and h respectively. These may be floating point numbers.

Absolute definition "x,y,w,h": The region of the full image to be returned is defined in terms of absolute pixel values. The value of x represents the number of pixels from the 0 position on the horizontal axis. The value of y represents the number of pixels from the 0 position on the vertical axis. Thus the x,y position 0,0 is the upper left-most pixel of the image. w represents the width of the region and h represents the height of the region in pixels.

Parameters:

region - region definition

Returns:

parsed region parameters

Throws:

InvalidParametersException - if region definition can not be parsed

parseIiifRotation

RotationParameters parseIiifRotation(String rotation)
                              throws InvalidParametersException

The rotation parameter specifies mirroring and rotation. A leading exclamation mark (“!”) indicates that the image should be mirrored by reflection on the vertical axis before any rotation is applied. The numerical value represents the number of degrees of clockwise rotation, and may be any floating point number from 0 to 360.

Parameters:

rotation - n: The degrees of clockwise rotation from 0 up to 360., !n: The image should be mirrored and then rotated.

Returns:

rotation params

Throws:

InvalidParametersException - if argument can not interpreted

parseIiifSize

ResizeParameters parseIiifSize(String size)
                        throws InvalidParametersException

Parses parameters for resizing.

Parameters:

size - target size

Returns:

resize parameters

Throws:

InvalidParametersException - if size can not be parsed