view common/src/main/java/digilib/conf/DigilibOption.java @ 1592:7031524fc6e9

new DigilibOptions Enum for typesafe Scaler "mo" options/flags.
author robcast
date Wed, 08 Feb 2017 19:22:57 +0100
parents
children 4ef25f916df8
line wrap: on
line source

package digilib.conf;

/**
 * Enum of options for the digilib "mo" parameter.
 * 
 * @author casties
 *
 */
public enum DigilibOption {
	/** scale the (selected area of the) image proportionally to fit inside [dw x dh], preserving its aspect ratio (default). */
    fit,
    /** scale the (selected area of the) image to fill [dw x dh], changing its aspect ratio. */
    squeeze,
    /** scale the (selected area of the) image proportionally to fill [dw x dh] with the shorter side, cropping the longer side. */
    crop,
    /** scale the (selected area of the) image proportionally to fill [dw x dh] with the longer side, filling out the image on the shorter side if possible. */
    fill,
    /** send the file in the highest resolution, cropped to fit [dw x dh]. */
    clip,
    /** scale to original size based on image resolution (from the image metadata) and display resolution (from parameter ddpi). Fails if either resolution is unknown. */
    osize,
    /** scale the highest resolution image by an absolute factor given by the scale parameter. */
    ascale,
    /** send the file as-is (may be very large and all sorts of image types!). If the configuration doesn’t allow sending files (sendfile-allowed=false) revert to clip. */
    file,
    /** send the file as-is with a mime-type of “application/octet-stream” so the browser presents a download dialog. */
    rawfile,
    /** send error response as plain text. */
    errtxt,
    /** send error response as image (default). */
    errimg,
    /** send error response as HTTP status code. */
    errcode,
    /** quality of interpolation in scaling (q0: worst, q2 best).*/
    q0,
    /** quality of interpolation in scaling (q0: worst, q2 best).*/
    q1,
    /** quality of interpolation in scaling (q0: worst, q2 best).*/
    q2,
    /** only use the highest resolution image. */
    hires,
    /** use the pre-scaled image that is bigger than the requested size (default). */
    autores,
    /** prefer the next-smaller pre-scaled image. */
    lores,
    /** mirror image vertically. */
    vmir,
    /** mirror image horizontally. */
    hmir,
    /** the resulting image is always sent as JPEG (otherwise TIFF and PNG images are sent as PNG). */
    jpg,
    /** the resulting image is always sent as PNG (otherwise JPEG and J2K images are sent as JPEG). */
    png,
    /** interpret wx, wy, ww, wh as pixel coordinates on the highest resolution image. */
    pxarea,
    /** send IIIF image info (instead of image). */
    info, 
    /** send redirect to IIIF image info URI */ 
    redirect_info,
    /** dirInfo returns directory contents */
    dir
     
}