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

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
                      uk.co.lakesidetech.springxmldb.spring.web.controller.SimpleXQueryXMLDBController

All Implemented Interfaces:

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

Direct Known Subclasses:

FileXQueryXMLDBController

public class SimpleXQueryXMLDBController

extends AbstractXMLDBController

The SimpleXQueryXMLDBController is used to run an xquery query against a collection in an XML database where the xquery to run is supplied as a property of the object and can be set in the context configuration file

Author:

Stuart Eccles

Field Summary

protected java.lang.String

xquery

Fields inherited from class uk.co.lakesidetech.springxmldb.spring.web.controller.AbstractXMLDBController

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

SimpleXQueryXMLDBController()

Method Summary

protected java.lang.String	getQuery()
org.springframework.web.servlet.ModelAndView	handleRequestInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) handle the request and return the query results as an Map of resourceID and query result in the model as "results" to the view to handle (either as XSLT, or straight XML or JSTL in a JSP page)
void	setXquery(java.lang.String xquery)

Methods inherited from class uk.co.lakesidetech.springxmldb.spring.web.controller.AbstractXMLDBController

formCollectionPathString, getCollection, getCollectionPrefix, getResultLimit, getView, getXmldbFacade, isAcceptCollectionFromRequest, replaceRequestParameterVariables, setAcceptCollectionFromRequest, setCollection, setCollectionPrefix, setResultLimit, setView, setXmldbFacade

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

handleRequest, 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

xquery

protected java.lang.String xquery

Constructor Detail

SimpleXQueryXMLDBController

public SimpleXQueryXMLDBController()

Method Detail

setXquery

public void setXquery(java.lang.String xquery)

Parameters:

xquery - The xquery to set.

getQuery

protected java.lang.String getQuery()
                             throws java.io.IOException

Throws:

java.io.IOException

handleRequestInternal

public org.springframework.web.servlet.ModelAndView handleRequestInternal(javax.servlet.http.HttpServletRequest request,
                                                                          javax.servlet.http.HttpServletResponse response)
                                                                   throws java.lang.Exception

handle the request and return the query results as an Map of resourceID and query result in the model as "results" to the view to handle (either as XSLT, or straight XML or JSTL in a JSP page)

Parameters:

request - the HttpServletRequest

response - the HttpServletResponse

Returns:

The data model and view renderer

Throws:

java.lang.Exception - if anything goes wrong

See Also:

AbstractController.handleRequestInternal(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)