Package org.mycore.iview2.services

Class MCRIView2Tools

java.lang.Object

org.mycore.iview2.services.MCRIView2Tools

public class MCRIView2Tools
extends Object

Tools class with common methods for IView2.

Author:

Thomas Scheffler (yagee)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_PREFIX

Constructor Summary

Constructors

Constructor	Description
MCRIView2Tools()

Method Summary

Modifier and Type	Method	Description
static String	getFilePath(String derID, String derPath)
static FileSystem	getFileSystem(Path iviewFile)
static int	getImageType(Path iviewFileRoot, ImageReader imageReader, int zoomLevel, int x, int y)
static String	getIView2Property(String propName)	short for MCRIView2ToolsgetIView2Property(String, String) defaultProp = null
static String	getIView2Property(String propName, String defaultProp)	short for MCRConfiguration2.getString("MCR.Module-iview2." + propName).orElse(defaultProp);
static String	getSupportedMainFile(String derivateID)
static Path	getTileDir()
static ImageReader	getTileImageReader()
static BufferedImage	getZoomLevel(Path iviewFile, int zoomLevel)	combines image tiles of specified zoomLevel to one image.
static BufferedImage	getZoomLevel(Path iviewFileRoot, org.mycore.imagetiler.MCRTiledPictureProps imageProperties, ImageReader reader, int zoomLevel)	combines image tiles of specified zoomLevel to one image.
static boolean	isCompletelyTiled(String derivateId)	Checks for a given derivate id whether all files in that derivate are tiled.
static boolean	isDerivateSupported(String derivateID)
static boolean	isFileSupported(String filename)
static boolean	isFileSupported(Path file)
static BufferedImage	readTile(Path iviewFileRoot, ImageReader imageReader, int zoomLevel, int x, int y)

Methods inherited from class java.lang.Object

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

Field Details

CONFIG_PREFIX

public static final String CONFIG_PREFIX

See Also:

• Constant Field Values

Constructor Details

MCRIView2Tools

public MCRIView2Tools()

Method Details

getTileDir

public static Path getTileDir()

Returns:

directory for tiles

getSupportedMainFile

public static String getSupportedMainFile(String derivateID)

Parameters:

derivateID - ID of derivate

Returns:

empty String or absolute path to main file of derivate if file is supported.

isDerivateSupported

public static boolean isDerivateSupported(String derivateID)

Parameters:

derivateID - ID of derivate

Returns:

true if getSupportedMainFile(String) is not an empty String.

isFileSupported

public static boolean isFileSupported(Path file)
                               throws IOException

Parameters:

file - image file

Returns:

if content type is in property MCR.Module-iview2.SupportedContentTypes

Throws:

IOException

See Also:

• MCRContentTypes.probeContentType(Path)

isFileSupported

public static boolean isFileSupported(String filename)

Returns:

true if the file is supported, false otherwise

isCompletelyTiled

public static boolean isCompletelyTiled(String derivateId)

Checks for a given derivate id whether all files in that derivate are tiled.

Returns:

true if all files in belonging to the derivate are tiled, false otherwise

getZoomLevel

public static BufferedImage getZoomLevel(Path iviewFile,
 int zoomLevel)
                                  throws IOException,
JDOMException

combines image tiles of specified zoomLevel to one image.

Parameters:

iviewFile - .iview2 file

zoomLevel - the zoom level where 0 is thumbnail size

Returns:

a combined image

Throws:

IOException - any IOException while reading tiles

JDOMException - if image properties could not be parsed.

getZoomLevel

public static BufferedImage getZoomLevel(Path iviewFileRoot,
 org.mycore.imagetiler.MCRTiledPictureProps imageProperties,
 ImageReader reader,
 int zoomLevel)
                                  throws IOException,
JDOMException

combines image tiles of specified zoomLevel to one image.

Parameters:

iviewFileRoot - root directory of .iview2 file

imageProperties - imageProperties, if available or null

zoomLevel - the zoom level where 0 is thumbnail size

Returns:

a combined image

Throws:

IOException - any IOException while reading tiles

JDOMException - if image properties could not be parsed.

getFileSystem

public static FileSystem getFileSystem(Path iviewFile)
                                throws IOException

Throws:

IOException

getTileImageReader

public static ImageReader getTileImageReader()

readTile

public static BufferedImage readTile(Path iviewFileRoot,
 ImageReader imageReader,
 int zoomLevel,
 int x,
 int y)
                              throws IOException

Throws:

IOException

getImageType

public static int getImageType(Path iviewFileRoot,
 ImageReader imageReader,
 int zoomLevel,
 int x,
 int y)
                        throws IOException

Throws:

IOException

getIView2Property

public static String getIView2Property(String propName)

short for MCRIView2ToolsgetIView2Property(String, String) defaultProp = null

getIView2Property

public static String getIView2Property(String propName,
 String defaultProp)

short for MCRConfiguration2.getString("MCR.Module-iview2." + propName).orElse(defaultProp);

Parameters:

propName - any suffix

Returns:

null or property value

getFilePath

public static String getFilePath(String derID,
 String derPath)
                          throws IOException

Throws:

IOException