atg.search.query.formhandlers
Class QueryFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.search.query.formhandlers.BaseSearchFormHandler
                      atg.search.query.formhandlers.QueryFormHandler

All Implemented Interfaces:

DropletFormHandler, NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

Deprecated. as of 9.0. Use QueryFormHandler instead.

public class QueryFormHandler
extends BaseSearchFormHandler

This form handler issues requests using the <search> tag This component provides properties for setting some common attributes of the <search> tag.

Field Summary

static java.lang.String

CLASS_VERSION Deprecated.

Fields inherited from class atg.search.query.formhandlers.BaseSearchFormHandler

DEFAULT_ANONYMOUS_USERNAME, 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

QueryFormHandler()
Deprecated.

Method Summary

protected ClientRequest	createClientRequest(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Deprecated. Creates and initializes the ClientRequest for this form handler, which is of type ClientQueryRequest.
protected SearchMessage	createSearchMessage(ClientRequest pQueryRequest, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Deprecated. Create the JMS message to represent a ClientQueryRequest and associated response data.
protected void	dumpRequestInfo(ClientRequest pClientRequest) Deprecated. Debugging method.
protected ClientQueryRequest	getClientQueryRequest() Deprecated. Convenience method to get ClientRequest cast to actual type for this request.
java.lang.String	getDebugSearchConfigName() Deprecated.
java.lang.String[]	getDocProps() Deprecated. A set of values for the docProps attribute.
FacetSearchResponse	getFacetSearchResponse() Deprecated. This will convert the Results object into a FacetSearchResponse object.
atg.repository.search.refinement.FacetSearchService	getFacetSearchService() Deprecated.
java.lang.String	getPageMode() Deprecated.
protected DocumentSetConstraint	getPrefAnswerConstr() Deprecated. Get the <prefAnswerConstr> tag contents as a DocumeentSetConstraint.
XMLBuilder	getPrefAnswerConstrBuilder() Deprecated. Get the XMLBuilder for the the <prefAnswerConstr> tag.
java.lang.String	getPriorInput(int pIndex) Deprecated. Get the prior input value at the specified index.
java.util.List	getPriorInputList() Deprecated. Get a list of prior input values.
java.lang.String	getQuestion() Deprecated. Get the value of the <query><question> tag
atg.nucleus.ResolvingMap	getRelQuestSettings() Deprecated. A map of values for the relQuestSettings attribute.
java.util.Map	getResponseNumberSettings() Deprecated. A map of values for the responseNumberSettings attribute
java.lang.String	getSearchConfigAttributeName() Deprecated. Get search config attribute name.
java.lang.String	getSearchConfigName(DynamoHttpServletRequest pRequest) Deprecated. Get the search config name from service.
SearchConfigNameService	getSearchConfigNameService() Deprecated. Get nucleus service that return search config name.
protected DocumentSetConstraint	getWeightedProps() Deprecated. Get the builder for the <weightedProps> constraints tag.
XMLBuilder	getWeightedPropsXMLBuilder() Deprecated. Get the optional builder for the <weightedProps> constraints tag.
boolean	isEnableReportData() Deprecated.
protected void	prepareClientRequest(DynamoHttpServletRequest pRequest) Deprecated. This method is overridden to translate the relQuestSettings and responseNumberSettings map values into the encoded values used in the XML request.
void	setDebugSearchConfigName(java.lang.String pDebugSearchConfigName) Deprecated.
void	setDocProps(java.lang.String[] pDocProps) Deprecated. Set a set of values for the docProps attribute.
void	setEnableReportData(boolean pEnableReportData) Deprecated.
void	setFacetSearchService(atg.repository.search.refinement.FacetSearchService pFacetSearchService) Deprecated. The FacetSearchService that can be used to convert the search results into a FacetSearchResponse object.
void	setPageMode(java.lang.String pPageMode) Deprecated. The PageMode that will be passed to FacetSearchService.convertResults when converting the Results to a FacetSearchResponse
void	setPrefAnswerConstrBuilder(XMLBuilder pPrefAnswerConstrBuilder) Deprecated. Set an XMLBuilder for the the <prefAnswerConstr> tag.
void	setPriorInput(int pIndex, java.lang.String pValue) Deprecated. Set the prior input String at the specified index.
void	setQuestion(java.lang.String pQueryText) Deprecated. Set the value of the <query><question> tag
void	setRelQuestSettings(atg.nucleus.ResolvingMap pRelQuestSettings) Deprecated. Set the relQuestSettings map.
void	setResponseNumberSettings(java.util.Map pResponseNumberSettings) Deprecated. Set a map of values for responseNumberSettings
void	setSearchConfigAttributeName(java.lang.String pSearchConfigAttributeName) Deprecated. Set search config attribute name.
void	setSearchConfigNameService(SearchConfigNameService pSearchConfigNameService) Deprecated. Set nucleus service.
void	setWeightedPropsXMLBuilder(XMLBuilder pWeightedPropsBuilder) Deprecated. Set an optional constraints builder object for the <weightedProps> tag.

Methods inherited from class atg.search.query.formhandlers.BaseSearchFormHandler

afterSearch, beforeGet, beforeSearch, beforeSet, buildClientRequest, buildSimpleTag, createOptionSet, createOptionSet, createSearchSession, createSessionConfig, decodeMapData, dumpMap, encodeArrayData, encodeCollectionData, encodeMapData, getAnonymousUserName, getAutoRedirect, getBooleanRequestAttribute, getBoolRequestAttribute, getClearQueryURL, getClientRequest, getDocumentSets, getDocumentSetsBuilder, getErrorURL, getIntegerRequestAttribute, getIntRequestAttribute, getOptionSet, getOptionSetName, getParserOptions, getParserOptionsBuilder, getRequestAttribute, getRequestAttributes, getResults, getResultsFetcher, getSearchContext, getSearchMessageSource, getSearchService, getSearchSession, getSessionBasedSearchRequest, getSessionBasedSearchResults, getSessionConfigLanguage, getSiteDefaultOptionSet, getSiteName, getStringArrayRequestAttribute, getSuccessURL, getUserProfile, handleAutoRedirect, handleClearQuery, handleErrorCondition, handleSearch, isRequestLogging, mergeMaps, sendSearchMessage, setAnonymousUserName, setAutoRedirect, setBooleanRequestAttribute, setClearQueryURL, setClientRequest, setDocumentSetsBuilder, setErrorURL, setOptionSet, setOptionSetName, setParserOptionsBuilder, setRequestAttribute, setRequestAttributes, setRequestLogging, setResults, setResultsFetcher, setSearchContext, setSearchService, setSessionBasedSearchRequest, setSessionBasedSearchResults, setSessionConfigLanguage, setSiteName, setSuccessURL, setUserProfile

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, addUncheckedFormException, afterSet, checkFormRedirect, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleCancel, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

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

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Deprecated.

Constructor Detail

QueryFormHandler

public QueryFormHandler()

Deprecated.

Method Detail

getDebugSearchConfigName

public java.lang.String getDebugSearchConfigName()

Deprecated.

setDebugSearchConfigName

public void setDebugSearchConfigName(java.lang.String pDebugSearchConfigName)

Deprecated.

isEnableReportData

public boolean isEnableReportData()

Deprecated.

setEnableReportData

public void setEnableReportData(boolean pEnableReportData)

Deprecated.

setFacetSearchService

public void setFacetSearchService(atg.repository.search.refinement.FacetSearchService pFacetSearchService)

Deprecated.

The FacetSearchService that can be used to convert the search results into a FacetSearchResponse object.

getFacetSearchService

public atg.repository.search.refinement.FacetSearchService getFacetSearchService()

Deprecated.

setPageMode

public void setPageMode(java.lang.String pPageMode)

Deprecated.

The PageMode that will be passed to FacetSearchService.convertResults when converting the Results to a FacetSearchResponse

getPageMode

public java.lang.String getPageMode()

Deprecated.

getFacetSearchResponse

public FacetSearchResponse getFacetSearchResponse()

Deprecated.

This will convert the Results object into a FacetSearchResponse object. Having this here allows JSP coders to use the same page code to render facets regardless of whether the search is performed through this form handler or the FacetSearchDroplet

getRelQuestSettings

public atg.nucleus.ResolvingMap getRelQuestSettings()

Deprecated.

A map of values for the relQuestSettings attribute. The map is of type ResolvingMap, which allows values that refer to nuclues component properties.

Returns:

the map of values for this attribute

setRelQuestSettings

public void setRelQuestSettings(atg.nucleus.ResolvingMap pRelQuestSettings)

Deprecated.

Set the relQuestSettings map. The map is of type ResolvingMap, which allows values that refer to nuclues component properties.

Parameters:

pRelQuestSettings - the relQuestSettings in map form

getResponseNumberSettings

public java.util.Map getResponseNumberSettings()

Deprecated.

A map of values for the responseNumberSettings attribute

Returns:

the map of values for this attribute

setResponseNumberSettings

public void setResponseNumberSettings(java.util.Map pResponseNumberSettings)

Deprecated.

Set a map of values for responseNumberSettings

Parameters:

pResponseNumberSettings - the map of values

getDocProps

public java.lang.String[] getDocProps()

Deprecated.

A set of values for the docProps attribute. The docProps attribute controls the meta properties that are returned with each results.

Returns:

the map of values for this attribute

setDocProps

public void setDocProps(java.lang.String[] pDocProps)

Deprecated.

Set a set of values for the docProps attribute. The docProps attribute controls the meta properties that are returned with each results.

Parameters:

pDocProps - The set of values

setQuestion

public void setQuestion(java.lang.String pQueryText)

Deprecated.

Set the value of the <query><question> tag

Parameters:

pQueryText - the search text

getQuestion

public java.lang.String getQuestion()

Deprecated.

Get the value of the <query><question> tag

Returns:

the search text or null

setWeightedPropsXMLBuilder

public void setWeightedPropsXMLBuilder(XMLBuilder pWeightedPropsBuilder)

Deprecated.

Set an optional constraints builder object for the <weightedProps> tag.

Parameters:

pWeightedPropsBuilder - the <weightedProps> constraints builder or null

See Also:

getWeightedProps(), XMLBuilder, MapXMLBuilder

getWeightedPropsXMLBuilder

public XMLBuilder getWeightedPropsXMLBuilder()

Deprecated.

Get the optional builder for the <weightedProps> constraints tag.

Returns:

the <weightedProps> constraints builder or null

See Also:

getWeightedProps(), XMLBuilder, MapXMLBuilder

getWeightedProps

protected DocumentSetConstraint getWeightedProps()

Deprecated.

Get the builder for the <weightedProps> constraints tag. By default, this method returns a MapXMLBuilder.

Returns:

the weightedProps tag's contents or null

See Also:

getWeightedProps(), XMLBuilder, MapXMLBuilder

setPrefAnswerConstrBuilder

public void setPrefAnswerConstrBuilder(XMLBuilder pPrefAnswerConstrBuilder)

Deprecated.

Set an XMLBuilder for the the <prefAnswerConstr> tag.

Parameters:

pPrefAnswerConstrBuilder - the <prefAnswerConstr> constraints builder or null to use default MapXMLBuilder

See Also:

XMLBuilder, MapXMLBuilder

getPrefAnswerConstrBuilder

public XMLBuilder getPrefAnswerConstrBuilder()

Deprecated.

Get the XMLBuilder for the the <prefAnswerConstr> tag. By default, this method returns a MapXMLBuilder.

Returns:

the <prefAnswerConstr> constraints builder or null

See Also:

XMLBuilder, MapXMLBuilder

getPrefAnswerConstr

protected DocumentSetConstraint getPrefAnswerConstr()

Deprecated.

Get the <prefAnswerConstr> tag contents as a DocumeentSetConstraint. Uses the object returned from prefAnswerConstrBuilder() to construct this object.

Returns:

the prefAnswerConstr tag's XML content object

See Also:

getPrefAnswerConstrBuilder(), setPrefAnswerConstrBuilder(XMLBuilder)

setPriorInput

public void setPriorInput(int pIndex,
                          java.lang.String pValue)

Deprecated.

Set the prior input String at the specified index.

Parameters:

pIndex - the index

pValue - the value

See Also:

getPriorInputList()

getPriorInput

public java.lang.String getPriorInput(int pIndex)

Deprecated.

Get the prior input value at the specified index.

Parameters:

pIndex - the index

Returns:

the prior input value at the specified index

See Also:

getPriorInputList()

getPriorInputList

public java.util.List getPriorInputList()

Deprecated.

Get a list of prior input values. The return value is trimmed of any null or empty elements. This is used in prepareClientRequest(), but may also be useful on the page.

Returns:

a list of prior input values or null if no prior input values

See Also:

getPriorInput(int), prepareClientRequest(atg.servlet.DynamoHttpServletRequest)

getSearchConfigNameService

public SearchConfigNameService getSearchConfigNameService()

Deprecated.

Get nucleus service that return search config name.

Returns:

SearchConfigNameService - current instance of the nucleus service.

setSearchConfigNameService

public void setSearchConfigNameService(SearchConfigNameService pSearchConfigNameService)

Deprecated.

Set nucleus service.

Parameters:

pSearchConfigNameService - new instance of SearchConfigNameService.

getSearchConfigAttributeName

public java.lang.String getSearchConfigAttributeName()

Deprecated.

Get search config attribute name.

Returns:

String - search config attribute name.

setSearchConfigAttributeName

public void setSearchConfigAttributeName(java.lang.String pSearchConfigAttributeName)

Deprecated.

Set search config attribute name.

Parameters:

pSearchConfigAttributeName - String

createClientRequest

protected ClientRequest createClientRequest(DynamoHttpServletRequest pRequest,
                                            DynamoHttpServletResponse pResponse)

Deprecated.

Creates and initializes the ClientRequest for this form handler, which is of type ClientQueryRequest.

Specified by:

createClientRequest in class BaseSearchFormHandler

Parameters:

pRequest - the dynamo request

pResponse - the dynamo response

Returns:

the new ClientQueryRequest

createSearchMessage

protected SearchMessage createSearchMessage(ClientRequest pQueryRequest,
                                            DynamoHttpServletRequest pRequest,
                                            DynamoHttpServletResponse pResponse)

Deprecated.

Create the JMS message to represent a ClientQueryRequest and associated response data.

Specified by:

createSearchMessage in class BaseSearchFormHandler

Parameters:

pQueryRequest - the client request object

pRequest - the Dynamo http request

pResponse - the Dynamo http response

Returns:

the JMS message to be sent

dumpRequestInfo

protected void dumpRequestInfo(ClientRequest pClientRequest)

Deprecated.

Debugging method. This method calls dumpRequestInfo() in parent class, then prints ClientQueryRequest specific information.

Overrides:

dumpRequestInfo in class BaseSearchFormHandler

Parameters:

pClientRequest - the ClientQueryRequest object

getClientQueryRequest

protected ClientQueryRequest getClientQueryRequest()

Deprecated.

Convenience method to get ClientRequest cast to actual type for this request.

Returns:

the query request

prepareClientRequest

protected void prepareClientRequest(DynamoHttpServletRequest pRequest)

Deprecated.

This method is overridden to translate the relQuestSettings and responseNumberSettings map values into the encoded values used in the XML request.

Calls prepareClientRequest() in parent class, then sets request specific data on the current request, obtained via getClientQueryRequest(). This method sets <relQuestSettings>, <responseNumberSettings>, <priorInput>, <prefAnswerConstr> and <weightedProps> tags.

Overrides:

prepareClientRequest in class BaseSearchFormHandler

Parameters:

pRequest - DynamoHttpServletRequest

getSearchConfigName

public java.lang.String getSearchConfigName(DynamoHttpServletRequest pRequest)

Deprecated.

Get the search config name from service.

Returns:

String - search config name