atg.search.routing.command.search
Class CategorizeRequest.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.CategorizeRequest.Response

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

CategorizeRequest

public static class CategorizeRequest.Response
extends SearchResponse

Response type for CategorizeRequest

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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

mMultiPartitionSearch

Constructor Summary

CategorizeRequest.Response()

CategorizeRequest.Response(CategorizeRequest pRequest, java.util.List<SearchResponse> pParsedResponses)
This Java Merge instead of the engine's merge.

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

Method Summary

void	addCategorization(Categorization categorization) Adds a categorization to the result list
boolean	equals(java.lang.Object pObj)
protected void	getAttributeXML(java.lang.StringBuilder buf)
protected void	getBodyXML(java.lang.StringBuilder sb)
java.util.List<Categorization>	getCategorizations() Returns the list of Categorizations
java.lang.String	getContentId() Returns content ID of partition that produced the response.
DocumentSetConstraint	getDocumentSets() Returns the input document set constraints
java.lang.String	getInput() Returns the input
java.lang.String	getMode() Returns the input mode
ParserOptions	getParserOptions() Returns the input parser options
DocumentSetConstraint	getRefineConstraints() Returns the echoed refine constraints
int	hashCode()
protected void	merge(SearchRequest pSearchRequest, java.util.List<SearchResponse> pParsedResponses) This is Java merge.
void	setCategorizations(java.util.List<Categorization> categorizations) Sets the list of Categorizations
void	setContentId(java.lang.String pContentId) Sets content ID of partition that produced the response.
void	setDocumentSets(DocumentSetConstraint documentSets) Sets the input document set constraints
void	setInput(java.lang.String input) Sets input
void	setMode(java.lang.String mode) Sets the input mode
void	setParserOptions(ParserOptions parserOptions) Sets parser options
void	setRefineConstraints(DocumentSetConstraint pRefineConstraints) Sets the echoed refine constraints

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

addError, getBuildTimeMs, 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, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toXML, toXML

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

CategorizeRequest.Response

public CategorizeRequest.Response(CategorizeRequest 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(SearchRequest, java.util.List).

Parameters:

pRequest - original request

pParsedResponses - parsed responses

Throws:

atg.search.routing.MergeException

CategorizeRequest.Response

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

CategorizeRequest.Response

public CategorizeRequest.Response()

Method Detail

equals

public boolean equals(java.lang.Object pObj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getAttributeXML

protected void getAttributeXML(java.lang.StringBuilder buf)
                        throws atg.search.routing.command.IncompleteCommandException

Overrides:

getAttributeXML in class atg.search.routing.command.SearchXMLObject

Throws:

atg.search.routing.command.IncompleteCommandException

getBodyXML

protected void getBodyXML(java.lang.StringBuilder sb)
                   throws atg.search.routing.command.IncompleteCommandException

Overrides:

getBodyXML in class atg.search.routing.command.SearchXMLObject

Throws:

atg.search.routing.command.IncompleteCommandException

merge

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

This is Java merge.

Specified by:

merge in class SearchResponse

Parameters:

pSearchRequest - the original request

pParsedResponses - pre-parsed responses

Throws:

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

getMode

public java.lang.String getMode()

Returns the input mode

Returns:

input mode

setMode

public void setMode(java.lang.String mode)

Sets the input mode

Parameters:

mode - input mode

getContentId

public java.lang.String getContentId()

Returns content ID of partition that produced the response. Only for single-partition indexes

Overrides:

getContentId in class SearchResponse

Returns:

content ID of partition that produced the response.

setContentId

public void setContentId(java.lang.String pContentId)

Sets content ID of partition that produced the response.

Parameters:

pContentId - content ID of partition that produced the response.

getInput

public java.lang.String getInput()

Returns the input

Returns:

input

setInput

public void setInput(java.lang.String input)

Sets input

Parameters:

input -

getCategorizations

public java.util.List<Categorization> getCategorizations()

Returns the list of Categorizations

Returns:

List of Categorization

setCategorizations

public void setCategorizations(java.util.List<Categorization> categorizations)

Sets the list of Categorizations

Parameters:

categorizations -

addCategorization

public void addCategorization(Categorization categorization)

Adds a categorization to the result list

Parameters:

categorization -

getDocumentSets

public DocumentSetConstraint getDocumentSets()

Returns the input document set constraints

Returns:

document set constraints

setDocumentSets

public void setDocumentSets(DocumentSetConstraint documentSets)

Sets the input document set constraints

Parameters:

documentSets -

getRefineConstraints

public DocumentSetConstraint getRefineConstraints()

Returns the echoed refine constraints

Returns:

the echoed refine constraints

setRefineConstraints

public void setRefineConstraints(DocumentSetConstraint pRefineConstraints)

Sets the echoed refine constraints

Parameters:

pRefineConstraints - the echoed refine constraints

getParserOptions

public ParserOptions getParserOptions()

Returns the input parser options

Returns:

parser options

setParserOptions

public void setParserOptions(ParserOptions parserOptions)

Sets parser options

Parameters:

parserOptions -