org.dlese.dpc.action.form
Class SimpleQueryForm

java.lang.Object
  org.apache.struts.action.ActionForm
      org.dlese.dpc.action.form.SimpleQueryForm

All Implemented Interfaces:

Serializable

public final class SimpleQueryForm

extends org.apache.struts.action.ActionForm

implements Serializable

A Struts Form bean for handling query requests that access a SimpleLuceneIndex. This class works in conjuction with the SimpleQueryAction Struts Action class.

Author:

John Weatherley

See Also:

Serialized Form

Nested Class Summary

class

SimpleQueryForm.ParamPair Holds paramter, value pairs.

Field Summary

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

multipartRequestHandler, servlet

Constructor Summary

SimpleQueryForm()
Constructor for the SimpleQueryForm object

Method Summary

List	getCollectionLabels() Gets the collectionLabels attribute of the SimpleQueryForm object
List	getCollections() Gets the collections attribute of the SimpleQueryForm object
String	getContextURL() Gets the contextURL attribute of the SimpleQueryForm object
String	getEnd() Gets the ending index for the records that will be displayed.
List	getFormatLabels() Gets the formatLabels attribute of the SimpleQueryForm object
List	getFormats() Gets the formats attribute of the SimpleQueryForm object
String	getLength() Gets the length of iterations to loop over the results array.
String	getMetadata() Gets the metadata attribute of the SimpleQueryForm object
String	getNextResultsUrl() Gets the HTTP parameters that should be used to retrieve the next set of results.
String	getNonPaigingParams() Gets all the parameters that existed in the request other than those used for paiging.
ArrayList	getNrqParams() Gets all request parameters except the refined query Rq parameter.
String	getNumResults() Gets the numResults attribute of the SimpleQueryForm object
String	getOffset() Gets the offset into the results array to begin iterating.
String	getPrevResultsUrl() Gets the HTTP parameters that should be used to retrieve the previous set of results.
String	getQ() Gets the query string entered by the user.
String	getQe() Gets the query string entered by the user, encoded for use in a URL string.
String	getReportTitle() Gets the reportTitle attribute of the SimpleQueryForm object
ResultDoc	getResult()
ResultDoc[]	getResults() Gets the search results returned by the SimpleLuceneIndex.
String	getRq() Gets the refined query string entered by the user, used to search within results.
String	getSc() Gets the collection that has been selected by the user in the UI via a Select tag.
String	getScparams() Gets the selected collection(s) parameter to be inserted in the URL that gets the next set of results.
String[]	getScs() Gets the collections that have been selected by the user in the UI.
String[]	getSfmts() Gets the sfmts attribute of the SimpleQueryForm object
String	getStart() Gets the starting index for the records that will be displayed.
void	setCollectionLabels(List collectionLabels) Sets the collectionLabels attribute of the SimpleQueryForm object
void	setCollections(List collections) Sets the collections attribute of the SimpleQueryForm object
void	setContextURL(String contextURL) Sets the contextURL attribute of the SimpleQueryForm object
static void	setDebug(boolean db) Sets the debug attribute of the object
void	setFormats(List formats) Sets the formats attribute of the SimpleQueryForm object
void	setMetadata(String metadata) Sets the metadata attribute of the SimpleQueryForm object
void	setNonPaigingParams(String nonPaigingParams)
void	setNumPagingRecords(int numPagingRecords) Sets the number of records to display per paiging request.
void	setQ(String queryString) Sets the q attribute of the SimpleQueryForm object
void	setReportTitle(String reportTitle) Sets the reportTitle attribute of the SimpleQueryForm object
void	setRequest(HttpServletRequest request) Sets the request attribute of the SimpleQueryForm object.
void	setResult(ResultDoc resultDoc)
void	setResults(ResultDoc[] results) Sets the search results returned by the SimpleLuceneIndex.
void	setRq(String refineQueryString) Sets the refined query string entered by the user, used to search within results.
void	setSc(String selectedCollection) Sets the collection that has been selected by the user in the UI via a Select tag.
void	setScs(String[] selectedCollections) Sets the collection that has been selected by the user in the UI.
void	setSfmts(String[] selectedFormats) Sets the sfmts attribute of the SimpleQueryForm object
void	setStart(int start) Sets the starting index for the records to display.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleQueryForm

public SimpleQueryForm()

Constructor for the SimpleQueryForm object

Method Detail

getContextURL

public String getContextURL()

Gets the contextURL attribute of the SimpleQueryForm object

Returns:

The contextURL value

setContextURL

public void setContextURL(String contextURL)

Sets the contextURL attribute of the SimpleQueryForm object

Parameters:

contextURL - The new contextURL value

setCollections

public void setCollections(List collections)

Sets the collections attribute of the SimpleQueryForm object

Parameters:

collections - The new collections value

getCollections

public List getCollections()

Gets the collections attribute of the SimpleQueryForm object

Returns:

The collections value

setCollectionLabels

public void setCollectionLabels(List collectionLabels)

Sets the collectionLabels attribute of the SimpleQueryForm object

Parameters:

collectionLabels - The new collectionLabels value

getCollectionLabels

public List getCollectionLabels()

Gets the collectionLabels attribute of the SimpleQueryForm object

Returns:

The collectionLabels value

getFormats

public List getFormats()

Gets the formats attribute of the SimpleQueryForm object

Returns:

The formats value

setFormats

public void setFormats(List formats)

Sets the formats attribute of the SimpleQueryForm object

Parameters:

formats - The new formats value

getFormatLabels

public List getFormatLabels()

Gets the formatLabels attribute of the SimpleQueryForm object

Returns:

The formatLabels value

getSfmts

public String[] getSfmts()

Gets the sfmts attribute of the SimpleQueryForm object

Returns:

The sfmts value

setSfmts

public void setSfmts(String[] selectedFormats)

Sets the sfmts attribute of the SimpleQueryForm object

Parameters:

selectedFormats - The new sfmts value

getSc

public String getSc()

Gets the collection that has been selected by the user in the UI via a Select tag. For example '0dcc'. For use with a Struts select tag that does not have multiple selection enabled.

Sample HTML code using Struts:

<html:select property="sc" size="1" >
<html:options name="queryForm" property="collections" labelProperty="collectionLabels"/>
</html:select>


Returns:

The selected collection.

setSc

public void setSc(String selectedCollection)

Sets the collection that has been selected by the user in the UI via a Select tag. For example '0dcc'. For use with a Struts select tag that does not have multiple selection enabled.

Parameters:

selectedCollection - The new sc value

getScs

public String[] getScs()

Gets the collections that have been selected by the user in the UI. For example '0dcc' '0comet'. For use with a Struts select tag that has multiple selection enabled.

Sample HTML code using Struts:

<html:select property="scs" size="5" multiple="t">
<html:options name="queryForm" property="collections" labelProperty="collectionLabels"/>
</html:select>


Returns:

The selected collections.

setScs

public void setScs(String[] selectedCollections)

Sets the collection that has been selected by the user in the UI. For example '0dcc' '0comet'. For use with a Struts select tag that has multiple selection enabled.

Parameters:

selectedCollections - The new sc value

getScparams

public String getScparams()

Gets the selected collection(s) parameter to be inserted in the URL that gets the next set of results.

Returns:

The scparams value.

getResults

public ResultDoc[] getResults()

Gets the search results returned by the SimpleLuceneIndex.

Returns:

The results value

setResults

public void setResults(ResultDoc[] results)

Sets the search results returned by the SimpleLuceneIndex.

Parameters:

results - The new results value.

setResult

public void setResult(ResultDoc resultDoc)

getResult

public ResultDoc getResult()

setMetadata

public void setMetadata(String metadata)

Sets the metadata attribute of the SimpleQueryForm object

Parameters:

metadata - The new metadata value

getMetadata

public String getMetadata()

Gets the metadata attribute of the SimpleQueryForm object

Returns:

The metadata value

getNumResults

public String getNumResults()

Gets the numResults attribute of the SimpleQueryForm object

Returns:

The numResults value

getQ

public String getQ()

Gets the query string entered by the user.

Returns:

The query value.

getQe

public String getQe()

Gets the query string entered by the user, encoded for use in a URL string.

Returns:

The query value ncoded for use in a URL string.

setQ

public void setQ(String queryString)

Sets the q attribute of the SimpleQueryForm object

Parameters:

queryString - The new q value

getRq

public String getRq()

Gets the refined query string entered by the user, used to search within results.

Returns:

The query value.

setRq

public void setRq(String refineQueryString)

Sets the refined query string entered by the user, used to search within results.

Parameters:

refineQueryString - The new rq value

getNrqParams

public ArrayList getNrqParams()

Gets all request parameters except the refined query Rq parameter.

Returns:

The nrqParams value.

setReportTitle

public void setReportTitle(String reportTitle)

Sets the reportTitle attribute of the SimpleQueryForm object

Parameters:

reportTitle - The new reportTitle value

getReportTitle

public String getReportTitle()

Gets the reportTitle attribute of the SimpleQueryForm object

Returns:

The reportTitle value

setStart

public void setStart(int start)

Sets the starting index for the records to display.

Parameters:

start - The new start value

getStart

public String getStart()

Gets the starting index for the records that will be displayed.

Returns:

The start value

getEnd

public String getEnd()

Gets the ending index for the records that will be displayed.

Returns:

The end value

getOffset

public String getOffset()

Gets the offset into the results array to begin iterating.

Returns:

The offset value

getLength

public String getLength()

Gets the length of iterations to loop over the results array.

Returns:

The length value

setNumPagingRecords

public void setNumPagingRecords(int numPagingRecords)

Sets the number of records to display per paiging request. Defaults to 10.

Parameters:

numPagingRecords - The new numPagingRecords value

getNextResultsUrl

public String getNextResultsUrl()

Gets the HTTP parameters that should be used to retrieve the next set of results.

Returns:

Everything after the ? that should be included in the pager URL.

getPrevResultsUrl

public String getPrevResultsUrl()

Gets the HTTP parameters that should be used to retrieve the previous set of results.

Returns:

Everything after the ? that should be included in the pager URL.

setRequest

public void setRequest(HttpServletRequest request)

Sets the request attribute of the SimpleQueryForm object.

Parameters:

request - The new request value

setNonPaigingParams

public void setNonPaigingParams(String nonPaigingParams)

getNonPaigingParams

public final String getNonPaigingParams()

Gets all the parameters that existed in the request other than those used for paiging.

Returns:

The NonPaigingParams returned as an HTTP query string.

setDebug

public static void setDebug(boolean db)

Sets the debug attribute of the object

Parameters:

db - The new debug value