org.dlese.dpc.oai.odlsearchclient.action.form

Class OdlSearchForm

java.lang.Object

org.apache.struts.action.ActionForm

org.dlese.dpc.oai.odlsearchclient.action.form.OdlSearchForm

All Implemented Interfaces:

java.io.Serializable

public final class OdlSearchForm
extends org.apache.struts.action.ActionForm
implements java.io.Serializable

A Struts Form bean for handling remote search results returned in responst to a DLESE ODL search request.

Author:

John Weatherley

See Also:

OdlSearchAction, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OdlSearchForm.ParamPair Holds paramter, value pairs.

Field Summary

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

multipartRequestHandler, servlet

Constructor Summary

Constructors

Constructor and Description
OdlSearchForm() Constructor for the OdlSearchForm object

Method Summary

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

OdlSearchForm

public OdlSearchForm()

Constructor for the OdlSearchForm object

Method Detail

getBaseURL

public java.lang.String getBaseURL()

setBaseURL

public void setBaseURL(java.lang.String baseURL)

getContextURL

public java.lang.String getContextURL()

Gets the contextURL attribute of the OdlSearchForm object

Returns:

The contextURL value

setContextURL

public void setContextURL(java.lang.String contextURL)

Sets the contextURL attribute of the OdlSearchForm object

Parameters:

contextURL - The new contextURL value

setCollections

public void setCollections(java.util.List collections)

Sets the collections attribute of the OdlSearchForm object

Parameters:

collections - The new collections value

getCollections

public java.util.List getCollections()

Gets the collections attribute of the OdlSearchForm object

Returns:

The collections value

setCollectionLabels

public void setCollectionLabels(java.util.List collectionLabels)

Sets the collectionLabels attribute of the OdlSearchForm object

Parameters:

collectionLabels - The new collectionLabels value

getCollectionLabels

public java.util.List getCollectionLabels()

Gets the collectionLabels attribute of the OdlSearchForm object

Returns:

The collectionLabels value

getFormats

public java.util.List getFormats()

Gets the formats attribute of the OdlSearchForm object

Returns:

The formats value

setFormats

public void setFormats(java.util.List formats)

Sets the formats attribute of the OdlSearchForm object

Parameters:

formats - The new formats value

getFormatLabels

public java.util.List getFormatLabels()

Gets the formatLabels attribute of the OdlSearchForm object

Returns:

The formatLabels value

getSfmts

public java.lang.String[] getSfmts()

Gets the sfmts attribute of the OdlSearchForm object

Returns:

The sfmts value

setSfmts

public void setSfmts(java.lang.String[] selectedFormats)

Sets the sfmts attribute of the OdlSearchForm object

Parameters:

selectedFormats - The new sfmts value

getSc

public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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 ResultDocList getResults()

Gets the search results returned by the SimpleLuceneIndex.

Returns:

The results value

setResults

public void setResults(ResultDocList results)

Sets the search results returned by the SimpleLuceneIndex.

Parameters:

results - The new results value.

setResult

public void setResult(ResultDoc resultDoc)

Sets the result attribute of the OdlSearchForm object

Parameters:

resultDoc - The new result value

getResult

public ResultDoc getResult()

Gets the result attribute of the OdlSearchForm object

Returns:

The result value

setMetadata

public void setMetadata(java.lang.String metadata)

Sets the metadata attribute of the OdlSearchForm object

Parameters:

metadata - The new metadata value

getMetadata

public java.lang.String getMetadata()

Gets the metadata attribute of the OdlSearchForm object

Returns:

The metadata value

getNumResults

public java.lang.String getNumResults()

Gets the numResults attribute of the OdlSearchForm object

Returns:

The numResults value

getQ

public java.lang.String getQ()

Gets the query string entered by the user.

Returns:

The query value.

getQe

public java.lang.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(java.lang.String queryString)

Sets the q attribute of the OdlSearchForm object

Parameters:

queryString - The new q value

getRq

public java.lang.String getRq()

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

Returns:

The query value.

setRq

public void setRq(java.lang.String refineQueryString)

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

Parameters:

refineQueryString - The new rq value

getNrqParams

public java.util.ArrayList getNrqParams()

Gets all request parameters except the refined query Rq parameter.

Returns:

The nrqParams value.

setReportTitle

public void setReportTitle(java.lang.String reportTitle)

Sets the reportTitle attribute of the OdlSearchForm object

Parameters:

reportTitle - The new reportTitle value

getReportTitle

public java.lang.String getReportTitle()

Gets the reportTitle attribute of the OdlSearchForm 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 java.lang.String getStart()

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

Returns:

The start value

getEnd

public java.lang.String getEnd()

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

Returns:

The end value

getOffset

public java.lang.String getOffset()

Gets the offset into the results array to begin iterating.

Returns:

The offset value

getLength

public java.lang.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 java.lang.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 java.lang.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(javax.servlet.http.HttpServletRequest request)

Sets the request attribute of the OdlSearchForm object.

Parameters:

request - The new request value

setNonPaigingParams

public void setNonPaigingParams(java.lang.String nonPaigingParams)

Sets the nonPaigingParams attribute of the OdlSearchForm object

Parameters:

nonPaigingParams - The new nonPaigingParams value

getNonPaigingParams

public final java.lang.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