public static class SimilarDocsRequest.Response extends SearchResultsResponse
SimilarDocsRequest
.CLASS_VERSION
mMultiPartitionSearch
Constructor and Description |
---|
SimilarDocsRequest.Response() |
SimilarDocsRequest.Response(atg.search.routing.command.SearchEngineResponse response)
Constructs a response from a single engine's response
|
SimilarDocsRequest.Response(SimilarDocsRequest pRequest,
java.util.List<SearchResponse> pParsedResponses)
This uses Java Merge instead of the engine's merge.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object pObject) |
protected void |
getAttributeXML(java.lang.StringBuilder buf) |
protected void |
getBodyXML(java.lang.StringBuilder buf) |
java.lang.String |
getContentId()
Returns the unique content guid for the partition that provided this response, if the request
type supports its return.
|
SimilarDocsRequest.DocSetSort |
getDocSetSort()
Returns the doc set sort type
|
atg.search.routing.command.search.DocSort |
getDocSort()
Returns the doc sort type
|
atg.search.routing.command.search.DocSortOrder |
getDocSortOrder()
Returns the doc sort order
|
java.lang.String |
getDocSortPred()
echoed doc sort predicate
|
java.lang.String |
getDocSortProp()
Returns the doc sort property
|
java.lang.String |
getDocSortPropDefault()
Returns the default the docsort prop val
|
DocSortPropVal |
getDocSortPropVal()
Returns the docsort prop val
|
DocumentSetConstraint |
getDocumentSets()
Returns the docset constraint
|
int |
getGroupCount()
Returns the total number of answer groups in the results, regardless of paging.
|
java.lang.String |
getInput()
Returns the input to use for similarity comparison.
|
int |
getMaxRelatedSets()
Returns how many related document sets (or categories) should be returned for each document
|
java.lang.String |
getMergeSettings()
Returns the mergeSettings that were used in the query
|
SimilarDocsRequest.Mode |
getMode()
Returns the input mode
|
ParserOptions |
getParserOptions()
Returns text processing options
|
java.util.List<ProcessedResponse> |
getProcessedPartitionResponses()
Gets the processed the engine responses from individual partitions.
|
ResponseTree |
getResponseTree()
Returns the response tree
|
float |
getThreshold()
Returns the similarity threshold
|
int |
getTop()
Returns the maximum number of results to return
|
int |
hashCode() |
boolean |
isDocSortCase()
Indicates whether doc sort is case sensitive
|
protected void |
merge(SearchRequest pSearchRequest,
java.util.List<SearchResponse> pParsedResponses)
This is Java merge.
|
void |
setContentId(java.lang.String contentId)
Sets the content id
|
void |
setDocSetSort(SimilarDocsRequest.DocSetSort docSetSort)
Sets the doc set sort type
|
void |
setDocSort(atg.search.routing.command.search.DocSort docSort)
Sets the doc sort type
|
void |
setDocSortCase(boolean pDocSortCase)
Sets whether doc sort is case sensitive
|
void |
setDocSortOrder(atg.search.routing.command.search.DocSortOrder docSortOrder)
Sets the doc sort order
|
void |
setDocSortPred(java.lang.String docSortPred)
Sets the doc sort predicate
|
void |
setDocSortProp(java.lang.String docSortProp)
Sets the doc sort property
|
void |
setDocSortPropDefault(java.lang.String docSortPropDefault)
Sets the default the docsort prop val
|
void |
setDocSortPropVal(DocSortPropVal pDocSortPropVal)
Sets the docsort prop val
|
void |
setDocumentSets(DocumentSetConstraint documentSets)
Sets the docset constraint
|
void |
setGroupCount(int pGroupCount)
Sets the number of results before paging
|
void |
setInput(java.lang.String input)
Sets the input
|
void |
setMaxRelatedSets(int maxRelatedSets)
Sets how many related document sets (or categories) should be returned for each document
|
void |
setMergeSettings(java.lang.String mergeSettings)
Sets the mergeSettings that were used in the query
|
void |
setMode(SimilarDocsRequest.Mode mode)
Sets the input mode
|
void |
setParserOptions(ParserOptions parserOptions)
Sets text processing options
|
void |
setResponseTree(ResponseTree responseTree)
Sets the response tree
|
void |
setThreshold(float threshold)
Sets the similarity threshold
|
void |
setTop(int top)
Sets the Maximum number of results to return
|
addResult, addResults, getGroups, getHasMoreResults, getMinScore, getPageNum, getPageOffsetInfo, getPageSize, getResults, getResultsWithGrouping, getSpellingTerms, getSuggestedCategories, setMinScore, setPageNum, setPageOffsetInfo, setPageSize, setResults, setSpellingTerms, setSuggestedCategories
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
getNextResponse, getNonSAXParser, getRequestTag, 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 SimilarDocsRequest.Response(SimilarDocsRequest pRequest, java.util.List<SearchResponse> pParsedResponses) throws atg.search.routing.MergeException
merge(SearchRequest, java.util.List)
.pRequest
- original requestpParsedResponses
- parsed responsesatg.search.routing.MergeException
public SimilarDocsRequest.Response(atg.search.routing.command.SearchEngineResponse response)
response
- a response from an enginepublic SimilarDocsRequest.Response()
public boolean equals(java.lang.Object pObject)
equals
in class SearchResultsResponse
public int hashCode()
hashCode
in class SearchResultsResponse
protected void merge(SearchRequest pSearchRequest, java.util.List<SearchResponse> pParsedResponses) throws atg.search.routing.MergeException
merge
in class SearchResponse
pSearchRequest
- the original requestpParsedResponses
- pre-parsed responsesatg.search.routing.MergeException
- if the merge failsprotected void getAttributeXML(java.lang.StringBuilder buf) 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 buf) throws atg.search.routing.command.IncompleteCommandException
getBodyXML
in class atg.search.routing.command.SearchXMLObject
atg.search.routing.command.IncompleteCommandException
public java.lang.String getMergeSettings()
public void setMergeSettings(java.lang.String mergeSettings)
mergeSettings
- the mergeSettings that were used in the querypublic int getGroupCount()
SearchResultsResponse
SimilarDocsRequest
, this is simply the number of
results.getGroupCount
in interface PagedResponse
getGroupCount
in class SearchResultsResponse
public void setGroupCount(int pGroupCount)
pGroupCount
- the number of results before pagingpublic SimilarDocsRequest.Mode getMode()
public void setMode(SimilarDocsRequest.Mode mode)
mode
- the input modepublic boolean isDocSortCase()
public void setDocSortCase(boolean pDocSortCase)
pDocSortCase
- whether doc sort is case sensitivepublic int getTop()
public void setTop(int top)
top
- Maximum number of results to returnpublic float getThreshold()
public void setThreshold(float threshold)
threshold
- the similarity thresholdpublic int getMaxRelatedSets()
public void setMaxRelatedSets(int maxRelatedSets)
maxRelatedSets
- how many related document sets (or categories) should be returned for each documentpublic java.lang.String getInput()
public void setInput(java.lang.String input)
input
- the inputpublic java.util.List<ProcessedResponse> getProcessedPartitionResponses()
SearchEngineRequest.setKeepingResponseData(boolean)
.QueryRequest.Response
, possibly empty but never null. Bad results
will have null elements in the collection.public java.lang.String getContentId()
SearchResponse
getContentId
in class SearchResponse
public void setContentId(java.lang.String contentId)
contentId
- public SimilarDocsRequest.DocSetSort getDocSetSort()
public void setDocSetSort(SimilarDocsRequest.DocSetSort docSetSort)
docSetSort
- the doc set sort typepublic atg.search.routing.command.search.DocSort getDocSort()
public void setDocSort(atg.search.routing.command.search.DocSort docSort)
docSort
- the doc sort typepublic java.lang.String getDocSortProp()
public void setDocSortProp(java.lang.String docSortProp)
docSortProp
- the doc sort propertypublic DocSortPropVal getDocSortPropVal()
public void setDocSortPropVal(DocSortPropVal pDocSortPropVal)
pDocSortPropVal
- the docsort prop valpublic java.lang.String getDocSortPropDefault()
public void setDocSortPropDefault(java.lang.String docSortPropDefault)
docSortPropDefault
- the default the docsort prop valpublic atg.search.routing.command.search.DocSortOrder getDocSortOrder()
public void setDocSortOrder(atg.search.routing.command.search.DocSortOrder docSortOrder)
docSortOrder
- the doc sort orderpublic java.lang.String getDocSortPred()
public void setDocSortPred(java.lang.String docSortPred)
docSortPred
- the doc sort predicatepublic DocumentSetConstraint getDocumentSets()
public void setDocumentSets(DocumentSetConstraint documentSets)
documentSets
- the docset constraintpublic ParserOptions getParserOptions()
public void setParserOptions(ParserOptions parserOptions)
parserOptions
- text processing optionspublic ResponseTree getResponseTree()
public void setResponseTree(ResponseTree responseTree)
responseTree
- the response tree