public static class QueryRequest.Response extends SearchResultsResponse
CLASS_VERSION
mMultiPartitionSearch
Constructor and Description |
---|
Response() |
Response(QueryRequest pRequest,
java.util.List<SearchResponse> pParsedResponses)
This Java Merge instead of the engine's merge.
|
Response(atg.search.routing.command.SearchEngineResponse response) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object pObject) |
atg.search.routing.command.search.AndFeedback |
getAndFeedback()
Returns boolean AND feedback
|
int |
getAnswerCandidates()
Returns the number of sentence candidates considered during retrieval
|
java.lang.String |
getAnswerCandidatesXml()
Statement candidate information for inspection tool
|
int |
getAnswerMax()
Returns an estimate of how many sentences are retrievable by the current query
|
int |
getAnswerMin()
Returns the minimum number of sentences that could be considered, if all query terms were in the same sentences
|
int |
getAnswerPool()
Returns the number of sentence results in the final result pool, before grouping and paging
|
protected void |
getAttributeXML(java.lang.StringBuilder buf)
Override to provide attributes.
|
boolean |
getAutoSpell()
Returns whether autospell is enabled
|
protected void |
getBodyXML(java.lang.StringBuilder buf)
Override to provide the body of the xml.
|
java.lang.String |
getContentId()
Returns the unique content guid for the partition that provided this response, if the request
type supports its return.
|
java.lang.String |
getDebug()
Returns debug information from the engine
|
int |
getDefaultXmlBytes() |
Diagnostics |
getDiagnostics()
Search diagnostic and trace output
|
int |
getDocCandidates()
Number of document candidates considered during retrieval
|
java.lang.String |
getDocCandidatesXml()
Document candidate information for inspection tool
|
int |
getDocMax()
Returns an estimate of how many documents are retrievable by the current query
|
int |
getDocMin()
Returns the minimum number of documents that could be considered, if all query terms were in the same documents
|
QueryRequest.DocSetSort |
getDocSetSort()
returns the doc set sorting
|
atg.search.routing.command.search.DocSort |
getDocSort()
Returns doc sorting
|
atg.search.routing.command.search.DocSortOrder |
getDocSortOrder()
Returns doc sort order
|
java.lang.String |
getDocSortPred()
Returns doc sort predicate
|
java.lang.String |
getDocSortProp()
Returns doc sort property
|
java.lang.String |
getDocSortPropDefault()
Returns doc sort property default
|
DocSortPropVal |
getDocSortPropVal()
Returns docsort prop val
|
DocumentSetConstraint |
getDocumentSets()
Returns the document constraint expression
|
FeedbackReport |
getFeedbackReport()
Returns query feedback data
|
int |
getGroupCount()
Returns the total number of answer groups in the results, regardless of paging.
|
boolean |
getHighlight()
Returns whether highlights are enabled
|
java.lang.String |
getInfo()
Returns miscellaneous information
|
java.lang.String |
getLogicTree()
Custom query logic tree
|
int |
getMaxRelatedSets()
Returns max related sets
|
java.lang.String |
getMergeSettings()
Returns the mergeSettings that were used in the query
|
QueryRequest.Mode |
getMode()
Returns the query mode
|
ParserOptions |
getParserOptions()
Returns the text processing options
|
DocumentSetConstraint |
getPrefAnswerConstraints()
Preferred answer constraint expression
|
java.util.List<java.lang.String> |
getPriorInput()
Returns a Collection of Strings representing prior or secondary user input
|
java.util.List<ProcessedResponse> |
getProcessedPartitionResponses()
Gets the processed the engine responses from individual partitions.
|
QueryAction |
getQueryAction()
Query action results.
|
QueryRule |
getQueryRule()
Query analysis rule results
|
QueryTerms |
getQueryTerms()
Advanced query term vector data
|
java.lang.String |
getQuestion()
User search input, possibly modified with auto-corrections.
|
java.lang.String |
getRanking()
Returns the custom ranking algorithm
|
java.lang.String |
getRefineConfig()
Returns the refine config name
|
int |
getRefineMax()
Returns the maximum number of refinements
|
Refinements |
getRefinements()
Returns query refinement data
|
int |
getRefineMin()
Returns the minimum number of refinements
|
int |
getRefineMinVal()
Returns the minimum number of refinement values
|
int |
getRefineTop()
Returns the number of top refinements to return
|
java.lang.String |
getRelQuestSettings()
Returns the relQuestSettings that were used in the query
|
ReportDataResults |
getReportDataResults()
Report data derived from input query
|
java.lang.String |
getRequestTag()
Gets the xml element tag used in the request
|
int |
getResponseCount()
Returns the total number of results returned, before paging
|
java.lang.String |
getResponseNumberSettings()
Returns the responseNumSettings that were used in the query
|
float |
getResponseScore()
Returns the relevancy score of the top result.
|
ResponseTree |
getResponseTree()
Returns the categorization of the results
|
RuleAppendix |
getRuleAppendix()
Source format of any rules referred to in the response
|
RuleExclusions |
getRuleExclusions()
Query rules that would have excluded documents if enabled (debugExclusion="true")
|
RulePositioning |
getRulePositioning()
Returns the query rules that re-positioned results
|
QueryRequest.Sorting |
getSorting()
Returns result sorting (grouping)
|
java.lang.String |
getSortProp()
returns the sort property
|
java.lang.String |
getStartCategory()
Returns user category navigation input.
|
QueryRequest.Strategy |
getStrategy()
Returns the query strategy
|
java.lang.String |
getTopicSettings()
Returns the topic settings that were used
|
java.lang.String |
getUserQuestion()
Returns the user's search input, unmodified
|
Validation |
getValidation()
Returns various checks on the validity of the request given the content
|
DocumentSetConstraint |
getWeightedProperties()
Document preference expression
|
int |
hashCode() |
boolean |
isDocSortCase()
Returns whether doc sorting is case sensitive in the results
|
boolean |
isRefineDebug()
Returns whether refinement debugging is enabled
|
protected void |
merge(SearchRequest pSearchRequest,
java.util.List<SearchResponse> pParsedResponses)
This is Java merge for
QueryRequest.Response . |
void |
setAndFeedback(atg.search.routing.command.search.AndFeedback pAndFeedback)
Sets boolean AND feedback results
|
void |
setAnswerCandidates(int answerCandidates)
Sets the number of sentence candidates considered during retrieval
|
void |
setAnswerCandidatesXml(java.lang.String answerCandidatesXml)
Sets statement candidate information for inspection tool
|
void |
setAnswerMax(int answerMax)
Sets an estimate of how many sentences are retrievable by the current query
|
void |
setAnswerMin(int answerMin)
Sets the minimum number of sentences that could be considered, if all query terms were in the same sentences
|
void |
setAnswerPool(int answerPool)
Sets the number of sentence results in the final result pool, before grouping and paging
|
void |
setAutoSpell(boolean autoSpell)
Sets whether autospell is enabled
|
void |
setContentId(java.lang.String contentId) |
void |
setDebug(java.lang.String pDebug)
Sets debug information from the engine
|
void |
setDiagnostics(Diagnostics pDiagnostics)
Sets Search diagnostic and trace output
|
void |
setDocCandidates(int docCandidates)
Sets the number of document candidates considered during retrieval
|
void |
setDocCandidatesXml(java.lang.String docCandidatesXml)
Sets document candidate information for inspection tool
|
void |
setDocMax(int docMax)
Sets an estimate of how many documents are retrievable by the current query
|
void |
setDocMin(int docMin)
Sets the minimum number of documents that could be considered, if all query terms were in the same documents
|
void |
setDocSetSort(QueryRequest.DocSetSort docSetSort)
Sets doc set sorting
|
void |
setDocSort(atg.search.routing.command.search.DocSort docSort)
Sets doc sorting
|
void |
setDocSortCase(boolean pDocSortCase)
Sets whether doc sorting is case sensitive in the results
|
void |
setDocSortOrder(atg.search.routing.command.search.DocSortOrder docSortOrder)
Sets doc sort order
|
void |
setDocSortPred(java.lang.String docSortPred)
Sets doc sort predicate
|
void |
setDocSortProp(java.lang.String docSortProp)
Sets doc sort property
|
void |
setDocSortPropDefault(java.lang.String docSortPropDefault)
Sets doc sort property default
|
void |
setDocSortPropVal(DocSortPropVal pDocSortPropVal)
Sets doc sort prop val
|
void |
setDocumentSets(DocumentSetConstraint documentSets)
Sets the docset constraint
|
void |
setFeedbackReport(FeedbackReport feedbackReport)
Sets query feedback data
|
void |
setGroupCount(int groupCount)
Sets the group count without taking paging into account
|
void |
setHighlight(boolean highlight)
Sets whether highlights are enabled
|
void |
setInfo(java.lang.String info)
Sets info
|
void |
setLogicTree(java.lang.String logicTree)
Sets the logic tree
|
void |
setMaxRelatedSets(int pMaxRelatedSets)
Sets max related sets
|
void |
setMergeSettings(java.lang.String mergeSettings)
Sets the mergeSettings that were used in the query
|
void |
setMode(QueryRequest.Mode mode)
Sets the query mode
|
void |
setParserOptions(ParserOptions parserOptions)
Sets the text processing options
|
void |
setPrefAnswerConstraints(DocumentSetConstraint prefAnswerConstraints)
Sets the preferred answer constraint expression
|
void |
setPriorInput(java.util.List<java.lang.String> priorInput)
Sets prior input
|
void |
setQueryAction(QueryAction pAction)
Sets the query action results.
|
void |
setQueryRule(QueryRule queryRule)
Sets query rule results
|
void |
setQueryTerms(QueryTerms queryTerms)
Sets advanced query term vector data
|
void |
setQuestion(java.lang.String question)
Sets the user question
|
void |
setRanking(java.lang.String ranking)
Sets the custom ranking algorithm
|
void |
setRefineConfig(java.lang.String pRefineConfig)
Sets the refine config name
|
void |
setRefineDebug(boolean refineDebug)
Sets whether refinement debugging is enabled
|
void |
setRefineMax(int refineMax)
Sets the maximum number of refinements
|
void |
setRefinements(Refinements refinements)
Sets query refinement data
|
void |
setRefineMin(int refineMin)
Sets the minimum number of refinements
|
void |
setRefineMinVal(int refineMinVal)
Sets the minimum number of refinements
|
void |
setRefineTop(int refineTop)
Sets the number of top refinements to return
|
void |
setRelQuestSettings(java.lang.String relQuestSettings)
Sets relQuestSettings that were used in the query
|
void |
setReportDataResults(ReportDataResults reportDataResults)
Sets report data derived from input query
|
void |
setResponseCount(int responseCount)
Sets the total number of results returned, before paging
|
void |
setResponseNumberSettings(java.lang.String responseNumSettings)
Sets the responseNumSettings that were used in the query
|
void |
setResponseScore(float responseScore)
Sets the relevancy score of the top result.
|
void |
setResponseTree(ResponseTree responseTree)
Sets the categorization of the results
|
void |
setRuleAppendix(RuleAppendix pRuleAppendix)
Sets the source format of any rules referred to in the response
|
void |
setRuleExclusions(RuleExclusions pRuleExclusions)
Sets rule exclusions
|
void |
setRulePositioning(RulePositioning pRulePositioning)
Sets the query rules that re-positioned results
|
void |
setSorting(QueryRequest.Sorting sorting)
Sets result sorting (grouping)
|
void |
setSortProp(java.lang.String sortProp)
Sets the sort property
|
void |
setStartCategory(java.lang.String pStartCategory)
Sets the user's catnav input
|
void |
setStrategy(QueryRequest.Strategy strategy)
Sets the query strategy
|
void |
setTopicSettings(java.lang.String topicSettings)
Sets the topic settings that were used
|
void |
setUserQuestion(java.lang.String userQuestion)
Sets the user's unmodified input
|
void |
setValidation(Validation pValidation)
Sets various checks on the validity of the request given the content
|
void |
setWeightedProperties(DocumentSetConstraint weightedProperties)
Sets the document preference expression
|
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, getSearchEngineResponse, parseResponse, setNextResponse, setSearchEngineResponse
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toXML, toXML
public Response()
public Response(atg.search.routing.command.SearchEngineResponse response)
public Response(QueryRequest 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 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
QueryRequest.Response
.merge
in class SearchResponse
pSearchRequest
- the original requestpParsedResponses
- the parsed responsesatg.search.routing.MergeException
- if the merge failspublic java.lang.String getRequestTag()
getRequestTag
in class atg.search.routing.command.SearchEngineCommandResponse
public int getDefaultXmlBytes()
getDefaultXmlBytes
in class atg.search.routing.command.SearchXMLObject
protected 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
- if required values are missingprotected void getBodyXML(java.lang.StringBuilder buf) throws atg.search.routing.command.IncompleteCommandException
getBodyXML
in class atg.search.routing.command.SearchXMLObject
buf
- shared bufferatg.search.routing.command.IncompleteCommandException
public java.util.List<ProcessedResponse> getProcessedPartitionResponses()
SearchEngineRequest.setKeepingResponseData(boolean)
.QueryRequest.Response
, possibly empty but never null.public java.lang.String getContentId()
SearchResponse
getContentId
in class SearchResponse
public void setContentId(java.lang.String contentId)
contentId
- content ID for index partitionpublic java.lang.String getDebug()
public void setDebug(java.lang.String pDebug)
pDebug
- debug information from the enginepublic QueryRequest.Sorting getSorting()
public void setSorting(QueryRequest.Sorting sorting)
sorting
- result sorting (grouping)public boolean isDocSortCase()
public void setDocSortCase(boolean pDocSortCase)
pDocSortCase
- Sets whether doc sorting is case sensitivepublic java.lang.String getSortProp()
public void setSortProp(java.lang.String sortProp)
sortProp
- sort propertypublic QueryRequest.DocSetSort getDocSetSort()
public void setDocSetSort(QueryRequest.DocSetSort docSetSort)
docSetSort
- doc set sortingpublic QueryRequest.Mode getMode()
public void setMode(QueryRequest.Mode mode)
mode
- public QueryRequest.Strategy getStrategy()
public void setStrategy(QueryRequest.Strategy strategy)
strategy
- the query strategypublic java.lang.String getRefineConfig()
public void setRefineConfig(java.lang.String pRefineConfig)
pRefineConfig
- the refine config namepublic int getRefineMax()
public void setRefineMax(int refineMax)
refineMax
- the maximum number of refinementspublic int getRefineMin()
public void setRefineMin(int refineMin)
refineMin
- the minimum number of refinementspublic int getRefineMinVal()
public void setRefineMinVal(int refineMinVal)
refineMinVal
- the minimum number of refinementspublic int getRefineTop()
public void setRefineTop(int refineTop)
refineTop
- the number of top refinements to returnpublic boolean isRefineDebug()
public void setRefineDebug(boolean refineDebug)
refineDebug
- whether refinement debugging is enabledpublic boolean getAutoSpell()
public void setAutoSpell(boolean autoSpell)
autoSpell
- whether autospell is enabledpublic boolean getHighlight()
public void setHighlight(boolean highlight)
highlight
- whether highlights are enabledpublic int getMaxRelatedSets()
public void setMaxRelatedSets(int pMaxRelatedSets)
pMaxRelatedSets
- max related setspublic atg.search.routing.command.search.DocSort getDocSort()
public void setDocSort(atg.search.routing.command.search.DocSort docSort)
docSort
- public java.lang.String getDocSortPred()
public void setDocSortPred(java.lang.String docSortPred)
docSortPred
- public java.lang.String getDocSortProp()
public void setDocSortProp(java.lang.String docSortProp)
docSortProp
- public DocSortPropVal getDocSortPropVal()
public void setDocSortPropVal(DocSortPropVal pDocSortPropVal)
pDocSortPropVal
- public java.lang.String getDocSortPropDefault()
public void setDocSortPropDefault(java.lang.String docSortPropDefault)
docSortPropDefault
- public atg.search.routing.command.search.DocSortOrder getDocSortOrder()
public void setDocSortOrder(atg.search.routing.command.search.DocSortOrder docSortOrder)
docSortOrder
- public java.lang.String getRelQuestSettings()
public void setRelQuestSettings(java.lang.String relQuestSettings)
relQuestSettings
- public java.lang.String getResponseNumberSettings()
public void setResponseNumberSettings(java.lang.String responseNumSettings)
responseNumSettings
- public java.lang.String getMergeSettings()
public void setMergeSettings(java.lang.String mergeSettings)
mergeSettings
- public java.lang.String getTopicSettings()
public void setTopicSettings(java.lang.String topicSettings)
topicSettings
- public int getResponseCount()
public void setResponseCount(int responseCount)
responseCount
- the total number of results returned, before pagingpublic int getGroupCount()
SearchResultsResponse
SimilarDocsRequest
, this is simply the number of
results.getGroupCount
in interface PagedResponse
getGroupCount
in class SearchResultsResponse
public void setGroupCount(int groupCount)
groupCount
- public int getDocMax()
public void setDocMax(int docMax)
docMax
- public int getDocMin()
public void setDocMin(int docMin)
docMin
- public float getResponseScore()
public void setResponseScore(float responseScore)
responseScore
- public int getAnswerCandidates()
public void setAnswerCandidates(int answerCandidates)
answerCandidates
- the number of sentence candidates considered during retrievalpublic int getAnswerMax()
public void setAnswerMax(int answerMax)
answerMax
- an estimate of how many sentences are retrievable by the current querypublic int getAnswerMin()
public void setAnswerMin(int answerMin)
answerMin
- the minimum number of sentences that could be considered, if all query terms were in the same sentencespublic int getAnswerPool()
public void setAnswerPool(int answerPool)
answerPool
- the number of sentence results in the final result pool, before grouping and pagingpublic Diagnostics getDiagnostics()
public void setDiagnostics(Diagnostics pDiagnostics)
pDiagnostics
- Search diagnostic and trace outputpublic RuleExclusions getRuleExclusions()
QueryRequest.setDebugExclusion(Boolean)
)public void setRuleExclusions(RuleExclusions pRuleExclusions)
pRuleExclusions
- rule exclusionspublic RulePositioning getRulePositioning()
public void setRulePositioning(RulePositioning pRulePositioning)
pRulePositioning
- Query rules that re-positioned resultspublic RuleAppendix getRuleAppendix()
public void setRuleAppendix(RuleAppendix pRuleAppendix)
pRuleAppendix
- Source format of any rules referred to in the responsepublic Validation getValidation()
public void setValidation(Validation pValidation)
pValidation
- Various checks on the validity of the request given the contentpublic java.lang.String getDocCandidatesXml()
public void setDocCandidatesXml(java.lang.String docCandidatesXml)
docCandidatesXml
- public java.lang.String getAnswerCandidatesXml()
public void setAnswerCandidatesXml(java.lang.String answerCandidatesXml)
answerCandidatesXml
- public java.lang.String getQuestion()
getStartCategory()
getUserQuestion()
public void setQuestion(java.lang.String question)
question
- public java.lang.String getStartCategory()
public void setStartCategory(java.lang.String pStartCategory)
pStartCategory
- public java.lang.String getUserQuestion()
getQuestion()
public void setUserQuestion(java.lang.String userQuestion)
userQuestion
- public java.lang.String getInfo()
public void setInfo(java.lang.String info)
info
- public java.util.List<java.lang.String> getPriorInput()
public void setPriorInput(java.util.List<java.lang.String> priorInput)
priorInput
- Collection of Stringspublic DocumentSetConstraint getDocumentSets()
public void setDocumentSets(DocumentSetConstraint documentSets)
documentSets
- public DocumentSetConstraint getPrefAnswerConstraints()
public void setPrefAnswerConstraints(DocumentSetConstraint prefAnswerConstraints)
prefAnswerConstraints
- public DocumentSetConstraint getWeightedProperties()
public void setWeightedProperties(DocumentSetConstraint weightedProperties)
weightedProperties
- public java.lang.String getRanking()
public void setRanking(java.lang.String ranking)
ranking
- the custom ranking algorithmpublic java.lang.String getLogicTree()
public void setLogicTree(java.lang.String logicTree)
logicTree
- public ParserOptions getParserOptions()
public void setParserOptions(ParserOptions parserOptions)
parserOptions
- the text processing optionspublic QueryTerms getQueryTerms()
public void setQueryTerms(QueryTerms queryTerms)
queryTerms
- public QueryRule getQueryRule()
public void setQueryRule(QueryRule queryRule)
queryRule
- public QueryAction getQueryAction()
public void setQueryAction(QueryAction pAction)
pAction
- public ResponseTree getResponseTree()
public void setResponseTree(ResponseTree responseTree)
responseTree
- the categorization of the resultspublic FeedbackReport getFeedbackReport()
public void setFeedbackReport(FeedbackReport feedbackReport)
feedbackReport
- public atg.search.routing.command.search.AndFeedback getAndFeedback()
public void setAndFeedback(atg.search.routing.command.search.AndFeedback pAndFeedback)
pAndFeedback
- feedback resultspublic Refinements getRefinements()
public void setRefinements(Refinements refinements)
refinements
- query refinement datapublic ReportDataResults getReportDataResults()
public void setReportDataResults(ReportDataResults reportDataResults)
reportDataResults
- public int getDocCandidates()
public void setDocCandidates(int docCandidates)
docCandidates
- number of document candidates considered during retrieval