Package io.goobi.viewer.controller

Class DataFileTools

java.lang.Object

io.goobi.viewer.controller.DataFileTools

public final class DataFileTools
extends Object

Utility class for locating and accessing data files (ALTO, TEI, etc.) on the viewer file system.

Method Summary

Modifier and Type	Method	Description
static Path	getAltoFolder(String pi)	Constructs the alto folder path for the given pi, either directly in viewer-home or within a data repository.
static Path	getDataFilePath(String pi, String relativeFilePath)	getDataFilePath.
static Path	getDataFilePath(String pi, String dataFolderName, String altDataFolderName, String fileName)	Returns the path to the data file (if file name given) or data folder for the given record identifier.
static Path	getDataFolder(String pi, String dataFolderName)	Constructs the folder path for data of the given pi, either directly in viewer-home or within a data repository.
static Path	getDataFolder(String pi, String dataFolderName, String dataRepositoryFolder)	Returns the data folder path for the given record identifier.
static Map<String,Path>	getDataFolders(String pi, String... dataFolderNames)	Returns a map of Paths for each data folder name passed as an argument.
static String	getDataRepositoryPathForRecord(String pi)	Retrieves the path to viewer home or repositories root, depending on the record.
static Dataset	getDataset(String pi)	Creates a Dataset object, containing all relevant file paths.
static Path	getMediaFolder(String pi)	Constructs the media folder path for the given pi, either directly in viewer-home or within a data repository.
static Path	getPdfFolder(String pi)	Constructs the pdf folder path for the given pi, either directly in viewer-home or within a data repository.
static String	getSourceFilePath(String fileName, String format)	Returns the absolute path to the source (METS/LIDO/etc.) file with the given file name.
static String	getSourceFilePath(String fileName, String dataRepository, String format)	Returns the absolute path to the source (METS/LIDO/DENKXWEB/DUBLINCORE) file with the given file name.
static Path	getTextFilePath(String pi, String relativeFilePath)	getTextFilePath.
static String	getTextFilePath(String pi, String fileName, String format)	getTextFilePath.
static StringPair	loadAlto(String altoFilePath)
static String	loadFromApiURl(String fulltextFilePath)
static String	loadFulltext(String altoFilePath, String fulltextFilePath, boolean mergeLineBreakWords)	Loads plain full-text via the REST service.
static String	loadMei(String pi, HttpServletRequest servletRequest)
static String	loadTei(String pi, String language)	loadTei.

Methods inherited from class java.lang.Object

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

Method Details

getDataRepositoryPathForRecord

public static String getDataRepositoryPathForRecord(String pi)
                                             throws PresentationException,
IndexUnreachableException

Retrieves the path to viewer home or repositories root, depending on the record. Used to generate a specific task client query parameter.

Parameters:

pi - Record identifier

Returns:

The root folder path of the data repositories; viewer home if none are used

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getMediaFolder

public static Path getMediaFolder(String pi)
                           throws PresentationException,
IndexUnreachableException

Constructs the media folder path for the given pi, either directly in viewer-home or within a data repository.

Parameters:

pi - The work PI. This is both the actual name of the folder and the identifier used to look up data repository in solr

Returns:

A Path to the media folder for the given PI

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getPdfFolder

public static Path getPdfFolder(String pi)
                         throws PresentationException,
IndexUnreachableException

Constructs the pdf folder path for the given pi, either directly in viewer-home or within a data repository.

Parameters:

pi - The work PI. This is both the actual name of the folder and the identifier used to look up data repository in solr

Returns:

A Path to the pdf folder for the given PI

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getAltoFolder

public static Path getAltoFolder(String pi)
                          throws PresentationException,
IndexUnreachableException

Constructs the alto folder path for the given pi, either directly in viewer-home or within a data repository.

Parameters:

pi - The work PI. This is both the actual name of the folder and the identifier used to look up data repository in solr

Returns:

A Path to the alto folder for the given PI

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getDataFolders

public static Map<String,Path> getDataFolders(String pi,
 String... dataFolderNames)
                                       throws PresentationException,
IndexUnreachableException

Returns a map of Paths for each data folder name passed as an argument.

Parameters:

pi - The record identifier. This is both the actual name of the folder and the identifier used to look up data repository in Solr

dataFolderNames - names of the data folders to resolve

Returns:

HashMap<dataFolderName,Path>

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getDataFolder

public static Path getDataFolder(String pi,
 String dataFolderName)
                          throws PresentationException,
IndexUnreachableException

Constructs the folder path for data of the given pi, either directly in viewer-home or within a data repository.

Parameters:

pi - The record identifier. This is both the actual name of the folder and the identifier used to look up data repository in Solr

dataFolderName - the data folder within the repository; e.g 'media' or 'alto'

Returns:

A Path to the data folder for the given PI

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getDataFolder

public static Path getDataFolder(String pi,
 String dataFolderName,
 String dataRepositoryFolder)

Returns the data folder path for the given record identifier. To be used in clients that already possess the data repository name.

Parameters:

pi - persistent identifier of the record

dataFolderName - name of the data subfolder (e.g. 'alto', 'media')

dataRepositoryFolder - Absolute path to the data repository folder or just the folder name

Returns:

the resolved path to the named data subfolder for the given record

getDataFilePath

public static Path getDataFilePath(String pi,
 String dataFolderName,
 String altDataFolderName,
 String fileName)
                            throws PresentationException,
IndexUnreachableException

Returns the path to the data file (if file name given) or data folder for the given record identifier.

Parameters:

pi - Record identifier

dataFolderName - Name of the data folder (e.g. 'alto') - first choice

altDataFolderName - Name of the data folder - second choice

fileName - Optional name of the content file

Returns:

Path to the requested file or folder

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getDataFilePath

public static Path getDataFilePath(String pi,
 String relativeFilePath)
                            throws PresentationException,
IndexUnreachableException

getDataFilePath.

Parameters:

pi - Record identifier

relativeFilePath - File path relative to data repositories root

Returns:

File represented by the relative file path

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getSourceFilePath

public static String getSourceFilePath(String fileName,
 String format)
                                throws PresentationException,
IndexUnreachableException

Returns the absolute path to the source (METS/LIDO/etc.) file with the given file name.

Parameters:

fileName - source file name (basename is used as record identifier)

format - source document format (e.g. METS, LIDO)

Returns:

the absolute file system path to the source file

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getSourceFilePath

public static String getSourceFilePath(String fileName,
 String dataRepository,
 String format)

Returns the absolute path to the source (METS/LIDO/DENKXWEB/DUBLINCORE) file with the given file name.

Parameters:

fileName - source file name including extension

dataRepository - path or name of the data repository folder

format - source document format (e.g. METS, LIDO)

Returns:

the absolute file system path to the source file in the given data repository

getTextFilePath

public static String getTextFilePath(String pi,
 String fileName,
 String format)
                              throws PresentationException,
IndexUnreachableException

getTextFilePath.

Parameters:

pi - persistent identifier of the record

fileName - name of the text file

format - text format constant (e.g. FILENAME_ALTO, FILENAME_FULLTEXT)

Returns:

the absolute file system path to the text file in the resolved data repository

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getTextFilePath

public static Path getTextFilePath(String pi,
 String relativeFilePath)
                            throws PresentationException,
IndexUnreachableException

getTextFilePath.

Parameters:

pi - persistent identifier of the record

relativeFilePath - ALTO/text file path relative to the data folder

Returns:

the absolute path to the text file within the resolved data repository, or null if relativeFilePath is blank

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

loadFulltext

public static String loadFulltext(String altoFilePath,
 String fulltextFilePath,
 boolean mergeLineBreakWords)
                           throws IOException,
IndexUnreachableException

Loads plain full-text via the REST service. ALTO is is a fallback (and converted to plain text, with a plain text fallback.

Parameters:

altoFilePath - ALTO file path relative to the repository root (e.g. "alto/PPN123/00000001.xml")

fulltextFilePath - plain full-text file path relative to the repository root (e.g. "fulltext/PPN123/00000001.xml")

mergeLineBreakWords - true to merge words split across line breaks

Returns:

the plain text content of the page, or null if no fulltext could be loaded

Throws:

AccessDeniedException - if any.

FileNotFoundException - if any.

IOException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

loadFromApiURl

public static String loadFromApiURl(String fulltextFilePath)
                             throws FileNotFoundException

Throws:

FileNotFoundException

loadAlto

public static StringPair loadAlto(String altoFilePath)
                           throws IndexUnreachableException,
PresentationException,
FileNotFoundException

Parameters:

altoFilePath - the path to the ALTO file

Returns:

StringPair(ALTO,charset), or null if altoFilePath is null

Throws:

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

IndexUnreachableException

PresentationException

FileNotFoundException

loadTei

public static String loadTei(String pi,
 String language)
                      throws IOException

loadTei.

Parameters:

pi - persistent identifier of the record

language - ISO language code for the requested TEI document

Returns:

the TEI document content as a string, or null if not available

Throws:

AccessDeniedException - if any.

IOException - if any.

ViewerConfigurationException - if any.

loadMei

public static String loadMei(String pi,
 HttpServletRequest servletRequest)
                      throws AccessDeniedException,
DAOException,
IndexUnreachableException,
IOException,
PresentationException,
RecordNotFoundException

Parameters:

pi - persistent identifier of the record

servletRequest - the HTTP servlet request

Returns:

MEI content string; null if none available

Throws:

AccessDeniedException

DAOException

IndexUnreachableException

IOException

PresentationException

RecordNotFoundException

getDataset

public static Dataset getDataset(String pi)
                          throws PresentationException,
IndexUnreachableException,
RecordNotFoundException,
IOException

Creates a Dataset object, containing all relevant file paths.

Parameters:

pi - persistent identifier of the record to build the dataset for

Returns:

the Dataset containing all relevant file paths for the given record

Throws:

PresentationException

IndexUnreachableException

RecordNotFoundException

IOException