org.dlese.dpc.action
Class SimpleQueryAction

java.lang.Object
  org.apache.struts.action.Action
      org.dlese.dpc.action.SimpleQueryAction

public final class SimpleQueryAction

extends org.apache.struts.action.Action

A Struts Action for handling query requests that access a SimpleLuceneIndex. This class works in conjunction with the SimpleQueryForm Struts form bean class.

This class works by processing the HTTP request and outputting the corresponding HTTP response by forwarding to a JSP that will create it. Returns an ActionForward instance that maps to the Struts forwarding name "simple.query," "report.query," "weblog.query," or "weblogreport.query" which must be configured in struts-config.xml to indicate the JSP page that will handle and render the request.

An application that uses this class must set a ServletContext attribute containing a SimpleLuceneIndex under the key "index." This index will be used to perform the query. Optionally there may also be a web log index uder the key "webLogIndex".

Author:

John Weatherley

Field Summary

Fields inherited from class org.apache.struts.action.Action

ACTION_SERVLET_KEY, APPLICATION_KEY, DATA_SOURCE_KEY, defaultLocale, ERROR_KEY, EXCEPTION_KEY, FORM_BEANS_KEY, FORWARDS_KEY, LOCALE_KEY, MAPPING_KEY, MAPPINGS_KEY, MESSAGE_KEY, MESSAGES_KEY, MULTIPART_KEY, PLUG_INS_KEY, REQUEST_PROCESSOR_KEY, servlet, SERVLET_KEY, TRANSACTION_TOKEN_KEY

Constructor Summary

SimpleQueryAction()

Method Summary

org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, HttpServletRequest request, HttpServletResponse response) Processes the specified HTTP request and creates the corresponding HTTP response by forwarding to a JSP that will create it.
org.apache.struts.action.ActionForward	handleMetadataSearchRequest(org.apache.struts.action.ActionMapping mapping, SimpleQueryForm queryForm, HttpServletRequest request, HttpServletResponse response, RepositoryManager rm) Handle a request to search over metadata collections and forwared to the appropriate jsp page to render the response.
org.apache.struts.action.ActionForward	handleWebLogSearchRequest(org.apache.struts.action.ActionMapping mapping, SimpleQueryForm form, HttpServletRequest request, HttpServletResponse response) Handle a request to search over web logs and forwared to the appropriate jsp page to render the response.
static void	setDebug(boolean isDebugOutput) Gets the HTTP parameters that should be used to retrieve the previous set of results.

Methods inherited from class org.apache.struts.action.Action

execute, generateToken, getDataSource, getDataSource, getLocale, getResources, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, perform, perform, resetToken, saveErrors, saveMessages, saveToken, setLocale, setServlet, toHex

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleQueryAction

public SimpleQueryAction()

Method Detail

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm form,
                                                      HttpServletRequest request,
                                                      HttpServletResponse response)
                                               throws IOException,
                                                      ServletException

Processes the specified HTTP request and creates the corresponding HTTP response by forwarding to a JSP that will create it. A SimpleLuceneIndex must be available to this class via a ServletContext attribute under the key "index." Returns an ActionForward instance that maps to the Struts forwarding name "simple.query," which must be configured in struts-config.xml to forward to the JSP page that will handle the request.

Parameters:

mapping - The ActionMapping used to select this instance

request - The HTTP request we are processing

response - The HTTP response we are creating

form - The ActionForm for the given page

Returns:

The ActionForward instance describing where and how control should be forwarded

Throws:

IOException - if an input/output error occurs

ServletException - if a servlet exception occurs

handleMetadataSearchRequest

public org.apache.struts.action.ActionForward handleMetadataSearchRequest(org.apache.struts.action.ActionMapping mapping,
                                                                          SimpleQueryForm queryForm,
                                                                          HttpServletRequest request,
                                                                          HttpServletResponse response,
                                                                          RepositoryManager rm)
                                                                   throws IOException,
                                                                          ServletException

Handle a request to search over metadata collections and forwared to the appropriate jsp page to render the response.

Parameters:

mapping - The ActionMapping used to select this instance

request - The HTTP request we are processing

response - The HTTP response we are creating

Returns:

The ActionForward instance describing where and how control should be forwarded

Throws:

IOException - if an input/output error occurs

ServletException - if a servlet exception occurs

handleWebLogSearchRequest

public org.apache.struts.action.ActionForward handleWebLogSearchRequest(org.apache.struts.action.ActionMapping mapping,
                                                                        SimpleQueryForm form,
                                                                        HttpServletRequest request,
                                                                        HttpServletResponse response)
                                                                 throws IOException,
                                                                        ServletException

Handle a request to search over web logs and forwared to the appropriate jsp page to render the response.

Parameters:

mapping - The ActionMapping used to select this instance

request - The HTTP request we are processing

response - The HTTP response we are creating

form - The ActionForm for the given page

Returns:

The ActionForward instance describing where and how control should be forwarded

Throws:

IOException - if an input/output error occurs

ServletException - if a servlet exception occurs

setDebug

public static void setDebug(boolean isDebugOutput)

Gets the HTTP parameters that should be used to retrieve the previous set of results.

Returns:

Everything after the ? that should be included in the pager URL.