atg.search.routing.command.search

Class ViewDocumentRequest.Response

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.SearchEngineCommandResponse

atg.search.routing.command.search.SearchResponse

atg.search.routing.command.search.ViewDocumentRequest.Response

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

ViewDocumentRequest

public static class ViewDocumentRequest.Response
extends SearchResponse

Response type for the ViewDocumentRequest

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.search.routing.command.search.SearchResponse

mMultiPartitionSearch

Constructor Summary

Constructors

Constructor and Description
Response(atg.search.routing.command.SearchEngineResponse response) Constructs a response from an engine's response
Response(ViewDocumentRequest pRequest, java.util.List<SearchResponse> pParsedResponses) This Java Merge instead of the engine's merge.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDocContextId() Returns Document identifier plus highlight regions
ViewedDocument	getDocument() Returns the Document of the result
java.lang.String	getDocumentText() Returns the document's text if this was a normal View request, otherwise null
java.lang.String	getHighlightInfo() Returns highlight information
java.lang.String	getInput() Returns original user input
ItemInspect	getItemInspect() Returns item inspection
ParserOptions	getParserOptions() Returns text processing options
ViewDocumentRequest.Return	getReturn() Returns the return type
java.lang.String	getURL() Returns the URL of document
protected void	merge(SearchRequest pRequest, java.util.List<SearchResponse> pParsedResponses) This is Java merge.
void	setDocContextId(java.lang.String docContextId) Sets Document identifier plus highlight regions
void	setDocument(ViewedDocument document) Sets Document of the result
void	setDocumentText(java.lang.String documentText) Sets the document's text
void	setHighlightInfo(java.lang.String highlightInfo) Sets highlight information
void	setInput(java.lang.String input) Sets original user input
void	setItemInspect(ItemInspect pItem) Sets item inspection
void	setParserOptions(ParserOptions parserOptions) Sets text processing options
void	setReturn(ViewDocumentRequest.Return aReturn) Sets the return type
void	setURL(java.lang.String URL) Sets URL of document

Methods inherited from class atg.search.routing.command.search.SearchResponse

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

Methods inherited from class atg.search.routing.command.SearchEngineCommandResponse

getNextResponse, getNonSAXParser, getRequestTag, getSearchEngineResponse, parseResponse, setNextResponse, setSearchEngineResponse

Methods inherited from class atg.search.routing.command.SearchXMLObject

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getAttributeXML, getBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toXML, toXML

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

Response

public Response(ViewDocumentRequest pRequest,
                java.util.List<SearchResponse> pParsedResponses)
         throws atg.search.routing.MergeException

This Java Merge instead of the engine's merge. Invocation of this constructor results in a single merged Response. See #merge(atg.search.routing.command.search.ViewDocumentRequest,SearchResponse[]).

Parameters:

pRequest - original request

pParsedResponses - parsed responses

Throws:

atg.search.routing.MergeException

Response

public Response(atg.search.routing.command.SearchEngineResponse response)

Constructs a response from an engine's response

Parameters:

response - an engine's response

Method Detail

merge

protected void merge(SearchRequest pRequest,
                     java.util.List<SearchResponse> pParsedResponses)
              throws atg.search.routing.MergeException

This is Java merge.

Specified by:

merge in class SearchResponse

Parameters:

pRequest - the original request

pParsedResponses - pre-parsed responses

Throws:

atg.search.routing.MergeException - if the merge fails

getDocumentText

public java.lang.String getDocumentText()

Returns the document's text if this was a normal View request, otherwise null

Returns:

the document's text if this was a normal View request, otherwise null

setDocumentText

public void setDocumentText(java.lang.String documentText)

Sets the document's text

Parameters:

documentText - the document's text

getInput

public java.lang.String getInput()

Returns original user input

Returns:

original user input

setInput

public void setInput(java.lang.String input)

Sets original user input

Parameters:

input - original user input

getReturn

public ViewDocumentRequest.Return getReturn()

Returns the return type

Returns:

return type

setReturn

public void setReturn(ViewDocumentRequest.Return aReturn)

Sets the return type

Parameters:

aReturn - the return type

getURL

public java.lang.String getURL()

Returns the URL of document

Returns:

URL of document

setURL

public void setURL(java.lang.String URL)

Sets URL of document

Parameters:

URL - URL of document

getHighlightInfo

public java.lang.String getHighlightInfo()

Returns highlight information

Returns:

highlight information

setHighlightInfo

public void setHighlightInfo(java.lang.String highlightInfo)

Sets highlight information

Parameters:

highlightInfo - highlight information

getDocContextId

public java.lang.String getDocContextId()

Returns Document identifier plus highlight regions

Returns:

Document identifier plus highlight regions

setDocContextId

public void setDocContextId(java.lang.String docContextId)

Sets Document identifier plus highlight regions

Parameters:

docContextId - Document identifier plus highlight regions

getDocument

public ViewedDocument getDocument()

Returns the Document of the result

Returns:

Document of the result

setDocument

public void setDocument(ViewedDocument document)

Sets Document of the result

Parameters:

document - the Document of the result

getItemInspect

public ItemInspect getItemInspect()

Returns item inspection

Returns:

item inspection

setItemInspect

public void setItemInspect(ItemInspect pItem)

Sets item inspection

Parameters:

pItem - item inspection

getParserOptions

public ParserOptions getParserOptions()

Returns text processing options

Returns:

text processing options

setParserOptions

public void setParserOptions(ParserOptions parserOptions)

Sets text processing options

Parameters:

parserOptions - text processing options