|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.droplet.EmptyFormHandler atg.droplet.GenericFormHandler atg.search.query.formhandlers.BaseSearchFormHandler
public abstract class BaseSearchFormHandler
This class provides the generic functionality for executing queries against the search server and retrieving results. Subclasses implement query specific functionality, in particular they provide implementations for the following abstract methods:
protected ClientRequest createClientRequest( DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse ); * protected SearchMessage createSearchMessage( ClientRequest pClientRequest, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse );This class also provides support for the documentSets and parserOptions properties, these properties are common to all request types (though the ViewInContext tag doesn't use them directly.)
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
protected static java.lang.String |
DEFAULT_ANONYMOUS_USERNAME
|
protected static java.lang.String |
DEFAULT_SITE_NAME
|
Fields inherited from class atg.droplet.GenericFormHandler |
---|
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
BaseSearchFormHandler()
|
Method Summary | |
---|---|
protected Results |
afterSearch(ClientRequest pRequest,
SearchContext pContext,
SearchSession pSession,
Results pResults)
This method is called just after a search has been executed and is intended to allow subclasses an opportunity to update the search session or modify the search results object. |
void |
beforeGet(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Calls parent beforeGet() then calls buildClientRequest(pRequest,pResponse) to create the appropriate ClientRequest object. |
protected ClientRequest |
beforeSearch(ClientRequest pRequest,
SearchContext pContext,
SearchSession pSession)
This method is called just before a search is executed and is intended to allow subclasses an opportunity to make last minute changes to the request object or to update the search context. |
boolean |
beforeSet(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Calls parent beforeSet() then calls buildClientRequest(pRequest,pResponse) to create the appropriate ClientRequest object. |
protected void |
buildClientRequest(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
If there is no current ClientRequest object, delegate to the subclass the creation of this object. |
protected java.lang.StringBuffer |
buildSimpleTag(java.lang.String pTagName,
java.lang.String pTagValue,
java.util.Map pAttributes)
Build a simple tag |
protected abstract ClientRequest |
createClientRequest(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Called to create the subclass object of the client request |
java.util.Map |
createOptionSet(java.lang.String pOptionSetName)
Return the named option set or null if no option set exists for the specified name. |
protected abstract SearchMessage |
createSearchMessage(ClientRequest pClientRequest,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Create a JMS message to send to listeners to notify them of the search and search results |
SearchSession |
createSearchSession(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Create the SearchSession by first calling createSessionConfig() to obtain a configuration, then by calling ESSearchService.createSession() |
protected SessionConfig |
createSessionConfig(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Create and initialize SessionConfig object |
java.util.Map |
decodeMapData(java.lang.String pData,
java.lang.String pPairRegex,
KeyValueSplitter pSpliter)
Decode encoded key/value data from a string, return results in a map. |
protected void |
dumpMap(java.lang.String pMapPropertyName,
java.util.Map pMap)
For debugging, dump the contents of a map and print a string indicating what property of the request this map represents. |
protected void |
dumpRequestInfo(ClientRequest pRequest)
Dump request information. |
protected java.lang.String |
encodeArrayData(java.lang.String[] pArray,
java.lang.String pPrefix,
java.lang.String pSuffix,
java.lang.String pDelimiter)
Translate an array into a string of encoded values using the specified delimiter and separator values. |
protected java.lang.String |
encodeCollectionData(java.util.Collection pCollection,
java.lang.String pPrefix,
java.lang.String pSuffix,
java.lang.String pDelimiter)
Translate a collection into a string of encoded values using the specified delimiter and separator values. |
protected java.lang.String |
encodeMapData(java.util.Map pMap,
java.lang.String pPrefix,
java.lang.String pSeparator,
java.lang.String pSuffix,
java.lang.String pDelimiter)
Translate a map into a string of encoded key/value pairs using the specified delimiter and separator values |
java.lang.String |
getAnonymousUserName()
Get the string to use for the anonymous user. |
boolean |
getAutoRedirect()
If set to true then the form handler will check the search results for a redirect URL and if found redirect to it. |
protected java.lang.Boolean |
getBooleanRequestAttribute(java.lang.String pAttributeName)
Get a request attribute value as a Boolean |
protected boolean |
getBoolRequestAttribute(java.lang.String pAttributeName,
boolean pDefault)
Get a request attribute value as an int |
java.lang.String |
getClearQueryURL()
Get the optional URL to redirect to when handleClearQuery() is invoked |
ClientRequest |
getClientRequest()
Get the client request object from the search context. |
protected DocumentSetConstraint |
getDocumentSets()
Get the <documentSets> tag contents as DocumentSetConstraint object. |
XMLBuilder |
getDocumentSetsBuilder()
Get the optional XMLBuilder object. |
java.lang.String |
getErrorURL()
Get the optional url to redirect to when an error is encountered in handleSearch() |
protected java.lang.Integer |
getIntegerRequestAttribute(java.lang.String pAttributeName)
Get a request attribute value as an Integer |
protected int |
getIntRequestAttribute(java.lang.String pAttributeName,
int pDefault)
Get a request attribute value as an int |
java.util.Map |
getOptionSet()
Set the option set in use for this request. |
java.lang.String |
getOptionSetName()
Get the option set name to use for this query, or null to use the default option set for this query type. |
protected ParserOptions |
getParserOptions()
Returns a ParserOptions object. |
XMLBuilder |
getParserOptionsBuilder()
Get the optional parser options builder object. |
java.lang.String |
getRequestAttribute(java.lang.String pAttributeName)
Get a request attribute associated with specified attribute name. |
java.util.Map |
getRequestAttributes()
Return the request attribute map |
Results |
getResults()
Return the Results object. |
ResultsFetchingProxy |
getResultsFetcher()
Get the results fetcher. |
SearchContext |
getSearchContext()
Get the session scoped search context |
protected SearchMessageSource |
getSearchMessageSource()
Get the message source for this component. |
ESSearchService |
getSearchService()
Get the ESSearchService, the interface to the search service |
SearchSession |
getSearchSession()
Return the search session from the search context or null if one does not yet exist. |
boolean |
getSessionBasedSearchRequest()
Set to true to save search request in the SearchContext component, false otherwise. |
boolean |
getSessionBasedSearchResults()
Set to true to save search Results object in SearchContext object, false otherwise. |
java.lang.String |
getSessionConfigLanguage()
Get the value used to initialize the SessionConfig's language property. |
protected java.util.Map |
getSiteDefaultOptionSet(ClientRequest pRequest,
SearchSession pSession)
Get the default option set for this client request. |
java.lang.String |
getSiteName()
Get the site name. |
java.lang.String[] |
getStringArrayRequestAttribute(java.lang.String pKey,
java.lang.String pSeparator)
Return a request attribute value, identified by the specified key, as a String array |
java.lang.String |
getSuccessURL()
Get the optional url to redirect to on a successful search. |
RepositoryItem |
getUserProfile()
Get the user profile repository item or null. |
protected boolean |
handleAutoRedirect(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse,
Results pResults,
boolean pResult)
Method to handle a redirect url in the search results. |
boolean |
handleClearQuery(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Handle clear query |
protected boolean |
handleErrorCondition(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse,
java.lang.Exception pException)
|
boolean |
handleSearch(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Handle search request. |
boolean |
isRequestLogging()
Get the loggingEnabled property of the client request. |
protected java.util.Map |
mergeMaps(java.util.Map pBase,
java.util.Map pOverrides)
Merge override map entries with base entries. |
protected void |
prepareClientRequest(DynamoHttpServletRequest pRequest)
Called during handleSearch, sets the parser/parsing and constraints/documentSets values into the request object. |
protected void |
sendSearchMessage(ClientRequest pClientRequest,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Send a JMS Search message via configured SearchMessageSource. |
void |
setAnonymousUserName(java.lang.String pAnonymousUserName)
Set the name of the user to use for anonymous searches. |
void |
setAutoRedirect(boolean pAutoRedirect)
If set to true then the form handler will check the search results for a redirect URL and if found redirect to it. |
protected void |
setBooleanRequestAttribute(java.lang.String pAttributeName,
java.lang.Boolean pAttributeValue)
Convince method to set a request attribute using a Boolean value |
void |
setClearQueryURL(java.lang.String pClearQueryURL)
Set the optional URL to go to when handleClearQuery() is invoked. |
protected void |
setClientRequest(ClientRequest pClientRequest)
Set the client request object. |
void |
setDocumentSetsBuilder(XMLBuilder pDocumentSetsBuilder)
Set an optional XMLBuilder object. |
void |
setErrorURL(java.lang.String pErrorURL)
Set the optional url to redirect to when an error is encountered in handleSearch() |
void |
setOptionSet(java.util.Map pOptionSet)
Set the option set in use for this request. |
void |
setOptionSetName(java.lang.String pOptionSetName)
Set the option set name to use for this query. |
void |
setParserOptionsBuilder(XMLBuilder pParserOptionsBuilder)
Set an optional parser options builder object. |
java.lang.String |
setRequestAttribute(java.lang.String pKey,
java.lang.String pValue)
Set a request attribute into the request attribute map. |
void |
setRequestAttributes(java.util.Map pRequestAttributes)
Set request attribute map. |
void |
setRequestLogging(boolean pLogging)
Set the loggingEnabled property of the ClientRequest object |
protected void |
setResults(Results pResults)
Set the Results object returned from the search server. |
void |
setResultsFetcher(ResultsFetchingProxy pResultsFetcher)
Set a results fetching proxy. |
void |
setSearchContext(SearchContext pSearchContext)
Set the session scoped search context object |
void |
setSearchService(ESSearchService pSearchService)
Set the ESSearchService instance, this is the connection to the search server |
void |
setSessionBasedSearchRequest(boolean pSession)
Set to true to save search request in the SearchContext component, false otherwise. |
void |
setSessionBasedSearchResults(boolean pSession)
Set to true to save search Results object in SearchContext object, false otherwise. |
void |
setSessionConfigLanguage(java.lang.String pSessionConfigLanguage)
Set the language value used when creating the search session. |
void |
setSiteName(java.lang.String pSiteName)
Set the siteName to be used in the SessionConfig |
void |
setSuccessURL(java.lang.String pSuccessURL)
Set the optional url to redirect to on a successful search (a search which throws no exceptions) |
void |
setUserProfile(RepositoryItem pUserProfile)
Set the user user profile for the user executing the search |
Methods inherited from class atg.droplet.EmptyFormHandler |
---|
afterGet |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
protected static final java.lang.String DEFAULT_ANONYMOUS_USERNAME
protected static final java.lang.String DEFAULT_SITE_NAME
Constructor Detail |
---|
public BaseSearchFormHandler()
Method Detail |
---|
public void setSessionBasedSearchRequest(boolean pSession)
pSession
- true to save search request in the SearchContext,
false otherwiseSearchContext.getClientRequest()
public boolean getSessionBasedSearchRequest()
SearchContext.getClientRequest()
public void setSessionBasedSearchResults(boolean pSession)
pSession
- true to save Results in SearchContext, false
otherwise.SearchContext.getResults()
public boolean getSessionBasedSearchResults()
SearchContext.getResults()
public void setResultsFetcher(ResultsFetchingProxy pResultsFetcher)
pResultsFetcher
- the results fetcher proxyResultsFetchingProxy
,
CollectionFilterFetchingProxy
public ResultsFetchingProxy getResultsFetcher()
ResultsFetchingProxy
,
CollectionFilterFetchingProxy
public java.lang.String getOptionSetName()
SearchSession#getOptionSet(String optionSetName)
public void setOptionSetName(java.lang.String pOptionSetName)
the
- option set name or nullSearchSession#getOptionSet(String optionSetName)
public java.util.Map createOptionSet(java.lang.String pOptionSetName)
pOptionSetName
- the name of the option set
SearchSession#getOptionSet(String optionSetName)
public void setOptionSet(java.util.Map pOptionSet)
pOptionSet
- the option set for this search requestpublic java.util.Map getOptionSet()
public void setRequestLogging(boolean pLogging)
pLogging
- true or falseClientRequest#loggingEnabled(boolean loggingEnabled)
public boolean isRequestLogging()
ClientRequest#loggingEnabled(boolean loggingEnabled)
public void setDocumentSetsBuilder(XMLBuilder pDocumentSetsBuilder)
pDocumentSetsBuilder
- the <documentSets> constraints
builder or nullXMLBuilder
,
MapXMLBuilder
public XMLBuilder getDocumentSetsBuilder()
XMLBuilder
,
MapXMLBuilder
protected DocumentSetConstraint getDocumentSets()
getDocumentSetsBuilder()
,
XMLBuilder.buildXML(BaseSearchFormHandler pFormHandler,
ClientRequest pClientRequest, String pTagName)
public void setParserOptionsBuilder(XMLBuilder pParserOptionsBuilder)
pPar
- the <prefAnswerConstr> XMLBuilder or null to
use default MapXMLBuilderXMLBuilder
,
MapXMLBuilder
public XMLBuilder getParserOptionsBuilder()
XMLBuilder
,
MapXMLBuilder
protected ParserOptions getParserOptions()
getParserOptionsBuilder()
,
XMLBuilder.buildXML(BaseSearchFormHandler pFormHandler,
ClientRequest pClientRequest, String pTagName)
public ClientRequest getClientRequest()
public java.util.Map getRequestAttributes()
public void setRequestAttributes(java.util.Map pRequestAttributes)
pRequestAttributes
- the request attribute mapbuildClientRequest(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
public java.lang.String getRequestAttribute(java.lang.String pAttributeName)
pAttributeName
- the request attribute name
public java.lang.String setRequestAttribute(java.lang.String pKey, java.lang.String pValue)
pKey
- the attribute keypValue
- the attribute value or null to remove existing pKey
public java.lang.String[] getStringArrayRequestAttribute(java.lang.String pKey, java.lang.String pSeparator)
pKey
- the attribute keypSeparator
- the string that separates elements of the arraypublic void setClearQueryURL(java.lang.String pClearQueryURL)
pClearQueryURL
- the url or nullhandleClearQuery(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
public java.lang.String getClearQueryURL()
public void setErrorURL(java.lang.String pErrorURL)
pErrorURL
- the url or nullpublic java.lang.String getErrorURL()
public void setSuccessURL(java.lang.String pSuccessURL)
pSuccessURL
- the success url or nulpublic java.lang.String getSuccessURL()
public void setAutoRedirect(boolean pAutoRedirect)
pAutoRedirect
- boolean true to use redirect URL in search resultspublic boolean getAutoRedirect()
public java.lang.String getAnonymousUserName()
public void setAnonymousUserName(java.lang.String pAnonymousUserName)
pAnonymousUserName
- public void setSessionConfigLanguage(java.lang.String pSessionConfigLanguage)
pSessionConfigLanguage
- public java.lang.String getSessionConfigLanguage()
SessionConfig.setLanguage(String)
public void setSiteName(java.lang.String pSiteName)
pSiteName
- the site name or null to use defaultpublic java.lang.String getSiteName()
public void setSearchService(ESSearchService pSearchService)
pESSearchService
- the search servicepublic void setSearchContext(SearchContext pSearchContext)
pSearchContext
- the search contextpublic SearchContext getSearchContext()
public SearchSession getSearchSession()
public SearchSession createSearchSession(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
pRequest
- the Dynamo http requestpResponse
- the Dynamo http response
createSessionConfig(atg.servlet.DynamoHttpServletRequest, atg.servlet.DynamoHttpServletResponse)
public ESSearchService getSearchService()
public void setUserProfile(RepositoryItem pUserProfile)
pUserProfile
- the user profile repository item or nullpublic RepositoryItem getUserProfile()
protected void prepareClientRequest(DynamoHttpServletRequest pRequest)
pRequest
- DynamoHttpServletRequestprotected abstract ClientRequest createClientRequest(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
pRequest
- the dynamo requestpResponse
- the dynamo responseprotected abstract SearchMessage createSearchMessage(ClientRequest pClientRequest, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
pClientRequest
- the search server request objectpRequest
- the dynamo requestpResponse
- the dynamo response
public Results getResults()
protected void buildClientRequest(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
pRequest
- the dynamo requestpResponse
- the dynamo responsepublic boolean beforeSet(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws DropletFormException
beforeSet
in interface DropletFormHandler
beforeSet
in class GenericFormHandler
pRequest
- the dynamo requestpResponse
- the dynamo response
DropletFormException
buildClientRequest(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
public void beforeGet(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
beforeGet
in interface DropletFormHandler
beforeGet
in class EmptyFormHandler
pRequest
- the dynamo requestpResponse
- the dynamo responsebuildClientRequest(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
public boolean handleSearch(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
pRequest
- the dynamo requestpResponse
- the dynamo response
javax.servlet.ServletException
java.io.IOException
protected boolean handleAutoRedirect(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, Results pResults, boolean pResult) throws java.io.IOException
pResults
- Search Results object.pResult
- Whether to continue processing.
java.io.IOException
- for redirect problemsprotected void sendSearchMessage(ClientRequest pClientRequest, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
pClientRequest
- the Primus ClientRequest typepRequest
- the dynamo requestpResponse
- the dynamo responsecreateSearchMessage(ClientRequest pClientRequest,
DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
,
SearchMessageSource.fireSearchMessage(SearchMessage pSearchMessage)
protected boolean handleErrorCondition(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, java.lang.Exception pException) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
public boolean handleClearQuery(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo requestpResponse
- the dynamo response
javax.servlet.ServletException
java.io.IOException
setClearQueryURL(String pClearQueryURL)
protected java.lang.Integer getIntegerRequestAttribute(java.lang.String pAttributeName)
pAttributeName
- the name of the attribute
protected java.lang.String encodeMapData(java.util.Map pMap, java.lang.String pPrefix, java.lang.String pSeparator, java.lang.String pSuffix, java.lang.String pDelimiter)
pMap
- the map to translate into an encoded stringpPrefix
- a value to insert before each key, or null if not
usedpSeparator
- the value used to separate key and value, or
null if not usedpSuffix
- a value to insert after each value, including the
last. Null if not usedpDelimiter
- the value used to delimit key/value pairs in
the string. Null if not used.
protected java.lang.String encodeArrayData(java.lang.String[] pArray, java.lang.String pPrefix, java.lang.String pSuffix, java.lang.String pDelimiter)
pCollection
- the Collection to translate into an encoded stringpPrefix
- a value to insert before each value, or null if not
usedpSuffix
- a value to insert after each value, including the
last. Null if not usedpDelimiter
- the value used to delimit values in
the string. Null if not used.
protected java.lang.String encodeCollectionData(java.util.Collection pCollection, java.lang.String pPrefix, java.lang.String pSuffix, java.lang.String pDelimiter)
pCollection
- the Collection to translate into an encoded stringpPrefix
- a value to insert before each value, or null if not
usedpSuffix
- a value to insert after each value, including the
last. Null if not usedpDelimiter
- the value used to delimit values in
the string. Null if not used.
public java.util.Map decodeMapData(java.lang.String pData, java.lang.String pPairRegex, KeyValueSplitter pSpliter)
pData
- the encoded key/value pairspPairRegex
- the regular expression to identify key/value
pairs. For example, a "," would identify comma-delimited key/value pairs.pSpliter
- a class that splits a single encoded key/value
pair into component values.protected int getIntRequestAttribute(java.lang.String pAttributeName, int pDefault)
pAttributeName
- the attribute namepDefault
- the default value to use if the attribute has not been set
protected void setBooleanRequestAttribute(java.lang.String pAttributeName, java.lang.Boolean pAttributeValue)
pAttributeName
- the name of the request attributepAttributeValue
- the attribute value or null to remove the
attributeprotected java.lang.Boolean getBooleanRequestAttribute(java.lang.String pAttributeName)
pAttributeName
- the name of the attribute
protected boolean getBoolRequestAttribute(java.lang.String pAttributeName, boolean pDefault)
pAttributeName
- the attribute namepDefault
- the default value to use if the attribute has not been set
protected void setClientRequest(ClientRequest pClientRequest)
pClientRequest
- the client requested objectprotected void setResults(Results pResults)
pResults
- the results object or nullprotected SessionConfig createSessionConfig(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
pRequest
- the Dynamo requestpSessionConfig
- the search session configurationpRequest
- the Dynamo http request object
protected java.lang.StringBuffer buildSimpleTag(java.lang.String pTagName, java.lang.String pTagValue, java.util.Map pAttributes)
pTagName
- <pTagName>pTagValue
- <>tagvalue</>pAttributes
- an optionally empty or null map of tag attributesprotected void dumpRequestInfo(ClientRequest pRequest)
pRequest
- the requestprotected void dumpMap(java.lang.String pMapPropertyName, java.util.Map pMap)
pMapPropertyName
- the property name for informationpMap
- the map to dumpprotected SearchMessageSource getSearchMessageSource()
protected java.util.Map getSiteDefaultOptionSet(ClientRequest pRequest, SearchSession pSession)
protected java.util.Map mergeMaps(java.util.Map pBase, java.util.Map pOverrides)
pBase
- the base attribute map (typically the site defaults)pOverrides
- the overriding attributes, typically set on the
page.
protected ClientRequest beforeSearch(ClientRequest pRequest, SearchContext pContext, SearchSession pSession)
pRequest
- the client query requestpContext
- the search context, which holds session scoped
information for the current search userpSession
- the search session
protected Results afterSearch(ClientRequest pRequest, SearchContext pContext, SearchSession pSession, Results pResults)
pRequest
- the client query requestpContext
- the search context, which holds session scoped
information for the current search userpSession
- the search sessionpResults
- the search results
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |