|
|||||||||
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.TreeQueryRequest.Response
public static class TreeQueryRequest.Response
TreeQueryRequest Response type
Nested Class Summary | |
---|---|
class |
TreeQueryRequest.Response.ItemAnswerGroup
An "answer group" for items, even though there is only ever one per group. |
Field Summary |
---|
Fields inherited from class atg.search.routing.command.search.SearchResponse |
---|
CLASS_VERSION, mMultiPartitionSearch |
Fields inherited from interface atg.search.routing.command.search.PagedResponse |
---|
CLASS_VERSION |
Constructor Summary | |
---|---|
TreeQueryRequest.Response()
|
|
TreeQueryRequest.Response(atg.search.routing.command.SearchEngineResponse response)
|
|
TreeQueryRequest.Response(TreeQueryRequest 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)
Override to provide attributes. |
protected void |
getBodyXML(java.lang.StringBuilder buf)
Override to provide the body of the xml. |
java.lang.String |
getContentId()
content ID for index partition |
java.lang.String |
getDebug()
Returns debug information from the engine |
int |
getDocCandidates()
Number of document candidates considered during retrieval |
int |
getDocMax()
An estimate of how many documents are retrievable by the current query |
int |
getDocMin()
Minimum number of documents that could be considered, if all query terms were in the same documents |
atg.search.routing.command.search.DocSortCommon |
getDocSort()
Returns the docSort |
TreeQueryRequest.DocSortOrder |
getDocSortOrder()
Returns the doc sort order |
java.lang.String |
getDocSortProp()
Returns the doc sort property |
java.lang.String |
getDocSortPropDefault()
Returns the doc sort property default |
java.util.List<FieldResponse> |
getFields()
Returns input fields with additional information |
int |
getGroupCount()
total number of answer groups before paging. |
boolean |
getHasMoreResults()
Returns true if there are more results. |
java.util.List<Item> |
getItems()
The Items. |
int |
getPageNum()
Returns the zero-based page number of this response |
atg.search.routing.command.search.PageOffsetInfo |
getPageOffsetInfo()
If the response is the result of a merge, this holds the last response index per partition |
int |
getPageSize()
Returns the page size |
java.util.Collection |
getProcessedPartitionResponses()
Gets the processed the engine responses from individual partitions. |
java.lang.String |
getRequestTag()
Gets the xml element tag used in the request |
protected void |
merge(SearchRequest pRequest,
java.util.List<SearchResponse> pParsedResponses)
This is the Java merge. |
void |
setContentId(java.lang.String contentId)
Sets content ID for index partition |
void |
setDebug(java.lang.String pDebug)
Sets debug information from the engine |
void |
setDocCandidates(int docCandidates)
Sets the number of document candidates considered during retrieval |
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 |
setDocSort(atg.search.routing.command.search.DocSortCommon docSort)
Sets the docsort |
void |
setDocSortOrder(TreeQueryRequest.DocSortOrder docSortOrder)
Sets the doc sort order |
void |
setDocSortProp(java.lang.String docSortProp)
Sets the doc sort property |
void |
setDocSortPropDefault(java.lang.String docSortPropDefault)
Sets the doc sort property default |
void |
setFields(java.util.List<FieldResponse> pFields)
Sets input fields with additional information |
void |
setGroupCount(int groupCount)
Sets the total group count before paging. |
void |
setItems(java.util.List<Item> pItems)
Sets the items. |
void |
setPageNum(int pPageNum)
Sets the zero-based page number of this response |
void |
setPageOffsetInfo(atg.search.routing.command.search.PageOffsetInfo pageOffsetInfo)
Sets the page offset info |
void |
setPageSize(int pPageSize)
Sets the page size |
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, getDefaultXmlBytes, 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 TreeQueryRequest.Response()
public TreeQueryRequest.Response(atg.search.routing.command.SearchEngineResponse response)
public TreeQueryRequest.Response(TreeQueryRequest 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
Method Detail |
---|
public boolean equals(java.lang.Object pObject)
equals
in class java.lang.Object
protected void merge(SearchRequest pRequest, java.util.List<SearchResponse> pParsedResponses) throws atg.search.routing.MergeException
merge
in class SearchResponse
pRequest
- pParsedResponses
-
atg.search.routing.MergeException
- if the merge failspublic java.lang.String getRequestTag()
getRequestTag
in class atg.search.routing.command.SearchEngineCommandResponse
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
atg.search.routing.command.IncompleteCommandException
public java.util.Collection getProcessedPartitionResponses()
SearchEngineRequestImpl.setKeepingResponseData(boolean)
.
TreeQueryRequest.Response
, possibly empty but never null. Bad results
will have null elements in the collection.public java.lang.String getDebug()
public void setDebug(java.lang.String pDebug)
pDebug
- debug information from the enginepublic int getDocCandidates()
public void setDocCandidates(int docCandidates)
docCandidates
- number of document candidates considered during retrievalpublic int getDocMax()
public void setDocMax(int docMax)
docMax
- an estimate of how many documents are retrievable by the current querypublic int getDocMin()
public void setDocMin(int docMin)
docMin
- the minimum number of documents that could be considered, if all query terms were in the same documentspublic java.lang.String getContentId()
getContentId
in class SearchResponse
public void setContentId(java.lang.String contentId)
contentId
- content ID for index partitionpublic int getPageNum()
PagedResponse
getPageNum
in interface PagedResponse
public void setPageNum(int pPageNum)
PagedResponse
setPageNum
in interface PagedResponse
public int getPageSize()
PagedResponse
getPageSize
in interface PagedResponse
public void setPageSize(int pPageSize)
PagedResponse
setPageSize
in interface PagedResponse
public atg.search.routing.command.search.PageOffsetInfo getPageOffsetInfo()
PagedResponse
getPageOffsetInfo
in interface PagedResponse
public void setPageOffsetInfo(atg.search.routing.command.search.PageOffsetInfo pageOffsetInfo)
PagedResponse
setPageOffsetInfo
in interface PagedResponse
pageOffsetInfo
- page offset informationpublic int getGroupCount()
PagedResponse
getGroupCount
in interface PagedResponse
public boolean getHasMoreResults()
PagedResponse
getHasMoreResults
in interface PagedResponse
public void setGroupCount(int groupCount)
groupCount
- the total group count before paging.public java.util.List<Item> getItems()
public void setItems(java.util.List<Item> pItems)
pItems
- the itemspublic java.util.List<FieldResponse> getFields()
FieldResponse
public void setFields(java.util.List<FieldResponse> pFields)
pFields
- input fields with additional informationpublic atg.search.routing.command.search.DocSortCommon getDocSort()
public void setDocSort(atg.search.routing.command.search.DocSortCommon docSort)
docSort
- the docsortpublic java.lang.String getDocSortProp()
public void setDocSortProp(java.lang.String docSortProp)
docSortProp
- the doc sort propertypublic java.lang.String getDocSortPropDefault()
public void setDocSortPropDefault(java.lang.String docSortPropDefault)
docSortPropDefault
- the doc sort property defaultpublic TreeQueryRequest.DocSortOrder getDocSortOrder()
public void setDocSortOrder(TreeQueryRequest.DocSortOrder docSortOrder)
docSortOrder
- the doc sort order
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |