uk.co.lakesidetech.springxmldb.spring.web.controller
Class AbstractXMLDBController

java.lang.Object
  org.springframework.context.support.ApplicationObjectSupport
      org.springframework.web.context.support.WebApplicationObjectSupport
          org.springframework.web.servlet.support.WebContentGenerator
              org.springframework.web.servlet.mvc.AbstractController
                  uk.co.lakesidetech.springxmldb.spring.web.controller.AbstractXMLDBController

All Implemented Interfaces:

org.springframework.context.ApplicationContextAware, org.springframework.web.servlet.mvc.Controller

Direct Known Subclasses:

MultiXPathXMLDBController, RemoveXMLDBResourceController, SimpleXPathXMLDBController, SimpleXQueryXMLDBController, UrlFilenameXMLDBResourceController, XUpdateXMLDBController

public abstract class AbstractXMLDBController

extends org.springframework.web.servlet.mvc.AbstractController

implements org.springframework.web.servlet.mvc.Controller

The AbstractXMLDBController is the base class for all the generic XML database access Spring MVC controllers. It defines common properties used to configure the characteristics of the access to the database

Author:

Stuart Eccles

Field Summary

static java.lang.String

XMLQUERY_RESULTS_REQUEST_ATTRIBUTE

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

HEADER_CACHE_CONTROL, HEADER_EXPIRES, HEADER_PRAGMA, METHOD_GET, METHOD_POST

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

AbstractXMLDBController()

Method Summary

protected java.lang.String	formCollectionPathString(javax.servlet.http.HttpServletRequest request) figure the collection path string to query using the collection parameter and if the collection can be overridden by reqyest parameter "collection" also preappends the collection prefix if set
java.lang.String	getCollection()
java.lang.String	getCollectionPrefix()
int	getResultLimit()
java.lang.String	getView()
IXMLDBFacade	getXmldbFacade()
boolean	isAcceptCollectionFromRequest()
protected java.lang.String	replaceRequestParameterVariables(javax.servlet.http.HttpServletRequest request, java.lang.String replaceme)
void	setAcceptCollectionFromRequest(boolean acceptCollectionFromRequest)
void	setCollection(java.lang.String collection)
void	setCollectionPrefix(java.lang.String collectionPrefix)
void	setResultLimit(int resultLimit)
void	setView(java.lang.String view)
void	setXmldbFacade(IXMLDBFacade xmldbFacade)

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

handleRequest, handleRequestInternal, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isRequireSession, isUseCacheControlHeader, isUseExpiresHeader, preventCaching, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseExpiresHeader

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, isContextRequired

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.servlet.mvc.Controller

handleRequest

Field Detail

XMLQUERY_RESULTS_REQUEST_ATTRIBUTE

public static final java.lang.String XMLQUERY_RESULTS_REQUEST_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

AbstractXMLDBController

public AbstractXMLDBController()

Method Detail

setResultLimit

public void setResultLimit(int resultLimit)

Parameters:

resultLimit - The resultLimit to set.

getResultLimit

public int getResultLimit()

Returns:

Returns the resultLimit.

getCollectionPrefix

public java.lang.String getCollectionPrefix()

Returns:

Returns the collectionPrefix.

setCollectionPrefix

public void setCollectionPrefix(java.lang.String collectionPrefix)

Parameters:

collectionPrefix - The collectionPrefix to set.

isAcceptCollectionFromRequest

public boolean isAcceptCollectionFromRequest()

Returns:

Returns the acceptCollectionFromRequest.

setAcceptCollectionFromRequest

public void setAcceptCollectionFromRequest(boolean acceptCollectionFromRequest)

Parameters:

acceptCollectionFromRequest - The acceptCollectionFromRequest to set.

getView

public java.lang.String getView()

Returns:

Returns the view.

setView

public void setView(java.lang.String view)

Parameters:

view - The view to set.

getCollection

public java.lang.String getCollection()

Returns:

Returns the collection.

setCollection

public void setCollection(java.lang.String collection)

getXmldbFacade

public IXMLDBFacade getXmldbFacade()

Returns:

Returns the xmldbFacade.

setXmldbFacade

public void setXmldbFacade(IXMLDBFacade xmldbFacade)

Parameters:

xmldbFacade - The xmldbFacade to set.

formCollectionPathString

protected java.lang.String formCollectionPathString(javax.servlet.http.HttpServletRequest request)

figure the collection path string to query using the collection parameter and if the collection can be overridden by reqyest parameter "collection" also preappends the collection prefix if set

Parameters:

request -

Returns:

replaceRequestParameterVariables

protected java.lang.String replaceRequestParameterVariables(javax.servlet.http.HttpServletRequest request,
                                                            java.lang.String replaceme)