org.tigris.scarab.actions
Class Search

java.lang.Object
  org.apache.turbine.modules.Module
      org.apache.turbine.modules.Action
          org.apache.turbine.modules.ActionEvent
              org.apache.turbine.modules.actions.TemplateAction
                  org.apache.turbine.modules.actions.TemplateSecureAction
                      org.apache.turbine.TemplateSecureAction
                          org.tigris.scarab.actions.base.RequireLoginFirstAction
                              org.tigris.scarab.actions.Search

public class Search

extends RequireLoginFirstAction

This class is responsible for searching.

Version:

$Id: Search.java 10404 2006-12-28 15:33:29Z ronvoe122 $

Author:

John D. McNally, Elicia David, Jon S. Stevens

Field Summary

(package private) org.apache.fulcrum.intake.Intake	intake
(package private) ScarabLocalizationTool	l10n
(package private) org.apache.fulcrum.parser.ParameterParser	params
(package private) ScarabRequestTool	scarabR
(package private) ScarabUser	user

Fields inherited from class org.tigris.scarab.actions.base.RequireLoginFirstAction

DEFAULT_MSG, EMAIL_ERROR, EMAIL_ERROR2, ERROR_MESSAGE, NO_CHANGES_MADE, NO_PERMISSION_MESSAGE

Fields inherited from class org.apache.turbine.modules.ActionEvent

BUTTON, BUTTON_LENGTH, LENGTH, METHOD_NAME_LENGTH, METHOD_NAME_PREFIX

Constructor Summary

Search()

Method Summary

void	doAdduserbyusername(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context) Adds user to the search form.
void	doAddusers(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context) Adds users from temporary working list.
void	doDone(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context) Overrides base class.
boolean	doEditqueryinfo(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context)
void	doEditstoredquery(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context) Edits the stored query.
void	doGetissues(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context)
void	doGotoeditlist(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context)
void	doPerform(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context)
void	doPreparequery(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context)
void	doRedirecttocrossmodulelist(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context)
void	doRedirecttosavequery(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context) Redirects to form to save the query.
void	doRefinequery(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context) redirects to AdvancedQuery.
void	doRemoveusers(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context) Removes users from temporary working list.
void	doRunstoredquery(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context) Runs the stored story.
void	doSavequery(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context) Saves query.
void	doSearch(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context) Saves the query string for the logged-in user, and performs the default action of doPerform(org.apache.turbine.RunData, org.apache.turbine.TemplateContext).
void	doSelectquery(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context) This method handles clicking the Go button in the SearchNav.vm file.
void	doSetquerytarget(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context)
void	doUpdateusers(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context) Changes the user attribute a user is associated with.
static java.lang.String	getQueryString(org.apache.turbine.RunData data)
void	loadUsersFromUserList(org.apache.turbine.RunData data, java.util.Map userMap) In the case of a saved query, puts the saved query's users Into the selected users map

Methods inherited from class org.tigris.scarab.actions.base.RequireLoginFirstAction

areThereDupeSequences, doCancel, doGonext, doGotoothertemplate, doRefresh, doRefreshresultsperpage, doReset, doSave, getBackTemplate, getBackTemplate, getCancelTemplate, getCancelTemplate, getCurrentTemplate, getCurrentTemplate, getIntakeTool, getLastTemplate, getLocalizationTool, getNextTemplate, getNextTemplate, getOtherTemplate, getRequiredPermission, getScarabRequestTool, isAuthorized, log

Methods inherited from class org.apache.turbine.modules.actions.TemplateSecureAction

perform

Methods inherited from class org.apache.turbine.modules.actions.TemplateAction

doPerform, executeEvents

Methods inherited from class org.apache.turbine.modules.ActionEvent

execute, formatString

Methods inherited from class org.apache.turbine.modules.Module

build, doBuild, doBuildTemplate, doBuildTemplate, evaluate, getPullService, getTemplateContext, getTemplateService, getTool, handleRequest, handleRequest, requestFinished, setTarget, setTemplate, templateExists

Methods inherited from class java.lang.Object

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

Field Detail

l10n

ScarabLocalizationTool l10n

scarabR

ScarabRequestTool scarabR

intake

org.apache.fulcrum.intake.Intake intake

params

org.apache.fulcrum.parser.ParameterParser params

user

ScarabUser user

Constructor Detail

Search

public Search()

Method Detail

doPerform

public void doPerform(org.apache.turbine.RunData data,
                      org.apache.turbine.TemplateContext context)
               throws java.lang.Exception

Throws:

java.lang.Exception

doSearch

public void doSearch(org.apache.turbine.RunData data,
                     org.apache.turbine.TemplateContext context)
              throws java.lang.Exception

Saves the query string for the logged-in user, and performs the default action of doPerform(org.apache.turbine.RunData, org.apache.turbine.TemplateContext).

Throws:

java.lang.Exception

doRedirecttosavequery

public void doRedirecttosavequery(org.apache.turbine.RunData data,
                                  org.apache.turbine.TemplateContext context)
                           throws java.lang.Exception

Redirects to form to save the query. May redirect to Login page.

Throws:

java.lang.Exception

doRedirecttocrossmodulelist

public void doRedirecttocrossmodulelist(org.apache.turbine.RunData data,
                                        org.apache.turbine.TemplateContext context)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

doSavequery

public void doSavequery(org.apache.turbine.RunData data,
                        org.apache.turbine.TemplateContext context)
                 throws java.lang.Exception

Saves query.

Throws:

java.lang.Exception

doEditqueryinfo

public boolean doEditqueryinfo(org.apache.turbine.RunData data,
                               org.apache.turbine.TemplateContext context)
                        throws java.lang.Exception

Throws:

java.lang.Exception

doPreparequery

public void doPreparequery(org.apache.turbine.RunData data,
                           org.apache.turbine.TemplateContext context)
                    throws java.lang.Exception

Throws:

java.lang.Exception

doEditstoredquery

public void doEditstoredquery(org.apache.turbine.RunData data,
                              org.apache.turbine.TemplateContext context)
                       throws java.lang.Exception

Edits the stored query.

Throws:

java.lang.Exception

doRunstoredquery

public void doRunstoredquery(org.apache.turbine.RunData data,
                             org.apache.turbine.TemplateContext context)
                      throws java.lang.Exception

Runs the stored story.

Throws:

java.lang.Exception

doSelectquery

public void doSelectquery(org.apache.turbine.RunData data,
                          org.apache.turbine.TemplateContext context)
                   throws java.lang.Exception

This method handles clicking the Go button in the SearchNav.vm file. First it checks to see if the select box passed in a number or a string. If it is a number, then we run the stored query assuming the number is the query id. Else, we assume it is a string and that is our template to redirect to.

Throws:

java.lang.Exception

doRefinequery

public void doRefinequery(org.apache.turbine.RunData data,
                          org.apache.turbine.TemplateContext context)
                   throws java.lang.Exception

redirects to AdvancedQuery.

Throws:

java.lang.Exception

doDone

public void doDone(org.apache.turbine.RunData data,
                   org.apache.turbine.TemplateContext context)
            throws java.lang.Exception

Overrides base class.

Overrides:

doDone in class RequireLoginFirstAction

Throws:

java.lang.Exception

getQueryString

public static java.lang.String getQueryString(org.apache.turbine.RunData data)
                                       throws java.lang.Exception

Returns:

The search string used to perform the query. (Does not refer to the CGI context of the term "query string".)

Throws:

java.lang.Exception

doGetissues

public void doGetissues(org.apache.turbine.RunData data,
                        org.apache.turbine.TemplateContext context)
                 throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

doGotoeditlist

public void doGotoeditlist(org.apache.turbine.RunData data,
                           org.apache.turbine.TemplateContext context)
                    throws java.lang.Exception

Throws:

java.lang.Exception

doAddusers

public void doAddusers(org.apache.turbine.RunData data,
                       org.apache.turbine.TemplateContext context)
                throws java.lang.Exception

Adds users from temporary working list.

Throws:

java.lang.Exception

doAdduserbyusername

public void doAdduserbyusername(org.apache.turbine.RunData data,
                                org.apache.turbine.TemplateContext context)
                         throws java.lang.Exception

Adds user to the search form.

Throws:

java.lang.Exception

doRemoveusers

public void doRemoveusers(org.apache.turbine.RunData data,
                          org.apache.turbine.TemplateContext context)
                   throws java.lang.Exception

Removes users from temporary working list.

Throws:

java.lang.Exception

doUpdateusers

public void doUpdateusers(org.apache.turbine.RunData data,
                          org.apache.turbine.TemplateContext context)
                   throws java.lang.Exception

Changes the user attribute a user is associated with.

Throws:

java.lang.Exception

loadUsersFromUserList

public void loadUsersFromUserList(org.apache.turbine.RunData data,
                                  java.util.Map userMap)
                           throws java.lang.Exception

In the case of a saved query, puts the saved query's users Into the selected users map

Throws:

java.lang.Exception

doSetquerytarget

public void doSetquerytarget(org.apache.turbine.RunData data,
                             org.apache.turbine.TemplateContext context)
                      throws java.lang.Exception

Throws:

java.lang.Exception