org.dlese.dpc.dds.action.form

Class DDSQueryForm

java.lang.Object

org.apache.struts.action.ActionForm

org.dlese.dpc.dds.action.form.DDSViewResourceForm

org.dlese.dpc.dds.action.form.DDSQueryForm

All Implemented Interfaces:

java.io.Serializable

public final class DDSQueryForm
extends DDSViewResourceForm
implements java.io.Serializable

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

Author:

John Weatherley, Ryan Deardorff

See Also:

DDSQueryAction, Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

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

multipartRequestHandler, servlet

Constructor Summary

Constructors

Constructor and Description
DDSQueryForm() Constructor for the DDSQueryForm object

Method Summary

Modifier and Type	Method and Description
void	addDateString(java.lang.String add) Adds a feature to the DateString attribute of the DDSQueryForm object
void	addDateStringForUI(java.lang.String add) Adds a feature to the DateStringForUI attribute of the DDSQueryForm object
void	clearDateStrings() Description of the Method
java.lang.String	getContextURL() Gets the contextURL attribute of the SimpleQueryForm object
java.lang.String	getCs() Gets the cs attribute of the DDSQueryForm object
java.util.ArrayList	getDateStrings() Gets the dateStrings attribute of the DDSQueryForm object
java.lang.String	getDateStringsForUI() Gets the dateStringsForUI attribute of the DDSQueryForm object
java.lang.String	getEnd() Gets the ending index for the records that will be displayed.
java.lang.String	getError() Gets the error attribute of the DDSQueryForm object
java.lang.String	getGr() Gets the gr attribute of the DDSQueryForm object
java.lang.String	getHasViewableReview(int index) Gets the hasViewableReview attribute of the DDSQueryForm object
java.lang.String	getIsEmptySearch() If no keyword entered and no vocabs have been selected, return "true", otherwise return "false"
java.lang.String	getIsPartOfDRC(int index) Is the resource in the DRC?
java.lang.String	getKeywords() Gets the keywords attribute of the DDSQueryForm object
java.lang.String	getKeywordsTruncated() Gets the user keywords, truncated for feedback display
java.lang.String	getKy() Gets the ky attribute of the DDSQueryForm 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 SimpleQueryForm object
java.util.ArrayList	getNrqParams() Gets all request parameters except the refined query Rq parameter.
java.lang.String	getNumResults() Gets the numResults attribute of the SimpleQueryForm object
java.lang.String	getOffset() Gets the offset into the results array to begin iterating.
java.lang.String	getPagingLinks() Gets the pagingLinks attribute of the DDSQueryForm object
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	getRe() Gets the re attribute of the DDSQueryForm object
java.lang.String	getResourceResultLinkRedirectURL() Gets the resourceResultLinkRedirectURL attribute of the DDSQueryForm object
ResultDocList	getResults() Gets the search results returned by the SimpleLuceneIndex.
java.util.List	getResultsList() Gets the search results returned by the SimpleLuceneIndex as a List (compatible with c:forEach iteration)
java.lang.String	getRq() Gets the refined query string entered by the user, used to search within results.
java.lang.String	getSearchType() Gets the searchType attribute of the DDSQueryForm object
java.lang.String	getStart() Gets the starting index for the records that will be displayed.
java.lang.String	getSu() Gets the su attribute of the DDSQueryForm object
java.lang.String	getTotalNumResources() Gets the total number of resources that are currently discoverable.
java.lang.String	getView() view indicates which flavor of UI display is rendered (RSS for example)
MetadataVocabInputState	getVocabInputState() Gets the vocab attribute of the DDSQueryForm object
java.lang.String	getWnfrom() Gets the wnfrom attribute of the DDSQueryForm object
void	resetPagingLinks() Description of the Method
void	setContextURL(java.lang.String contextURL) Sets the contextURL attribute of the SimpleQueryForm object
void	setCs(java.lang.String contentStandard) Sets the cs attribute of the DDSQueryForm object
static void	setDebug(boolean db) Sets the debug attribute of the object
void	setError(java.lang.String error) Sets the error attribute of the DDSQueryForm object
void	setGr(java.lang.String gradeLevel) Sets the gr attribute of the DDSQueryForm object
void	setIsEmptySearch(boolean isEmptySearch) Sets the isEmptySearch attribute of the DDSQueryForm object
void	setKy(java.lang.String collection) Sets the ky attribute of the DDSQueryForm object
void	setMetadata(java.lang.String metadata) Sets the metadata attribute of the SimpleQueryForm object
void	setQ(java.lang.String queryString) Sets the q attribute of the SimpleQueryForm object
void	setRe(java.lang.String resourceType) Sets the re attribute of the DDSQueryForm object
void	setRequest(javax.servlet.http.HttpServletRequest request) Sets the request attribute of the SimpleQueryForm object.
void	setResourceResultLinkRedirectURL(java.lang.String str) Sets the resourceResultLinkRedirectURL attribute of the DDSQueryForm 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	setSearchType(java.lang.String str) Sets the searchType attribute of the DDSQueryForm object
void	setStart(int start) Sets the starting index for the records to display.
void	setSu(java.lang.String subject) Sets the su attribute of the DDSQueryForm object
void	setTotalNumResources(int numResources) Sets the totalNumResources that are currently discoverable.
void	setView(java.lang.String view) view indicates which flavor of UI display is rendered (RSS for example)
void	setVocabInputState(MetadataVocabInputState vocabInputState) Sets the vocabInputState attribute of the DDSQueryForm object
void	setWnfrom(java.lang.String wnfrom) Sets the wnfrom attribute of the DDSQueryForm object

Methods inherited from class org.dlese.dpc.dds.action.form.DDSViewResourceForm

clearVocabCache, getCachedVocabValuesInOrder, getCollectionDescription, getForwardUrl, getHasChallengingLearningContexts, getHasDrcReviews, getHasIdeasForUse, getHasOtherReviews, getHasReviews, getHasTeachingTips, getIdSearchTitle, getIdSearchUrl, getIsDrcReview, getIsDrcReviewInProgress, getItemDocReader, getNumRecordCollections, getPathwayUrl, getPrimaryRequestedCollectionKey, getPrimaryResultDoc, getPrimaryResultDocId, getRecordCollection, getRecordCollections, getRecordFilename, getRecordId, getRecordIds, getRecordIds, getRelDisplayed, getResourceTitle, getResourceUrl, getVocab, getVocabCacheFeedbackString, setCollectionKey, setContextUrl, setForwardUrl, setIdSearch, setPrimaryResultDoc, setPrimaryResultDocCollectionKey, setPrimaryResultDocId, setRecordFilename, setRecordId, setRelDisplayed, setSearcher, setSystem, setVocab, setVocabCacheFeedbackString, setVocabCacheGroup, setVocabCacheValue

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

DDSQueryForm

public DDSQueryForm()

Constructor for the DDSQueryForm object

Method Detail

resetPagingLinks

public void resetPagingLinks()

Description of the Method

setView

public void setView(java.lang.String view)

view indicates which flavor of UI display is rendered (RSS for example)

Parameters:

view - The new view value

getView

public java.lang.String getView()

view indicates which flavor of UI display is rendered (RSS for example)

Returns:

The viewType value

setWnfrom

public void setWnfrom(java.lang.String wnfrom)

Sets the wnfrom attribute of the DDSQueryForm object

Parameters:

wnfrom - The new wnfrom value

getWnfrom

public java.lang.String getWnfrom()

Gets the wnfrom attribute of the DDSQueryForm object

Returns:

The wnfrom value

getDateStrings

public java.util.ArrayList getDateStrings()

Gets the dateStrings attribute of the DDSQueryForm object

Returns:

The dateStrings value

clearDateStrings

public void clearDateStrings()

Description of the Method

addDateString

public void addDateString(java.lang.String add)

Adds a feature to the DateString attribute of the DDSQueryForm object

Parameters:

add - The feature to be added to the DateString attribute

addDateStringForUI

public void addDateStringForUI(java.lang.String add)

Adds a feature to the DateStringForUI attribute of the DDSQueryForm object

Parameters:

add - The feature to be added to the DateStringForUI attribute

getDateStringsForUI

public java.lang.String getDateStringsForUI()

Gets the dateStringsForUI attribute of the DDSQueryForm object

Returns:

The dateStringsForUI value

setSearchType

public void setSearchType(java.lang.String str)

Sets the searchType attribute of the DDSQueryForm object

Parameters:

str - The new searchType value

getSearchType

public java.lang.String getSearchType()

Gets the searchType attribute of the DDSQueryForm object

Returns:

The searchType value

setVocabInputState

public void setVocabInputState(MetadataVocabInputState vocabInputState)

Sets the vocabInputState attribute of the DDSQueryForm object

Parameters:

vocabInputState - The new vocabInputState value

getVocabInputState

public MetadataVocabInputState getVocabInputState()

Gets the vocab attribute of the DDSQueryForm object

Returns:

The vocab value

setError

public void setError(java.lang.String error)

Sets the error attribute of the DDSQueryForm object

Overrides:

setError in class DDSViewResourceForm

Parameters:

error - The new error value

getError

public java.lang.String getError()

Gets the error attribute of the DDSQueryForm object

Overrides:

getError in class DDSViewResourceForm

Returns:

The error value

setResourceResultLinkRedirectURL

public void setResourceResultLinkRedirectURL(java.lang.String str)

Sets the resourceResultLinkRedirectURL attribute of the DDSQueryForm object

Overrides:

setResourceResultLinkRedirectURL in class DDSViewResourceForm

Parameters:

str - The new resourceResultLinkRedirectURL value

getResourceResultLinkRedirectURL

public java.lang.String getResourceResultLinkRedirectURL()

Gets the resourceResultLinkRedirectURL attribute of the DDSQueryForm object

Overrides:

getResourceResultLinkRedirectURL in class DDSViewResourceForm

Returns:

The resourceResultLinkRedirectURL value

getContextURL

public java.lang.String getContextURL()

Gets the contextURL attribute of the SimpleQueryForm object

Returns:

The contextURL value

setContextURL

public void setContextURL(java.lang.String contextURL)

Sets the contextURL attribute of the SimpleQueryForm object

Parameters:

contextURL - The new contextURL value

getResults

public ResultDocList getResults()

Gets the search results returned by the SimpleLuceneIndex.

Returns:

The results value

getResultsList

public java.util.List getResultsList()

Gets the search results returned by the SimpleLuceneIndex as a List (compatible with c:forEach iteration)

Returns:

The resultsList value

setResults

public void setResults(ResultDocList results)

Sets the search results returned by the SimpleLuceneIndex.

Parameters:

results - The new results value.

getIsPartOfDRC

public java.lang.String getIsPartOfDRC(int index)

Is the resource in the DRC?

Parameters:

index -

Returns:

The isPartOfDRC value

getHasViewableReview

public java.lang.String getHasViewableReview(int index)

Gets the hasViewableReview attribute of the DDSQueryForm object

Parameters:

index -

Returns:

The hasViewableReview value

setMetadata

public void setMetadata(java.lang.String metadata)

Sets the metadata attribute of the SimpleQueryForm object

Parameters:

metadata - The new metadata value

getMetadata

public java.lang.String getMetadata()

Gets the metadata attribute of the SimpleQueryForm object

Returns:

The metadata value

getNumResults

public java.lang.String getNumResults()

Gets the numResults attribute of the SimpleQueryForm object

Returns:

The numResults value

getTotalNumResources

public java.lang.String getTotalNumResources()

Gets the total number of resources that are currently discoverable.

Returns:

The number of resource currently discoverable.

setTotalNumResources

public void setTotalNumResources(int numResources)

Sets the totalNumResources that are currently discoverable.

Parameters:

numResources - The totalNumResources that are currently discoverable.

getQ

public java.lang.String getQ()

Gets the query string entered by the user.

Returns:

The query value.

getGr

public java.lang.String getGr()

Gets the gr attribute of the DDSQueryForm object

Returns:

The gr value

setGr

public void setGr(java.lang.String gradeLevel)

Sets the gr attribute of the DDSQueryForm object

Parameters:

gradeLevel - The new gr value

getRe

public java.lang.String getRe()

Gets the re attribute of the DDSQueryForm object

Returns:

The re value

setRe

public void setRe(java.lang.String resourceType)

Sets the re attribute of the DDSQueryForm object

Parameters:

resourceType - The new re value

getCs

public java.lang.String getCs()

Gets the cs attribute of the DDSQueryForm object

Returns:

The cs value

setCs

public void setCs(java.lang.String contentStandard)

Sets the cs attribute of the DDSQueryForm object

Parameters:

contentStandard - The new cs value

getSu

public java.lang.String getSu()

Gets the su attribute of the DDSQueryForm object

Returns:

The su value

setSu

public void setSu(java.lang.String subject)

Sets the su attribute of the DDSQueryForm object

Parameters:

subject - The new su value

getKy

public java.lang.String getKy()

Gets the ky attribute of the DDSQueryForm object

Returns:

The ky value

setKy

public void setKy(java.lang.String collection)

Sets the ky attribute of the DDSQueryForm object

Parameters:

collection - The new ky 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.

getKeywordsTruncated

public java.lang.String getKeywordsTruncated()

Gets the user keywords, truncated for feedback display

Returns:

The keywordsTruncated value

getKeywords

public java.lang.String getKeywords()

Gets the keywords attribute of the DDSQueryForm object

Returns:

The keywords value

setQ

public void setQ(java.lang.String queryString)

Sets the q attribute of the SimpleQueryForm 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

getIsEmptySearch

public java.lang.String getIsEmptySearch()

If no keyword entered and no vocabs have been selected, return "true", otherwise return "false"

Returns:

The isEmptySearch value

setIsEmptySearch

public void setIsEmptySearch(boolean isEmptySearch)

Sets the isEmptySearch attribute of the DDSQueryForm object

Parameters:

isEmptySearch - The new isEmptySearch value

getNrqParams

public java.util.ArrayList getNrqParams()

Gets all request parameters except the refined query Rq parameter.

Returns:

The nrqParams value.

setStart

public void setStart(int start)

Sets the starting index for the records to display.

Parameters:

start - The new start 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

getPagingLinks

public java.lang.String getPagingLinks()

Gets the pagingLinks attribute of the DDSQueryForm object

Returns:

The pagingLinks 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

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest request)

Sets the request attribute of the SimpleQueryForm object.

Parameters:

request - The new request value

setDebug

public static void setDebug(boolean db)

Sets the debug attribute of the object

Parameters:

db - The new debug value