public static class TypeAheadRequest.Response extends SearchResponse
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
mMultiPartitionSearch
Constructor and Description |
---|
Response(atg.search.routing.command.SearchEngineResponse response)
Constructor for a new response.
|
Response(SearchRequest pRequest,
java.util.List<SearchResponse> pParsedResponses) |
Modifier and Type | Method and Description |
---|---|
protected void |
getAttributeXML(java.lang.StringBuilder sb) |
protected void |
getBodyXML(java.lang.StringBuilder sb) |
java.util.List<java.lang.String> |
getClasses()
Type Ahead data may also include optional String class values.
|
java.util.List<java.lang.String> |
getIds()
Type Ahead data consists of matchable strings and optional String id values.
|
java.lang.String |
getMatch()
Get the string that the engine matched on in processing the Request.
|
java.lang.String |
getRequestTag() |
java.util.List<java.lang.String> |
getStrings()
Get the list of matching strings found by the engine when processing the request
|
java.util.List<java.lang.Integer> |
getValues()
Type Ahead data consists of matchable strings and associated integer values.
|
protected void |
merge(SearchRequest pRequest,
java.util.List<SearchResponse> pParsedResponses)
This is local merge.
|
addError, getBuildTimeMs, getContentId, getErrors, getListableProperties, getMergeTimeMs, getParseTimeMs, getPartitionResponses, getRequestChainToken, getRequestIdentifier, getRequestTime, getSearchTargetNames, getTotalResponseTimeMs, getXmlString, handleMerge, isAllowListProperties, isLocalMergeEnabled, isMultiPartitionSearch, isOverloaded, isTimedOut, setAllowListProperties, setBuildTimeMs, setErrors, setListableProperties, setLocalMergeEnabled, setMergeTimeMs, setMultiPartitionSearch, setParseTimeMs, setPartitionResponses, setRequestChainToken, setRequestIdentifier, setRequestTime, setSearchTargetNames, setTotalResponseTimeMs, toString
getNextResponse, getNonSAXParser, getSearchEngineResponse, parseResponse, setNextResponse, setSearchEngineResponse
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toXML, toXML
public static final java.lang.String CLASS_VERSION
public Response(atg.search.routing.command.SearchEngineResponse response)
response
- the SearchEngineResponse object from the associated request.public Response(SearchRequest pRequest, java.util.List<SearchResponse> pParsedResponses) throws atg.search.routing.MergeException
atg.search.routing.MergeException
public java.lang.String getMatch()
public java.util.List<java.lang.String> getStrings()
public java.util.List<java.lang.Integer> getValues()
public java.util.List<java.lang.String> getIds()
public java.util.List<java.lang.String> getClasses()
protected void merge(SearchRequest pRequest, java.util.List<SearchResponse> pParsedResponses) throws atg.search.routing.MergeException
SearchResponse
SearchEngineResponse
or provide any timing.
The Response class must provide a constructor that looks like the one below and invokes
SearchResponse.handleMerge(atg.search.routing.command.search.SearchRequest,java.util.List)
.
The implementation of this method should only handle merge. See QueryRequest.Response.merge(SearchRequest, java.util.List)
public Response(YourRequest pRequest,
List<SearchResponse> pParsedResponses) throws MergeException
{
handleMerge(pRequest, pParsedResponses);
}
merge
in class SearchResponse
pRequest
- the original requestpParsedResponses
- pre-parsed responsesatg.search.routing.MergeException
- if the merge failspublic java.lang.String getRequestTag()
getRequestTag
in class atg.search.routing.command.SearchEngineCommandResponse
protected void getAttributeXML(java.lang.StringBuilder sb) throws atg.search.routing.command.IncompleteCommandException
getAttributeXML
in class atg.search.routing.command.SearchXMLObject
atg.search.routing.command.IncompleteCommandException
protected void getBodyXML(java.lang.StringBuilder sb) throws atg.search.routing.command.IncompleteCommandException
getBodyXML
in class atg.search.routing.command.SearchXMLObject
atg.search.routing.command.IncompleteCommandException