edu.cornell.mannlib.vitro.webapp.controller

Class AbstractPageHandler

java.lang.Object

edu.cornell.mannlib.vitro.webapp.controller.AbstractPageHandler

Direct Known Subclasses:

ManageProxiesCreatePage, ManageProxiesEditPage, ManageProxiesListPage, UserAccountsPage

public abstract class AbstractPageHandler
extends Object

A base class with some utility routines for page handler (created by controller classes. The controller logic is often complicated by the fact that the servlet must be multi-threaded. If a "page handler" instance is created for each request, it may share instance variables among its methods, which frequently makes for clearer logic.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractPageHandler.InvalidParametersException Indicates that parameters have failed validation.
static class	AbstractPageHandler.Message Set one of these on the session, so it can be interpreted and displayed at the next request.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.servlet.ServletContext	ctx
protected DataPropertyStatementDao	dpsDao
protected I18nBundle	i18n
protected IndividualDao	indDao
protected ObjectPropertyStatementDao	opsDao
protected org.apache.jena.ontology.OntModel	unionModel
protected UserAccountsDao	userAccountsDao
protected org.apache.jena.ontology.OntModel	userAccountsModel
protected VClassDao	vclassDao
protected VitroRequest	vreq

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPageHandler(VitroRequest vreq)

Method Summary

Modifier and Type	Method and Description
protected void	applyMessage(javax.servlet.http.HttpServletRequest req, Map<String,Object> body) If a Message has been set in the session, get it, store its info in the body map under "message", and remove it from the session, so it will not be displayed again.
protected int	getIntegerParameter(String key, int defaultValue)
protected String	getStringParameter(String key, String defaultValue)
protected List<String>	getStringParameters(String key)
protected boolean	isFlagOnRequest(String key) Check for the presence of a parameter, regardless of its value, even if it's an empty string.
protected boolean	isParameterAsExpected(String key, String expected) Treat the presence of a certain parameter, with a desired value, as a boolean flag.

Methods inherited from class java.lang.Object

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

Field Detail

vreq

protected final VitroRequest vreq

i18n

protected final I18nBundle i18n

ctx

protected final javax.servlet.ServletContext ctx

userAccountsModel

protected final org.apache.jena.ontology.OntModel userAccountsModel

unionModel

protected final org.apache.jena.ontology.OntModel unionModel

userAccountsDao

protected final UserAccountsDao userAccountsDao

vclassDao

protected final VClassDao vclassDao

indDao

protected final IndividualDao indDao

dpsDao

protected final DataPropertyStatementDao dpsDao

opsDao

protected final ObjectPropertyStatementDao opsDao

Constructor Detail

AbstractPageHandler

protected AbstractPageHandler(VitroRequest vreq)

Method Detail

getStringParameter

protected String getStringParameter(String key,
                                    String defaultValue)

getStringParameters

protected List<String> getStringParameters(String key)

getIntegerParameter

protected int getIntegerParameter(String key,
                                  int defaultValue)

isFlagOnRequest

protected boolean isFlagOnRequest(String key)

Check for the presence of a parameter, regardless of its value, even if it's an empty string.

isParameterAsExpected

protected boolean isParameterAsExpected(String key,
                                        String expected)

Treat the presence of a certain parameter, with a desired value, as a boolean flag. An example would be radio buttons with values of "yes" and "no". The expected value would be "yes".

applyMessage

protected void applyMessage(javax.servlet.http.HttpServletRequest req,
                            Map<String,Object> body)

If a Message has been set in the session, get it, store its info in the body map under "message", and remove it from the session, so it will not be displayed again.