|
|||||||||
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 atg.search.query.formhandlers.QueryFormHandler
public class QueryFormHandler
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
|
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()
|
Method Summary | |
---|---|
protected ClientRequest |
createClientRequest(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Creates and initializes the ClientRequest for this form handler, which is of type ClientQueryRequest. |
protected SearchMessage |
createSearchMessage(ClientRequest pQueryRequest,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Create the JMS message to represent a ClientQueryRequest and associated response data. |
protected void |
dumpRequestInfo(ClientRequest pClientRequest)
Debugging method. |
protected ClientQueryRequest |
getClientQueryRequest()
Convenience method to get ClientRequest cast to actual type for this request. |
CustomLogicTree |
getCustomLogicTree()
Returns the custom logic tree xml string |
java.lang.String |
getDebugSearchConfigName()
|
java.lang.String[] |
getDocProps()
A set of values for the docProps attribute. |
FacetSearchResponse |
getFacetSearchResponse()
This will convert the Results object into a FacetSearchResponse object. |
FacetSearchService |
getFacetSearchService()
|
java.lang.String |
getPageMode()
|
protected DocumentSetConstraint |
getPrefAnswerConstr()
Get the <prefAnswerConstr> tag contents as a DocumeentSetConstraint. |
XMLBuilder |
getPrefAnswerConstrBuilder()
Get the XMLBuilder for the the <prefAnswerConstr> tag. |
java.lang.String |
getPriorInput(int pIndex)
Get the prior input value at the specified index. |
java.util.List |
getPriorInputList()
Get a list of prior input values. |
java.lang.String |
getQuestion()
Get the value of the <query><question> tag |
atg.nucleus.ResolvingMap |
getRelQuestSettings()
A map of values for the relQuestSettings attribute. |
java.util.Map |
getResponseNumberSettings()
A map of values for the responseNumberSettings attribute |
java.lang.String |
getSearchConfigAttributeName()
Get search config attribute name. |
java.lang.String |
getSearchConfigName(DynamoHttpServletRequest pRequest)
Get the search config name from service. |
SearchConfigNameService |
getSearchConfigNameService()
Get nucleus service that return search config name. |
protected DocumentSetConstraint |
getWeightedProps()
Get the builder for the <weightedProps> constraints tag. |
XMLBuilder |
getWeightedPropsXMLBuilder()
Get the optional builder for the <weightedProps> constraints tag. |
boolean |
isEnableReportData()
|
protected void |
prepareClientRequest(DynamoHttpServletRequest pRequest)
This method is overridden to translate the relQuestSettings and responseNumberSettings map values into the encoded values used in the XML request. |
void |
setCustomLogicTree(CustomLogicTree pCustomLogicTree)
Sets custom logic tree xml string |
void |
setDebugSearchConfigName(java.lang.String pDebugSearchConfigName)
|
void |
setDocProps(java.lang.String[] pDocProps)
Set a set of values for the docProps attribute. |
void |
setEnableReportData(boolean pEnableReportData)
|
void |
setFacetSearchService(FacetSearchService pFacetSearchService)
The FacetSearchService that can be used to convert the search results into a FacetSearchResponse object. |
void |
setPageMode(java.lang.String pPageMode)
The PageMode that will be passed to FacetSearchService.convertResults when converting the Results to a FacetSearchResponse |
void |
setPrefAnswerConstrBuilder(XMLBuilder pPrefAnswerConstrBuilder)
Set an XMLBuilder for the the <prefAnswerConstr> tag. |
void |
setPriorInput(int pIndex,
java.lang.String pValue)
Set the prior input String at the specified index. |
void |
setQuestion(java.lang.String pQueryText)
Set the value of the <query><question> tag |
void |
setRelQuestSettings(atg.nucleus.ResolvingMap pRelQuestSettings)
Set the relQuestSettings map. |
void |
setResponseNumberSettings(java.util.Map pResponseNumberSettings)
Set a map of values for responseNumberSettings |
void |
setSearchConfigAttributeName(java.lang.String pSearchConfigAttributeName)
Set search config attribute name. |
void |
setSearchConfigNameService(SearchConfigNameService pSearchConfigNameService)
Set nucleus service. |
void |
setWeightedPropsXMLBuilder(XMLBuilder pWeightedPropsBuilder)
Set an optional constraints builder object for the <weightedProps> tag. |
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
Constructor Detail |
---|
public QueryFormHandler()
Method Detail |
---|
public java.lang.String getDebugSearchConfigName()
public void setDebugSearchConfigName(java.lang.String pDebugSearchConfigName)
public boolean isEnableReportData()
public void setEnableReportData(boolean pEnableReportData)
public void setFacetSearchService(FacetSearchService pFacetSearchService)
public FacetSearchService getFacetSearchService()
public void setPageMode(java.lang.String pPageMode)
public java.lang.String getPageMode()
public CustomLogicTree getCustomLogicTree()
public void setCustomLogicTree(CustomLogicTree pCustomLogicTree)
pLogicTree
- custom logic tree xml stringpublic FacetSearchResponse getFacetSearchResponse()
public atg.nucleus.ResolvingMap getRelQuestSettings()
public void setRelQuestSettings(atg.nucleus.ResolvingMap pRelQuestSettings)
pRelQuestSettings
- the relQuestSettings in map formpublic java.util.Map getResponseNumberSettings()
public void setResponseNumberSettings(java.util.Map pResponseNumberSettings)
pResponseNumberSettings
- the map of valuespublic java.lang.String[] getDocProps()
docProps
attribute controls the
meta properties that are returned with each results.
public void setDocProps(java.lang.String[] pDocProps)
docProps
attribute controls the
meta properties that are returned with each results.
pDocProps
- The set of valuespublic void setQuestion(java.lang.String pQueryText)
pQueryText
- the search textpublic java.lang.String getQuestion()
public void setWeightedPropsXMLBuilder(XMLBuilder pWeightedPropsBuilder)
pWeightedPropsBuilder
- the <weightedProps> constraints
builder or nullgetWeightedProps()
,
XMLBuilder
,
MapXMLBuilder
public XMLBuilder getWeightedPropsXMLBuilder()
getWeightedProps()
,
XMLBuilder
,
MapXMLBuilder
protected DocumentSetConstraint getWeightedProps()
getWeightedProps()
,
XMLBuilder
,
MapXMLBuilder
public void setPrefAnswerConstrBuilder(XMLBuilder pPrefAnswerConstrBuilder)
pPrefAnswerConstrBuilder
- the <prefAnswerConstr>
constraints builder or null to use default MapXMLBuilderXMLBuilder
,
MapXMLBuilder
public XMLBuilder getPrefAnswerConstrBuilder()
XMLBuilder
,
MapXMLBuilder
protected DocumentSetConstraint getPrefAnswerConstr()
getPrefAnswerConstrBuilder()
,
setPrefAnswerConstrBuilder(XMLBuilder)
public void setPriorInput(int pIndex, java.lang.String pValue)
pIndex
- the indexpValue
- the valuegetPriorInputList()
public java.lang.String getPriorInput(int pIndex)
pIndex
- the index
getPriorInputList()
public java.util.List getPriorInputList()
getPriorInput(int)
,
prepareClientRequest(atg.servlet.DynamoHttpServletRequest)
public SearchConfigNameService getSearchConfigNameService()
public void setSearchConfigNameService(SearchConfigNameService pSearchConfigNameService)
pSearchConfigNameService
- new instance of SearchConfigNameService.public java.lang.String getSearchConfigAttributeName()
public void setSearchConfigAttributeName(java.lang.String pSearchConfigAttributeName)
pSearchConfigAttributeName
- Stringprotected ClientRequest createClientRequest(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
createClientRequest
in class BaseSearchFormHandler
pRequest
- the dynamo requestpResponse
- the dynamo response
protected SearchMessage createSearchMessage(ClientRequest pQueryRequest, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
createSearchMessage
in class BaseSearchFormHandler
pQueryRequest
- the client request objectpRequest
- the Dynamo http requestpResponse
- the Dynamo http response
protected void dumpRequestInfo(ClientRequest pClientRequest)
dumpRequestInfo
in class BaseSearchFormHandler
pClientRequest
- the ClientQueryRequest objectprotected ClientQueryRequest getClientQueryRequest()
protected void prepareClientRequest(DynamoHttpServletRequest pRequest)
prepareClientRequest
in class BaseSearchFormHandler
pRequest
- DynamoHttpServletRequestpublic java.lang.String getSearchConfigName(DynamoHttpServletRequest pRequest)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |