org.dlese.dpc.dds.action
Class DDSQueryAction

java.lang.Object
  org.apache.struts.action.Action
      org.dlese.dpc.dds.action.DDSQueryAction

public final class DDSQueryAction

extends org.apache.struts.action.Action

A Struts Action for handling display of resource record descriptions, and their various collection info.

Author:

John Weatherley, Ryan Deardorff

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

DDSQueryAction()

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.
static String	getDisplayableItemsQuery(RepositoryManager rm) Limit searches to only those items that should be displayed in discovery.
static int	getNumResources(RepositoryManager rm) Gets the number of descrete resources that have been indexed and are currently discoverable.
org.apache.struts.action.ActionForward	handleMetadataSearchRequest(org.apache.struts.action.ActionMapping mapping, DDSQueryForm 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.
static void	setDebug(boolean isDebugOutput) Sets the debug attribute of the DDSQueryAction class

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

DDSQueryAction

public DDSQueryAction()

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

rm -

queryForm -

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

getDisplayableItemsQuery

public static String getDisplayableItemsQuery(RepositoryManager rm)

Limit searches to only those items that should be displayed in discovery.

Parameters:

rm - The RepositoryManager being used.

Returns:

The query used to get all records that are displayable.

getNumResources

public static int getNumResources(RepositoryManager rm)

Gets the number of descrete resources that have been indexed and are currently discoverable.

Parameters:

rm - The RepositoryManager being used.

Returns:

The number of resources that are currently discoverable.

setDebug

public static void setDebug(boolean isDebugOutput)

Sets the debug attribute of the DDSQueryAction class

Parameters:

isDebugOutput - The new debug value