Package digilib.conf
Class PDFRequest
java.lang.Object
digilib.util.ParameterMap
digilib.conf.PDFRequest
A container class for storing a set of instruction parameters used for
content generator classes.
- Author:
- cmielack, casties
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) DigilibConfigurationprotected static final org.slf4j.Loggergeneral logger for this class(package private) NumRangeFields inherited from class digilib.util.ParameterMap
options, params -
Constructor Summary
ConstructorsConstructorDescriptionPDFRequest(DigilibConfiguration dlcfg) Create a PDFRequestPDFRequest(javax.servlet.http.HttpServletRequest request, DigilibConfiguration dlcfg) Create a PDFRequest with a request and config. -
Method Summary
Modifier and TypeMethodDescriptionGenerate a filename for the pdf to be created.getPages()protected voidset up optionsprotected voidset up parametersbooleanisValid()Check parameters for validity.voidsetBaseURL(javax.servlet.http.HttpServletRequest request) Set the requests base URL parameter from a javax.sevlet.http.HttpServletRequest.voidsetWithRequest(javax.servlet.http.HttpServletRequest request) Initialize with a ServletRequest.Methods inherited from class digilib.util.ParameterMap
cloneInstance, get, getAsBoolean, getAsFile, getAsFloat, getAsInt, getAsString, getInstance, getOptions, getParameters, getParams, getValue, hasOption, hasValue, newParameter, newParameter, put, put, setOptions, setParams, setValue, setValue, setValue, setValueFromString
-
Field Details
-
dlConfig
DigilibConfiguration dlConfig -
pages
NumRange pages -
logger
protected static final org.slf4j.Logger loggergeneral logger for this class
-
-
Constructor Details
-
PDFRequest
Create a PDFRequest- Parameters:
dlcfg- The DigilibConfiguration.
-
PDFRequest
public PDFRequest(javax.servlet.http.HttpServletRequest request, DigilibConfiguration dlcfg) throws IOException, ImageOpException Create a PDFRequest with a request and config.- Parameters:
request-dlcfg- The DigilibConfiguration.- Throws:
ImageOpExceptionIOException
-
-
Method Details
-
initParams
protected void initParams()Description copied from class:ParameterMapset up parameters- Overrides:
initParamsin classParameterMap
-
initOptions
protected void initOptions()Description copied from class:ParameterMapset up options- Overrides:
initOptionsin classParameterMap
-
setWithRequest
public void setWithRequest(javax.servlet.http.HttpServletRequest request) throws IOException, ImageOpException Initialize with a ServletRequest.- Parameters:
request-- Throws:
ImageOpExceptionIOException
-
setBaseURL
public void setBaseURL(javax.servlet.http.HttpServletRequest request) Set the requests base URL parameter from a javax.sevlet.http.HttpServletRequest.- Parameters:
request- HttpServletRequest to set the base URL.
-
getDocumentId
Generate a filename for the pdf to be created.- Returns:
-
getImageJobInformation
- Throws:
IOExceptionImageOpException
-
getPages
-
isValid
public boolean isValid()Check parameters for validity. Returns true if no errors are found.- Returns:
-
getDlConfig
-