Package io.goobi.viewer.api.rest.resourcebuilders

Class TextResourceBuilder

java.lang.Object

io.goobi.viewer.api.rest.resourcebuilders.TextResourceBuilder

public class TextResourceBuilder
extends Object

Author:

Florian Alpers

Constructor Summary

Constructors

Constructor	Description
TextResourceBuilder()	Zero-arg constructor.

Method Summary

Modifier and Type	Method	Description
StreamingOutput	getAltoAsZip(String pi, HttpServletRequest request)
String	getAltoDocument(String pi, HttpServletRequest request)
StringPair	getAltoDocument(String pi, String fileName)
String	getCmdiDocument(String pi, String langCode)
Path	getCMDIFile(String pi, String langCode)	getCMDIFile.
List<Path>	getCMDIFiles(String pi)	getCMDIFiles.
String	getContentAsText(String contentFolder, String pi, String fileName)
String	getFulltext(String pi, HttpServletRequest request)
String	getFulltext(String pi, String fileName)	getFulltext.
String	getFulltextAsTEI(String pi, String filename)
StreamingOutput	getFulltextAsZip(String pi, HttpServletRequest request)
Map<Path,String>	getFulltextMap(String pi, HttpServletRequest request)	Collects full-text file paths and content in a map.
StreamingOutput	getTeiAsZip(String pi, String langCode, HttpServletRequest request)
String	getTeiDocument(String pi, String langCode, HttpServletRequest request)
List<Path>	getTEIFiles(String pi)	getTEIFiles.
List<Path>	getTEIFiles(String pi, String langCode)	getTEIFiles.

Methods inherited from class java.lang.Object

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

Constructor Details

TextResourceBuilder

public TextResourceBuilder()

Zero-arg constructor.

Method Details

getFulltext

public String getFulltext(String pi,
 HttpServletRequest request)
                   throws IOException,
PresentationException,
IndexUnreachableException

Throws:

IOException

PresentationException

IndexUnreachableException

getFulltextAsZip

public StreamingOutput getFulltextAsZip(String pi,
 HttpServletRequest request)
                                 throws IOException,
PresentationException,
IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Parameters:

pi - persistent identifier of the work

request - HttpServletRequest

Returns:

StreamingOutput

Throws:

IOException

PresentationException

IndexUnreachableException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

getAltoAsZip

public StreamingOutput getAltoAsZip(String pi,
 HttpServletRequest request)
                             throws IOException,
PresentationException,
IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Throws:

IOException

PresentationException

IndexUnreachableException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

getAltoDocument

public String getAltoDocument(String pi,
 HttpServletRequest request)
                       throws IOException,
PresentationException,
IndexUnreachableException

Throws:

IOException

PresentationException

IndexUnreachableException

getAltoDocument

public StringPair getAltoDocument(String pi,
 String fileName)
                           throws PresentationException,
IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Parameters:

pi - persistent identifier of the work

fileName - file name of the ALTO document to retrieve

Returns:

StringPair(ALTO,charset)

Throws:

PresentationException

IndexUnreachableException

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

getFulltextAsTEI

public String getFulltextAsTEI(String pi,
 String filename)
                        throws PresentationException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException,
IndexUnreachableException

Parameters:

pi - persistent identifier of the work

filename - file name of the plain-text page to convert

Returns:

Plain text extracted from TEI

Throws:

PresentationException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

IndexUnreachableException

getTeiDocument

public String getTeiDocument(String pi,
 String langCode,
 HttpServletRequest request)
                      throws PresentationException,
IndexUnreachableException,
IOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Parameters:

pi - persistent identifier of the work

langCode - ISO language code for the requested TEI version

request - HttpServletRequest

Returns:

TEI document as String

Throws:

PresentationException

IndexUnreachableException

IOException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

getTeiAsZip

public StreamingOutput getTeiAsZip(String pi,
 String langCode,
 HttpServletRequest request)
                            throws PresentationException,
IndexUnreachableException,
IOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

Parameters:

pi - persistent identifier of the work

langCode - ISO language code for the requested TEI version

request - HttpServletRequest

Returns:

StreamingOutput

Throws:

PresentationException

IndexUnreachableException

IOException

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

getCmdiDocument

public String getCmdiDocument(String pi,
 String langCode)
                       throws PresentationException,
IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException,
IOException

Parameters:

pi - persistent identifier of the work

langCode - ISO language code for the requested CMDI version

Returns:

CMDI document as String

Throws:

PresentationException

IndexUnreachableException

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

IOException

getContentAsText

public String getContentAsText(String contentFolder,
 String pi,
 String fileName)
                        throws PresentationException,
IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Throws:

PresentationException

IndexUnreachableException

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

getFulltext

public String getFulltext(String pi,
 String fileName)
                   throws PresentationException,
IndexUnreachableException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

getFulltext.

Parameters:

pi - persistent identifier of the work

fileName - file name of the plain-text or ALTO page to retrieve

Returns:

plain text content of the requested page

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException - if any.

DAOException

de.unigoettingen.sub.commons.contentlib.exceptions.ServiceNotAllowedException

getFulltextMap

public Map<Path,String> getFulltextMap(String pi,
 HttpServletRequest request)
                                throws IOException,
PresentationException,
IndexUnreachableException

Collects full-text file paths and content in a map. Priority is given to files from plaintext resources, with missing files being stuffed with converted ALTO.

Parameters:

pi - persistent identifier of the work

request - current HTTP servlet request for access checking

Returns:

map of page file paths to their full-text content

Throws:

IOException - if any.

PresentationException - if any.

IndexUnreachableException - if any.

getTEIFiles

public List<Path> getTEIFiles(String pi)

getTEIFiles.

Parameters:

pi - persistent identifier used to locate the TEI folder

Returns:

list of all language-specific TEI file paths for the record

getTEIFiles

public List<Path> getTEIFiles(String pi,
 String langCode)

getTEIFiles.

Parameters:

pi - persistent identifier used to locate the TEI folder

langCode - ISO language code to filter TEI files by

Returns:

list of TEI file paths matching the requested language

getCMDIFile

public Path getCMDIFile(String pi,
 String langCode)
                 throws IOException,
PresentationException,
IndexUnreachableException

getCMDIFile.

Parameters:

pi - persistent identifier used to locate the CMDI folder

langCode - ISO language code to select the matching CMDI file

Returns:

path to the language-specific CMDI file, or null if not found

Throws:

IOException - if any.

PresentationException - if any.

IndexUnreachableException - if any.

getCMDIFiles

public List<Path> getCMDIFiles(String pi)

getCMDIFiles.

Parameters:

pi - persistent identifier used to locate the CMDI folder

Returns:

list of all language-specific CMDI file paths for the record