|
|||||||||
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.BrowseRequest.Response
public static class BrowseRequest.Response
Response type for BrowseRequest
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 | |
---|---|
BrowseRequest.Response()
default constructor for small response in reporting. |
|
BrowseRequest.Response(BrowseRequest pRequest,
java.util.List<SearchResponse> pParsedResponses)
This invokes local merge instead of the engine's merge. |
|
BrowseRequest.Response(atg.search.routing.command.SearchEngineResponse response)
Parses a singe search engine response |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object pObject)
Returns true if the response values are the same. |
BrowseRequest.AncestryType |
getAncestry()
Returns the ancestry type of the browsed document set |
protected void |
getAttributeXML(java.lang.StringBuilder buf)
This generates attribute xml. |
protected void |
getBodyXML(java.lang.StringBuilder buf)
Override to provide the body of the xml. |
Category |
getCategory()
Returns the result of the request, a browsed category |
java.lang.String |
getConstrainDocCounts()
Returns Maximum total size of document set that can have its constraint-based size computed. |
java.lang.String |
getContentId()
Returns the content ID of the index partition |
Diagnostics |
getDiagnostics()
Search diagnostic and trace output |
int |
getDocDepth()
Deprecated. in 9.1 |
atg.search.routing.command.search.DocSort |
getDocSort()
Returns the secondary sorting type |
atg.search.routing.command.search.DocSortOrder |
getDocSortOrder()
Returns the sort order of the result groups |
java.lang.String |
getDocSortPred()
If getDocSort() is DocSort.PREDICATE , returns the predicate expression to use for sorting |
java.lang.String |
getDocSortProp()
If getDocSort() is DocSort.STRPROP
or DocSort.NUMPROP , the name of the property to use for sorting |
java.lang.String |
getDocSortPropDefault()
If getDocSort() is DocSort.STRPROP
or DocSort.NUMPROP , returns the default
value for the property. |
DocSortPropVal |
getDocSortPropVal()
Returns the doc sort prop val. |
DocumentSetConstraint |
getDocumentSets()
Returns document constraint expression |
int |
getGroupCount()
Returns the number of answer groups before paging. |
boolean |
getHasMoreResults()
Returns true if there are more results for fast paging. |
int |
getMaxDepth()
Returns the maximum depth to browse from starting document set. |
int |
getMaxDescendentSets()
Deprecated. in 9.1 |
int |
getMaxDocs()
Deprecated. in 9.1 |
int |
getMaxDocsPerSet()
Deprecated. in 9.1 |
int |
getMaxSets()
Deprecated. in 9.1 |
int |
getMaxSize()
Deprecated. in 9.1 |
java.lang.String |
getMergeSettings()
Returns the result list controls for merge in a big string of the form paramVal,paramVal,... |
int |
getMinSize()
Deprecated. in 9.1. |
int |
getPageNum()
Returns the zero-based page number |
atg.search.routing.command.search.PageOffsetInfo |
getPageOffsetInfo()
When fast paging is used, and ff the response is the result of a merge, this holds the last response index per partition, in the form contentID:offset;contentID:offset;... |
int |
getPageSize()
Returns number of index items per page. |
java.lang.String |
getParent()
Returns the parent of input document set |
java.util.List<ProcessedResponse> |
getProcessedPartitionResponses()
Gets the processed the engine responses from individual partitions. |
BrowseRequest.RecurseDocumentsType |
getRecurseDocuments()
Returns whether returned documents can be from descendents of a returned set |
java.lang.String |
getRefineConfig()
Returns the refinement config name |
java.lang.String |
getRefineDebug()
Returns whether refine debugging is enabled |
int |
getRefineMax()
Returns the maximum number of refinements |
int |
getRefineMin()
Returns minimum size of a refinement (in terms of values) |
int |
getRefineMinVal()
Returns minimum number of refinement values |
int |
getRefineTop()
Returns number of values to return per refinement |
java.lang.String |
getRequestTag()
Gets the xml element tag used in the request |
java.lang.String |
getResponseNumberSettings()
Returns the result list controls in a big string of the form paramVal,paramVal,... |
BrowseRequest.SetSort |
getSetSort()
Returns descendent document set sort order |
BrowseRequest.Sorting |
getSorting()
Returns the sorting (grouping) that was used |
java.lang.String |
getSortProp()
Returns the sort property that was used. |
java.lang.String |
getStartCategory()
Returns the starting category (document set) used in the request |
int |
hashCode()
|
boolean |
isDocSortCase()
Returns the doc sort case indicator |
protected void |
merge(SearchRequest pSearchRequest,
java.util.List<SearchResponse> pParsedResponses)
This is Java merge. |
void |
setAncestry(BrowseRequest.AncestryType ancestry)
Sets the ancestry |
void |
setCategory(Category category)
Sets the category |
void |
setConstrainDocCounts(java.lang.String constrainDocCounts)
Sets the constrainDocCounts |
void |
setContentId(java.lang.String contentId)
Sets the content ID for index partition |
void |
setDiagnostics(Diagnostics pDiagnostics)
Sets Search diagnostic and trace output |
void |
setDocSort(atg.search.routing.command.search.DocSort docSort)
Sets the type of secondary sorting |
void |
setDocSortCase(boolean pDocSortCase)
Sets the doc sort case indicator |
void |
setDocSortOrder(atg.search.routing.command.search.DocSortOrder docSortOrder)
Sets the sort order of the answer groups |
void |
setDocSortPred(java.lang.String docSortPred)
Sets the predicate |
void |
setDocSortProp(java.lang.String docSortProp)
Sets the name of the property to use for searching |
void |
setDocSortPropDefault(java.lang.String docSortPropDefault)
Sets the docSortPropDefault |
void |
setDocSortPropVal(DocSortPropVal pDocSortPropVal)
Sets doc sort prop val |
void |
setDocumentSets(DocumentSetConstraint documentSets)
Sets document constraint expression |
void |
setMaxDepth(int maxDepth)
Sets maximum depth to browse from starting document set. |
void |
setMergeSettings(java.lang.String pMergeSettings)
Sets the result list controls for merge in a big string of the form paramVal,paramVal,... |
void |
setPageNum(int pageNum)
Sets zero-based page number |
void |
setPageOffsetInfo(atg.search.routing.command.search.PageOffsetInfo pageOffsetInfo)
Sets page offset info |
void |
setPageSize(int pageSize)
Number of index items per page. |
void |
setParent(java.lang.String parent)
Sets parent of input document set |
void |
setRecurseDocuments(BrowseRequest.RecurseDocumentsType recurseDocuments)
Indicates whether returned documents can be from descendents of a returned set |
void |
setRefineConfig(java.lang.String pRefineConfig)
Sets the refinement config name |
void |
setRefineDebug(java.lang.String pRefineDebug)
Sets refine debugging |
void |
setRefineMax(int refineMax)
Sets refine max |
void |
setRefineMin(int refineMin)
Sets the minimum size of a refinement (in terms of values) |
void |
setRefineMinVal(int refineMinVal)
Sets the minimum number of refinement values |
void |
setRefineTop(int refineTop)
Sets the number of values to return per refinement |
void |
setResponseNumberSettings(java.lang.String responseNumSettings)
Sets the result list controls in a big string of the form paramVal,paramVal,... |
void |
setSetSort(BrowseRequest.SetSort setSort)
Sets Descendent document set sort order |
void |
setSorting(BrowseRequest.Sorting sorting)
Sets sorting |
void |
setSortProp(java.lang.String sortProp)
Sets the sort property that was used |
void |
setStartCategory(java.lang.String startingCategory)
Sets the start category used in the request |
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, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public BrowseRequest.Response(BrowseRequest 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 BrowseRequest.Response(atg.search.routing.command.SearchEngineResponse response)
response
- from an enginepublic BrowseRequest.Response()
Method Detail |
---|
public boolean equals(java.lang.Object pObject)
equals
in class java.lang.Object
pObject
- another BrowseRequest.Response
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String getRequestTag()
getRequestTag
in class atg.search.routing.command.SearchEngineCommandResponse
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.util.List<ProcessedResponse> getProcessedPartitionResponses()
SearchEngineRequest.setKeepingResponseData(boolean)
with true.
BrowseRequest.Response
, possibly empty but never null.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 buffer
atg.search.routing.command.IncompleteCommandException
public Diagnostics getDiagnostics()
public void setDiagnostics(Diagnostics pDiagnostics)
pDiagnostics
- Search diagnostic and trace outputpublic Category getCategory()
public void setCategory(Category category)
category
- public BrowseRequest.Sorting getSorting()
public void setSorting(BrowseRequest.Sorting sorting)
sorting
- public java.lang.String getSortProp()
public void setSortProp(java.lang.String sortProp)
sortProp
- public java.lang.String getContentId()
getContentId
in class SearchResponse
public void setContentId(java.lang.String contentId)
contentId
- content ID for index partitionpublic BrowseRequest.AncestryType getAncestry()
public void setAncestry(BrowseRequest.AncestryType ancestry)
ancestry
- public int getMaxDepth()
public void setMaxDepth(int maxDepth)
maxDepth
- public int getMaxSets()
public int getMaxSize()
public int getMinSize()
public boolean isDocSortCase()
public void setDocSortCase(boolean pDocSortCase)
pDocSortCase
- docSortCasepublic int getMaxDescendentSets()
public int getMaxDocs()
public int getMaxDocsPerSet()
public int getDocDepth()
public java.lang.String getConstrainDocCounts()
public void setConstrainDocCounts(java.lang.String constrainDocCounts)
constrainDocCounts
- public BrowseRequest.SetSort getSetSort()
public void setSetSort(BrowseRequest.SetSort setSort)
setSort
- Descendent document set sort orderpublic BrowseRequest.RecurseDocumentsType getRecurseDocuments()
public void setRecurseDocuments(BrowseRequest.RecurseDocumentsType recurseDocuments)
recurseDocuments
- Whether returned documents can be from descendents of a returned setpublic void setResponseNumberSettings(java.lang.String responseNumSettings)
responseNumSettings
- holds the result list controls in a big string of the form paramVal,paramVal,...public java.lang.String getResponseNumberSettings()
public void setMergeSettings(java.lang.String pMergeSettings)
pMergeSettings
- holds the result list controls for merge in a big string of the form paramVal,paramVal,...public java.lang.String getMergeSettings()
public java.lang.String getParent()
public void setParent(java.lang.String parent)
parent
- the parentpublic java.lang.String getRefineConfig()
public void setRefineConfig(java.lang.String pRefineConfig)
pRefineConfig
- refinement config namepublic int getRefineMax()
public void setRefineMax(int refineMax)
refineMax
- public int getRefineMin()
public void setRefineMin(int refineMin)
refineMin
- public int getRefineMinVal()
public void setRefineMinVal(int refineMinVal)
refineMinVal
- minimum number of refinement valuespublic java.lang.String getRefineDebug()
public void setRefineDebug(java.lang.String pRefineDebug)
pRefineDebug
- public int getRefineTop()
public void setRefineTop(int refineTop)
refineTop
- public int getPageNum()
getPageNum
in interface PagedResponse
public void setPageNum(int pageNum)
setPageNum
in interface PagedResponse
pageNum
- zero-based page numberpublic int getPageSize()
getPageSize
in interface PagedResponse
public void setPageSize(int pageSize)
setPageSize
in interface PagedResponse
pageSize
- public int getGroupCount()
getSorting()
)
with a multi-partition index, note that the group count may not reflect the actual number of results
returned.
getGroupCount
in interface PagedResponse
public boolean getHasMoreResults()
getHasMoreResults
in interface PagedResponse
public atg.search.routing.command.search.DocSort getDocSort()
public void setDocSort(atg.search.routing.command.search.DocSort docSort)
docSort
- public java.lang.String getDocSortPred()
getDocSort()
is DocSort.PREDICATE
, returns the predicate expression to use for sorting
public void setDocSortPred(java.lang.String docSortPred)
docSortPred
- public java.lang.String getDocSortProp()
getDocSort()
is DocSort.STRPROP
or DocSort.NUMPROP
, the name of the property to use for sorting
public void setDocSortProp(java.lang.String docSortProp)
docSortProp
- public DocSortPropVal getDocSortPropVal()
public void setDocSortPropVal(DocSortPropVal pDocSortPropVal)
pDocSortPropVal
- public java.lang.String getDocSortPropDefault()
getDocSort()
is DocSort.STRPROP
or DocSort.NUMPROP
, returns the default
value for the property.
getDocSort()
is DocSort.STRPROP
or DocSort.NUMPROP
, the default
value for the propertypublic 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 atg.search.routing.command.search.PageOffsetInfo getPageOffsetInfo()
getPageOffsetInfo
in interface PagedResponse
public void setPageOffsetInfo(atg.search.routing.command.search.PageOffsetInfo pageOffsetInfo)
setPageOffsetInfo
in interface PagedResponse
pageOffsetInfo
- public java.lang.String getStartCategory()
public void setStartCategory(java.lang.String startingCategory)
startingCategory
- public DocumentSetConstraint getDocumentSets()
public void setDocumentSets(DocumentSetConstraint documentSets)
documentSets
- Document constraint expression
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |