DLESE Tools
v1.6.0

org.dlese.dpc.oai.odlsearchclient.action
Class OdlSearchAction

java.lang.Object
  extended by org.apache.struts.action.Action
      extended by org.dlese.dpc.oai.odlsearchclient.action.OdlSearchAction

public final class OdlSearchAction
extends org.apache.struts.action.Action

A Struts Action for performing DLESE ODL searches of remote data providers that support DLESE ODL Search. See DLESE ODL search specification for details.

Author:
John Weatherley
See Also:
OdlSearchForm

Field Summary
 
Fields inherited from class org.apache.struts.action.Action
defaultLocale, servlet
 
Constructor Summary
OdlSearchAction()
           
 
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
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
 

Constructor Detail

OdlSearchAction

public OdlSearchAction()
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. 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 org.apache.struts.action.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 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
queryForm - DESCRIPTION
rm - DESCRIPTION
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.

Parameters:
isDebugOutput - The new debug value

DLESE Tools
v1.6.0