org.sigpath.form
Class SpecifyMoleculeSearch

java.lang.Object
  org.apache.struts.action.ActionForm
      org.sigpath.form.SpecifyPagedResults
          org.sigpath.form.SpecifyMoleculeSearch

All Implemented Interfaces:

Serializable

public final class SpecifyMoleculeSearch
extends SpecifyPagedResults

Form bean for Specifying a Molecule Search. There are three fields on this page:

• search keyword
• search category
• start index

Version:

$Revision: 8030 $, $Date: 2005-07-25 19:19:56 -0400 (Mon, 25 Jul 2005) $

Author:

Ethan Cerami

See Also:

Serialized Form

Field Summary

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

multipartRequestHandler, servlet

Constructor Summary

SpecifyMoleculeSearch()

Method Summary

Map	getAllParameters() Get all name/value pairs used by this form.
String	getCategory() Get the Search Category.
String	getFormat() Gets the Format Specifier.
String	getKeyword() Get the Search Keyword.
String	getOrganism() Get the Organism.
String	getOtherOrganism() Get the other Organism.
String	getResultsPP() Get the resultsPP.
String	getReturnCollection() Indicates a collection of results should be returned.
String	getShowComplexCategory()
String	getShowProteinCategory()
String	getShowSmallMoleculeCategory()
int	getStartIndex() Get the Start Index for Search Results.
String	getView() Get the view.
void	reset(org.apache.struts.action.ActionMapping mapping, HttpServletRequest request) Reset all properties to their default values.
void	setCategory(String category) Set the Search Category.
void	setFormat(String format) Sets the Format Specifier.
void	setKeyword(String keyword) Set the Search Keyword.
void	setOrganism(String organism) Set the Organism.
void	setOtherOrganism(String otherOrganism) Set the other Organism.
void	setResultsPP(String resultsPP) Set the resultsPP.
void	setReturnCollection(String returnCollection) Indicate that a collection of results should be returned.
void	setShowComplexCategory(String value)
void	setShowProteinCategory(String value)
void	setShowSmallMoleculeCategory(String value)
void	setStartIndex(int startIndex) Sets the Start Index for Search Results.
void	setView(String view) Set the view.
org.apache.struts.action.ActionErrors	validate(org.apache.struts.action.ActionMapping mapping, HttpServletRequest request) Validate the properties that have been set from this HTTP request, and return an ActionErrors object that encapsulates any validation errors that have been found.

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

getMultipartRequestHandler, getServlet, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

SpecifyMoleculeSearch

public SpecifyMoleculeSearch()

Method Detail

getReturnCollection

public String getReturnCollection()

Indicates a collection of results should be returned.

Returns:

A string representation of a boolean value.

setReturnCollection

public void setReturnCollection(String returnCollection)

Indicate that a collection of results should be returned.

Parameters:

returnCollection - A string representation of a boolean value.

getKeyword

public String getKeyword()

Get the Search Keyword.

Returns:

String

setKeyword

public void setKeyword(String keyword)

Set the Search Keyword.

Parameters:

keyword - the search keyword

getCategory

public String getCategory()

Get the Search Category.

Returns:

String

setCategory

public void setCategory(String category)

Set the Search Category.

Parameters:

category - the search category

getStartIndex

public int getStartIndex()

Get the Start Index for Search Results.

Overrides:

getStartIndex in class SpecifyPagedResults

Returns:

an integer indicating the current index within search results.

setFormat

public void setFormat(String format)

Sets the Format Specifier.

Parameters:

format -

getFormat

public String getFormat()

Gets the Format Specifier.

Returns:

format specifier

setStartIndex

public void setStartIndex(int startIndex)

Sets the Start Index for Search Results.

Overrides:

setStartIndex in class SpecifyPagedResults

Parameters:

startIndex - integer indicating the current index within search results.

getOrganism

public String getOrganism()

Get the Organism.

Returns:

String

setOrganism

public void setOrganism(String organism)

Set the Organism.

Parameters:

organism - the organism to search for

getOtherOrganism

public String getOtherOrganism()

Get the other Organism.

Returns:

String

setOtherOrganism

public void setOtherOrganism(String otherOrganism)

Set the other Organism.

Parameters:

otherOrganism - the alternative organism to search for

getResultsPP

public String getResultsPP()

Get the resultsPP.

Returns:

String

setResultsPP

public void setResultsPP(String resultsPP)

Set the resultsPP.

Parameters:

resultsPP - number of results per page

getView

public String getView()

Get the view.

Returns:

String

setView

public void setView(String view)

Set the view.

Parameters:

view - format to display results in eg: xml

setShowSmallMoleculeCategory

public void setShowSmallMoleculeCategory(String value)

getShowSmallMoleculeCategory

public String getShowSmallMoleculeCategory()

setShowProteinCategory

public void setShowProteinCategory(String value)

getShowProteinCategory

public String getShowProteinCategory()

setShowComplexCategory

public void setShowComplexCategory(String value)

getShowComplexCategory

public String getShowComplexCategory()

reset

public void reset(org.apache.struts.action.ActionMapping mapping,
                  HttpServletRequest request)

Reset all properties to their default values.

Overrides:

reset in class org.apache.struts.action.ActionForm

Parameters:

mapping - The mapping used to select this instance

request - The servlet request we are processing

validate

public org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping mapping,
                                                      HttpServletRequest request)

Validate the properties that have been set from this HTTP request, and return an ActionErrors object that encapsulates any validation errors that have been found. If no errors are found, return null or an ActionErrors object with no recorded error messages.

Overrides:

validate in class org.apache.struts.action.ActionForm

Parameters:

mapping - The mapping used to select this instance

request - The servlet request we are processing

Returns:

ActionErrors object containing all validation errors

getAllParameters

public Map getAllParameters()

Get all name/value pairs used by this form.

Specified by:

getAllParameters in class SpecifyPagedResults

Returns:

map of values indexed by parameter name