org.dlese.dpc.action
Class SimpleQueryAction

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

public final class SimpleQueryAction
extends 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".

Version:

$Id: SimpleQueryAction.java,v 1.44 2010/07/14 00:18:48 jweather Exp $

Author:

John Weatherley

Field Summary

static String

SELECT_ALL String to display for selecting all

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

defaultLocale, servlet

Constructor Summary

SimpleQueryAction()

Method Summary

ActionForward	execute(ActionMapping mapping, 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.
ActionForward	handleMetadataSearchRequest(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.
ActionForward	handleWebLogSearchRequest(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) Sets the debug attribute of the SimpleQueryAction class

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

addErrors, addMessages, execute, generateToken, getDataSource, getDataSource, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Field Detail

SELECT_ALL

public static String SELECT_ALL

String to display for selecting all

Constructor Detail

SimpleQueryAction

public SimpleQueryAction()

Method Detail

execute

public ActionForward execute(ActionMapping mapping,
                             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.

Overrides:

execute in class Action

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 ActionForward handleMetadataSearchRequest(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

queryForm - The ActionForm for the given page

rm - The RepositoryManager

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 ActionForward handleWebLogSearchRequest(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)

Sets the debug attribute of the SimpleQueryAction class

Parameters:

isDebugOutput - The new debug value