|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.search.routing.command.SearchXMLObject atg.search.routing.command.SearchEngineCommandResponse atg.search.routing.command.search.SearchResponse atg.search.routing.command.search.SearchResultsResponse atg.search.routing.command.search.StructuredQueryRequest.Response
public static class StructuredQueryRequest.Response
Response type for StructuredQueryRequest
.
Field Summary |
---|
Fields inherited from class atg.search.routing.command.search.SearchResultsResponse |
---|
CLASS_VERSION |
Fields inherited from class atg.search.routing.command.search.SearchResponse |
---|
mMultiPartitionSearch |
Constructor Summary | |
---|---|
StructuredQueryRequest.Response(atg.search.routing.command.SearchEngineResponse response)
Constructs a new response from the engine response |
|
StructuredQueryRequest.Response(StructuredQueryRequest pRequest,
java.util.List<SearchResponse> pParsedResponses)
This uses Java Merge instead of the engine's merge. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object pObject)
|
protected void |
getAttributeXML(java.lang.StringBuilder buf)
|
boolean |
getAutospell()
Returns the autospell attribute value |
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. |
java.lang.String |
getDebug()
Returns debug information from the engine |
int |
getDefaultXmlBytes()
|
StructuredQueryRequest.DocSetSort |
getDocSetSort()
Returns the docSetSort attribute value |
atg.search.routing.command.search.DocSortCommon |
getDocSort()
Returns the docSort attribute value |
StructuredQueryRequest.DocSortOrder |
getDocSortOrder()
Returns the doc sort order |
java.lang.String |
getDocSortPred()
Returns the doc sort predicate |
java.lang.String |
getDocSortProp()
Returns the doc sort property |
java.lang.String |
getDocSortPropDefault()
Returns the default doc sort property val |
DocSortPropVal |
getDocSortPropVal()
Returns the docsort prop val |
DocumentSetConstraint |
getDocumentSets()
Returns the document set constraints |
FeedbackReport |
getFeedbackReport()
Returns query feedback data |
int |
getGroupCount()
Returns the total number of answer groups in the results, regardless of paging. |
int |
getMaxRelatedSets()
Indicates how many related document sets (or categories) should be returned for each document |
int |
getMaxRelatedStatements()
Returns maximum number of related statements to return |
java.lang.String |
getMergeSettings()
mergeSettings that were used in the query |
ParserOptions |
getParserOptions()
Returns the text processing options |
java.util.List<ProcessedResponse> |
getProcessedPartitionResponses()
Gets the processed the engine responses from individual partitions. |
java.lang.String |
getRefineConfig()
Returns the refine config name |
int |
getRefineMax()
Returns the refine max |
Refinements |
getRefinements()
Returns the query refinements |
int |
getRefineMin()
Returns the refineMin attribute value |
int |
getRefineTop()
Returns the refineTop attribute value |
java.util.List<RelatedStatement> |
getRelatedStatements()
Returns matching individual statement results for final statement query |
java.lang.String |
getRequestTag()
|
ResponseTree |
getResponseTree()
Returns the categorization of the results |
java.util.List<StructuredStatement> |
getStatements()
Returns the user input statements |
int |
getTop()
Returns the maximum number of results to return |
int |
getWeightContribution()
Returns the relative contribution of the weighted preference value to the total relevance |
DocumentSetConstraint |
getWeightedProperties()
Returns the weighted properties |
boolean |
isDocSortCase()
Returns the docSortCase |
boolean |
isRefineDebug()
Returns whether refine config debug is enabled |
protected void |
merge(SearchRequest pSearchRequest,
java.util.List<SearchResponse> pParsedResponses)
This is Java merge. |
void |
setAutospell(boolean autospell)
Sets the autospell attribute value |
void |
setContentId(java.lang.String contentId)
Sets the content ID for the partition, if appplicable |
void |
setDebug(java.lang.String pDebug)
Sets debug information from the engine |
void |
setDocSetSort(StructuredQueryRequest.DocSetSort docSetSort)
Sets the docSetSort attribute value |
void |
setDocSort(atg.search.routing.command.search.DocSortCommon docSort)
Sets the docSort attribute value |
void |
setDocSortCase(boolean pDocSortCase)
Sets docSortCase |
void |
setDocSortOrder(StructuredQueryRequest.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 doc sort property val |
void |
setDocSortPropVal(DocSortPropVal pDocSortPropVal)
Sets the docsort prop val |
void |
setDocumentSets(DocumentSetConstraint documentSets)
Sets document set constraints |
void |
setFeedbackReport(FeedbackReport feedbackReport)
Sets query feedback data |
void |
setGroupCount(int pGroupCount)
Sets number of answer groups before paging |
void |
setMaxRelatedSets(int maxRelatedSets)
Sets how many related document sets (or categories) should be returned for each document |
void |
setMaxRelatedStatements(int maxRelatedStatements)
Sets maximum number of related statements to return |
void |
setMergeSettings(java.lang.String mergeSettings)
Sets the mergeSettings that were used in the query |
void |
setParserOptions(ParserOptions parserOptions)
Sets the text processing options |
void |
setRefineConfig(java.lang.String pRefineConfig)
Sets the refine config name |
void |
setRefineDebug(boolean pRefineDebug)
Sets whether refine config debug is enabled |
void |
setRefineMax(int refineMax)
Sets the refine max |
void |
setRefinements(Refinements refinements)
Sets query refinements |
void |
setRefineMin(int refineMin)
Sets refineMin attribute value |
void |
setRefineTop(int refineTop)
Sets the refineTop attribute value |
void |
setRelatedStatements(java.util.List<RelatedStatement> relatedStatements)
Sets matching individual statement results for final statement query |
void |
setResponseTree(ResponseTree responseTree)
Sets the categorization of the results |
void |
setStatements(java.util.List<StructuredStatement> statements)
Sets user input statements |
void |
setTop(int top)
Sets the maximum number of results to return |
void |
setWeightContribution(int weightContribution)
Sets the relative contribution of the weighted preference value to the total relevance |
void |
setWeightedProperties(DocumentSetConstraint weightedProperties)
Sets the weighted properties |
Methods inherited from class atg.search.routing.command.search.SearchResultsResponse |
---|
addResult, addResults, getGroups, getHasMoreResults, getMinScore, getPageNum, getPageOffsetInfo, getPageSize, getResults, getResultsWithGrouping, getSpellingTerms, getSuggestedCategories, setMinScore, setPageNum, setPageOffsetInfo, setPageSize, setResults, setSpellingTerms, setSuggestedCategories |
Methods inherited from class atg.search.routing.command.SearchEngineCommandResponse |
---|
getNextResponse, getNonSAXParser, 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, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toXML, toXML |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public StructuredQueryRequest.Response(StructuredQueryRequest pRequest, java.util.List<SearchResponse> pParsedResponses) throws atg.search.routing.MergeException
merge(SearchRequest, java.util.List)
.
pRequest
- original requestpParsedResponses
- parsed responses
atg.search.routing.MergeException
public StructuredQueryRequest.Response(atg.search.routing.command.SearchEngineResponse response)
response
- Method Detail |
---|
public boolean equals(java.lang.Object pObject)
equals
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 responses
atg.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
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.util.List<RelatedStatement> getRelatedStatements()
RelatedStatement
public void setRelatedStatements(java.util.List<RelatedStatement> relatedStatements)
relatedStatements
- matching individual statement results for final statement querypublic java.lang.String getDebug()
public void setDebug(java.lang.String pDebug)
pDebug
- debug information from the enginepublic int getMaxRelatedStatements()
public void setMaxRelatedStatements(int maxRelatedStatements)
maxRelatedStatements
- maximum number of related statements to returnpublic boolean isDocSortCase()
public void setDocSortCase(boolean pDocSortCase)
pDocSortCase
- docSortCasepublic java.lang.String getDocSortPred()
public void setDocSortPred(java.lang.String docSortPred)
docSortPred
- the doc sort predicatepublic int getTop()
public void setTop(int top)
top
- maximum number of results to returnpublic int getWeightContribution()
public void setWeightContribution(int weightContribution)
weightContribution
- the relative contribution of the weighted preference value to the total relevancepublic int getMaxRelatedSets()
public void setMaxRelatedSets(int maxRelatedSets)
maxRelatedSets
- how many related document sets (or categories) should be returned for each documentpublic java.util.List<StructuredStatement> getStatements()
public void setStatements(java.util.List<StructuredStatement> statements)
statements
- user input statementspublic java.util.List<ProcessedResponse> getProcessedPartitionResponses()
SearchEngineRequest.setKeepingResponseData(boolean)
.
StructuredQueryRequest.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
- content ID for the partition, if appplicablepublic StructuredQueryRequest.DocSetSort getDocSetSort()
public void setDocSetSort(StructuredQueryRequest.DocSetSort docSetSort)
docSetSort
- the docSetSort attribute valuepublic 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
- number of answer groups before pagingpublic java.lang.String getMergeSettings()
public void setMergeSettings(java.lang.String mergeSettings)
mergeSettings
- mergeSettings that were used in the querypublic java.lang.String getRefineConfig()
public void setRefineConfig(java.lang.String pRefineConfig)
pRefineConfig
- the refine config namepublic boolean isRefineDebug()
public void setRefineDebug(boolean pRefineDebug)
pRefineDebug
- whether refine config debug is enabledpublic int getRefineMax()
public void setRefineMax(int refineMax)
refineMax
- refine maxpublic int getRefineMin()
public void setRefineMin(int refineMin)
refineMin
- refineMin attribute valuepublic int getRefineTop()
public void setRefineTop(int refineTop)
refineTop
- refineTop attribute valuepublic boolean getAutospell()
public void setAutospell(boolean autospell)
autospell
- autospell attribute valuepublic atg.search.routing.command.search.DocSortCommon getDocSort()
public void setDocSort(atg.search.routing.command.search.DocSortCommon docSort)
docSort
- docSort attribute valuepublic java.lang.String getDocSortProp()
public void setDocSortProp(java.lang.String docSortProp)
docSortProp
- the doc sort propertypublic DocSortPropVal getDocSortPropVal()
public void setDocSortPropVal(DocSortPropVal pDocSortPropVal)
pDocSortPropVal
- docsort prop valpublic java.lang.String getDocSortPropDefault()
public void setDocSortPropDefault(java.lang.String docSortPropDefault)
docSortPropDefault
- the default doc sort property valpublic StructuredQueryRequest.DocSortOrder getDocSortOrder()
public void setDocSortOrder(StructuredQueryRequest.DocSortOrder docSortOrder)
docSortOrder
- the doc sort orderpublic DocumentSetConstraint getDocumentSets()
public void setDocumentSets(DocumentSetConstraint documentSets)
documentSets
- document set constraintspublic DocumentSetConstraint getWeightedProperties()
public void setWeightedProperties(DocumentSetConstraint weightedProperties)
weightedProperties
- weighted propertiespublic ParserOptions getParserOptions()
public void setParserOptions(ParserOptions parserOptions)
parserOptions
- text processing optionspublic ResponseTree getResponseTree()
public void setResponseTree(ResponseTree responseTree)
responseTree
- the categorization of the resultspublic FeedbackReport getFeedbackReport()
public void setFeedbackReport(FeedbackReport feedbackReport)
feedbackReport
- query feedback datapublic Refinements getRefinements()
public void setRefinements(Refinements refinements)
refinements
- query refinements
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |