|
|||||||||
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.SearchEngineRequestImpl atg.search.routing.command.search.SearchRequest atg.search.routing.command.search.TreeQueryRequest
public class TreeQueryRequest
Tree query request. This query is not cacheable, and only supports local merge.
Required: Fields
Optional: Everything else
Nested Class Summary | |
---|---|
static class |
TreeQueryRequest.Response
TreeQueryRequest Response type |
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
protected static Field[] |
EMPTY_FIELD_ARRAY
|
Fields inherited from class atg.search.routing.command.search.SearchRequest |
---|
BROWSE, CACHEABLE, CATEGORIZE, EMPTY_ARRAY, ENV, ID, INSPECT, LIST_PROPERTY_ALLOWED, LISTABLE_PROPERTIES, LOCAL_MERGE, LOCAL_MERGE_DEBUG, LOG_THIS_REQUEST, mDebug, mListableProperties, mListPropertyAllowed, mLocalMergeDebugEnabled, mLocalMergeDebugReady, mLocalMergeEnabled, mMergeSettings, mMultiPartitionSearch, mRequestIdentifier, MsInNs, mSleepTimeMs, mTargets, mTimeLimitMs, MULTI_PARTITION, MULTI_SEARCH_SESSION, mVersion, QUERY, RESP_FORM, SAVE_REQUEST, SIMILARDOCS, SITE_CONSTR, SITE_ID, SLEEP_TIME_MS, STRUCTQUERY, TAGS, TIME, TIME_LIMIT_MS, TREEQUERY, TYPEAHEAD, VERSION, VIC |
Fields inherited from interface atg.search.routing.command.search.PagedRequest |
---|
ORIG_PAGE_SIZE, PAGE_NUM, PAGE_OFFSET_INFO, PAGE_SIZE |
Constructor Summary | |
---|---|
TreeQueryRequest()
|
Method Summary | |
---|---|
SearchResponse |
doMerge(java.util.List<SearchResponse> pParsedResponses)
Executes the merge. |
protected static TreeQueryRequest |
fromXml(atg.search.routing.utils.SearchMessageParser xml,
SearchRequest compRequest)
|
protected void |
getAttributeXML(java.lang.StringBuilder buf)
|
protected void |
getBodyXML(java.lang.StringBuilder buf)
|
java.lang.String[] |
getDocProps()
list of docprops |
java.lang.String |
getDocPropsString()
returns a comma-delimited list of docprops. |
atg.search.routing.command.search.DocSort |
getDocSort()
ATG Search returns a list of result groups in its response. |
atg.search.routing.command.search.DocSortOrder |
getDocSortOrder()
Returns whether the sort is ascending or descending, either alphabetically or numerically, depending on the sort mode. |
java.lang.String |
getDocSortProp()
the property name to use for the strprop or intprop or floatprop modes |
java.lang.String |
getDocSortPropDefault()
doc sort property default |
java.lang.Boolean |
getFastPaging()
Fast paging never returns more than is required for a given page. |
Field[] |
getFields()
Returns a non-null, but possibly empty, array of fields. |
Field |
getFields(int pIndex)
Indexed getter that can be called for any index, even if out of bounds. |
java.lang.Integer |
getMaxFilter()
Returns the maximum number of results that the engine will consider. |
java.lang.Integer |
getMaxResults()
Maximum number of results to return |
java.lang.Integer |
getPageNum()
The page number being requested, starting at 0. |
atg.search.routing.command.search.PageOffsetInfo |
getPageOffsetInfo()
Returns the page offset information. |
java.lang.Integer |
getPageSize()
Returns the max number of results that should appear on a page |
int |
getRequestId()
the constant request id for this type of request. |
boolean |
isLocalMergeEnabled()
This method always returns true for this type of request |
SearchResponse |
processSearchResponse(atg.search.routing.command.SearchEngineResponse response)
processes the search engine response. |
void |
setDocProps(java.lang.String[] docProps)
ATG Search returns the meta-data properties associated with the index item of each statement result. |
void |
setDocPropsString(java.lang.String docProps)
accepts a comma-delimited list of docProps |
void |
setDocSort(atg.search.routing.command.search.DocSort pDocSort)
ATG Search returns a list of result groups in its response. |
void |
setDocSortOrder(atg.search.routing.command.search.DocSortOrder docSortOrder)
Sets whether the sort is ascending or descending, either alphabetically or numerically, depending on the sort mode. |
void |
setDocSortProp(java.lang.String docSortProp)
Index items that don't have this property will be excluded from the sort. |
void |
setDocSortPropDefault(java.lang.String docSortPropDefault)
the default property value to use when the property is missing. |
void |
setFastPaging(java.lang.Boolean pFastPaging)
Fast paging never returns more than is required for a given page. |
void |
setFields(Field[] pFields)
Sets the fields for the request |
void |
setFields(int pIndex,
Field pStatement)
Indexed setter that automatically grows the underlying array for any index value. |
void |
setMaxFilter(java.lang.Integer pMaxFilter)
Controls the maximum number of results that the engine will consider. |
void |
setMaxResults(java.lang.Integer pMaxResults)
Sets the maximum number of results to return |
void |
setPageNum(java.lang.Integer pageNum)
For efficiency, most search sites return results a page at a time, forcing the end-user to request additional results if necessary. |
void |
setPageOffsetInfo(atg.search.routing.command.search.PageOffsetInfo pPageOffsetInfo)
Sets the page offset information. |
void |
setPageSize(java.lang.Integer pageSize)
For efficiency, most search sites return results a page at a time, forcing the end-user to request additional results if necessary. |
static TreeQueryRequest |
valueOf(java.lang.String pRequestXml)
Converts XML into a QueryRequest |
static TreeQueryRequest |
valueOf(java.lang.String pRequestXml,
SearchRequest compRequest)
Converts an xml string into a TreeQueryRequest |
Methods inherited from class atg.search.routing.command.SearchEngineRequestImpl |
---|
encodeMapData, isFiringSearchEvents, isKeepingResponseData, isLoggingThisRequest, setFiringSearchEvents, setKeepingResponseData, setLoggingThisRequest |
Methods inherited from class atg.search.routing.command.SearchXMLObject |
---|
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toString, toXML, toXML |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface atg.search.routing.command.SearchEngineRequest |
---|
toXML |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
protected static Field[] EMPTY_FIELD_ARRAY
Constructor Detail |
---|
public TreeQueryRequest()
Method Detail |
---|
public boolean isLocalMergeEnabled()
isLocalMergeEnabled
in class SearchRequest
public Field[] getFields()
getFields(int)
public void setFields(Field[] pFields)
pFields
- array of fieldssetFields(int, Field)
public void setFields(int pIndex, Field pStatement)
pStatement
- a statementpublic Field getFields(int pIndex)
pIndex
-
public void setMaxResults(java.lang.Integer pMaxResults)
pMaxResults
- maximum number of results to returnpublic java.lang.Integer getMaxResults()
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 static TreeQueryRequest valueOf(java.lang.String pRequestXml)
pRequestXml
- query request XML
public static TreeQueryRequest valueOf(java.lang.String pRequestXml, SearchRequest compRequest)
pRequestXml
- TreeQuery xmlcompRequest
- an existing (TreeQuery) request object to combine with the provide xml, typically
initalized as a nucleus component
protected static TreeQueryRequest fromXml(atg.search.routing.utils.SearchMessageParser xml, SearchRequest compRequest)
public java.lang.Integer getMaxFilter()
public void setMaxFilter(java.lang.Integer pMaxFilter)
pMaxFilter
- max filterpublic atg.search.routing.command.search.DocSort getDocSort()
setDocSort(atg.search.routing.command.search.DocSort)
, setDocSortOrder(atg.search.routing.command.search.DocSortOrder)
, setDocSortProp(java.lang.String)
, setDocSortPropDefault(java.lang.String)
.
public void setDocSort(atg.search.routing.command.search.DocSort pDocSort)
setDocSort(atg.search.routing.command.search.DocSort)
, setDocSortOrder(atg.search.routing.command.search.DocSortOrder)
, setDocSortProp(java.lang.String)
, setDocSortPropDefault(java.lang.String)
.
pDocSort
- doc sortpublic java.lang.String[] getDocProps()
setDocProps(String[])
public void setDocProps(java.lang.String[] docProps)
docProps
- Can be "all", which indicates that all properties are returned.
By default no properties are returned. In general, it is a list of the property names
that can be returned.public void setDocPropsString(java.lang.String docProps)
docProps
- comma-delimited list of docpropssetDocProps(String[])
public java.lang.String getDocPropsString()
getDocProps()
public atg.search.routing.command.search.DocSortOrder getDocSortOrder()
public void setDocSortOrder(atg.search.routing.command.search.DocSortOrder docSortOrder)
docSortOrder
- determines whether the sort is ascending or descending, either alphabetically or numerically, depending on the sort mode.public java.lang.String getDocSortProp()
public void setDocSortProp(java.lang.String docSortProp)
setDocSortPropDefault(java.lang.String)
can specify the default property value to use for these exceptional cases. The default value should agree with the type of the property.
docSortProp
- specifies the property name to use for the strprop or intprop or floatprop modes.public java.lang.String getDocSortPropDefault()
public void setDocSortPropDefault(java.lang.String docSortPropDefault)
docSortPropDefault
- the default property value to use when the property is missing.public void setPageOffsetInfo(atg.search.routing.command.search.PageOffsetInfo pPageOffsetInfo)
setPageOffsetInfo
in interface PagedRequest
pPageOffsetInfo
- page offset informationpublic atg.search.routing.command.search.PageOffsetInfo getPageOffsetInfo()
getPageOffsetInfo
in interface PagedRequest
public java.lang.Boolean getFastPaging()
getFastPaging
in interface PagedRequest
public void setFastPaging(java.lang.Boolean pFastPaging)
setFastPaging
in interface PagedRequest
pFastPaging
- true to enable fast pagingpublic java.lang.Integer getPageSize()
getPageSize
in interface PagedRequest
public void setPageSize(java.lang.Integer pageSize)
setPageSize
in interface PagedRequest
pageSize
- specifies the size of the pagepublic java.lang.Integer getPageNum()
getPageNum
in interface PagedRequest
public void setPageNum(java.lang.Integer pageNum)
setPageNum(Integer)
and setPageSize(Integer)
.
setPageNum
in interface PagedRequest
pageNum
- specifies which page number to return, starting from the first page 0 and so on.public int getRequestId()
getRequestId
in class SearchRequest
public SearchResponse processSearchResponse(atg.search.routing.command.SearchEngineResponse response) throws atg.search.routing.command.RoutingCommandException
processSearchResponse
in class SearchRequest
response
-
atg.search.routing.command.RoutingCommandException
SearchRequest.processResponse(atg.search.routing.command.SearchEngineResponse)
public SearchResponse doMerge(java.util.List<SearchResponse> pParsedResponses) throws atg.search.routing.MergeException
doMerge
in class SearchRequest
pParsedResponses
-
atg.search.routing.MergeException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |