|
|||||||||
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.BrowseRequest
public class BrowseRequest
The Browse request is returns the elements of a browsed document set or topic.
Required: StartCategory setStartCategory(java.lang.String)
Nested Class Summary | |
---|---|
static class |
BrowseRequest.AncestryType
A value of direct means that the parent and direct ancestors of the starting item set will be returned. |
static class |
BrowseRequest.RecurseDocumentsType
A mode value of on means that index items may be collected from child item sets. |
static class |
BrowseRequest.Response
Response type for BrowseRequest |
static class |
BrowseRequest.SetSort
The sort value deterimes the sort order of the descendent sets. |
static class |
BrowseRequest.Sorting
Sorting (grouping) for results. |
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Fields inherited from class atg.search.routing.command.search.SearchRequest |
---|
BROWSE, CACHEABLE, CATEGORIZE, DEBUG, 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 |
Constructor Summary | |
---|---|
BrowseRequest()
|
Method Summary | |
---|---|
protected SearchResponse |
doMerge(java.util.List<SearchResponse> pParsedResponses)
Executes the local merge on the incoming responses |
protected static BrowseRequest |
fromXml(atg.search.routing.utils.SearchMessageParser xml,
SearchRequest compRequest)
|
BrowseRequest.AncestryType |
getAncestry()
Returns the ancestry type |
protected void |
getAttributeXML(java.lang.StringBuilder buf)
|
protected void |
getBodyXML(java.lang.StringBuilder buf)
Override to provide the body of the xml. |
java.lang.String |
getConstrainDocCounts()
Returns true, false, or a non-negative integer string. |
java.lang.Integer |
getDocDepth()
Deprecated. in 9.1 |
java.lang.String[] |
getDocFlags()
Returns a non-null array of doc flags that determine how much doc information is included in the response |
java.lang.String |
getDocFlagsString()
Returns a comma-delimited list of doc flags |
java.lang.String[] |
getDocProps()
Returns a non-null array of docprops |
java.lang.String |
getDocPropsString()
Returns the getDocProps() array as a comma-delimited string |
atg.search.routing.command.search.DocSort |
getDocSort()
|
java.lang.Boolean |
getDocSortCase()
Returns the case-sensitivity for string-based docSort modes, e.g. |
atg.search.routing.command.search.DocSortOrder |
getDocSortOrder()
Returns the doc sort order, which determines whether the sort is ascending or descending, either alphabetically or numerically, depending on the sort mode |
java.lang.String |
getDocSortPred()
Returns the predicate expression to use for sorting when getDocSort() is predicate |
java.lang.String |
getDocSortProp()
Returns the property name to use for the strprop or numprop modes |
java.lang.String |
getDocSortPropDefault()
Returns the default doc sort property value to use when the property is missing |
DocSortPropVal |
getDocSortPropVal()
When sorting by property value, this parameter determines how the value of the property is selected when the property has multiple values. |
DocumentSetConstraint |
getDocumentSetConstraints()
Returns Document constraint expression |
java.lang.Boolean |
getFastPaging()
Fast paging never returns more than is required for a given page. |
java.lang.Float |
getIntersectMax()
Returns percent of total collection that is too large to intersect for optimization |
java.lang.String |
getLocale()
Returns a string representing the locale with which the query results will be sorted. |
java.lang.Integer |
getMaxDepth()
Returns maximum depth from the starting item set that can be returned. |
java.lang.Integer |
getMaxDescendentSets()
Deprecated. in 9.1. |
java.lang.Integer |
getMaxDocs()
Deprecated. in 9.1 |
java.lang.Integer |
getMaxDocsPerSet()
Deprecated. in 9.1 |
java.lang.Integer |
getMaxRelatedSets()
|
java.lang.Integer |
getMaxSets()
Deprecated. in 9.1 |
java.lang.Integer |
getMaxSize()
Deprecated. in 9.1 |
java.lang.Integer |
getMinSize()
Deprecated. in 9.1 |
java.lang.Integer |
getPageNum()
Returns the 0-based page number that this request should retrieve |
atg.search.routing.command.search.PageOffsetInfo |
getPageOffsetInfo()
Returns page offset info |
java.lang.Integer |
getPageSize()
Returns the size of the page for the request |
ParserOptions |
getParserOptions()
Returns text processing options |
java.lang.String |
getRankConfig()
Return the name of the ranking configuration. |
java.lang.String |
getRankConfigXml()
|
java.lang.Boolean |
getRankPreferVar()
Indicates whether variables that map to weights in a property prioritization should be preferred over an explicit property value. |
BrowseRequest.RecurseDocumentsType |
getRecurseDocuments()
|
java.lang.String |
getRefineConfig()
Returns the name of refinement configuration to use |
java.lang.String |
getRefineConfigXml()
|
DocumentSetConstraint |
getRefineConstraints()
Returns document set constraints |
RefineCountType |
getRefineCount()
Returns the refinement value counting mode |
java.lang.Integer |
getRefineMax()
Returns the maximum number of refinement properties to return, even if the refinement configuration could generate more. |
java.lang.Integer |
getRefineMin()
Returns the minimum size of a refinement property value, in terms of the number of index items with that value |
java.lang.Integer |
getRefineMinVal()
Returns the minimum number of refinement property values |
java.lang.Integer |
getRefineTop()
Refinement values are selected in sort order, which usually is in terms of the number of index items that has each value. |
java.lang.String[] |
getRelatedSets()
Returns a list of document sets, which form a constraint on the returned related sets to return. |
java.lang.String |
getRelatedSetsString()
Returns a comma-delimited list of related sets. |
int |
getRequestId()
Returns the type of request |
java.util.Map |
getResponseNumberSettings()
Returns the response number settings map |
java.lang.String |
getResponseNumberSettingsString()
Returns the result list controls in a big string of the form paramVal,paramVal,... |
BrowseRequest.SetSort |
getSetSort()
Returns the sort order of the descendent sets. |
BrowseRequest.Sorting |
getSorting()
Returns the sorting (grouping) for the final statement results |
java.lang.String |
getSortProperty()
Returns the sort property. |
java.lang.String |
getStartCategory()
|
java.lang.Integer |
getTargetDocs()
Returns the desired number of items to retrieve based on intersection optimizations |
java.lang.String[] |
getTextProps()
Returns a non-null array of text fields that controls how much of the meta-data of the response's document is returned |
java.lang.String |
getTextPropsString()
Returns a comma-delimited list of text properties |
protected SearchResponse |
processSearchResponse(atg.search.routing.command.SearchEngineResponse response)
Processes an engine response |
void |
setAncestry(BrowseRequest.AncestryType ancestry)
Normally, the browse response consists of only information about what is below the starting item set, i.e. |
void |
setConstrainDocCounts(java.lang.String constrainDocCounts)
The browse algorithm begins at the starting item set, and recursively descends to its children and their children. |
void |
setDocDepth(java.lang.Integer docDepth)
Deprecated. in 9.1 |
void |
setDocFlags(java.lang.String[] pDocFlags)
Controls how much document information is returned. |
void |
setDocFlagsString(java.lang.String pDocFlags)
Accepts a comma-delimited list of doc flags. |
void |
setDocProps(java.lang.String[] docProps)
ATG Search returns the meta-data properties associated with the browsed index item. |
void |
setDocPropsString(java.lang.String docProps)
accepts a comma-delimited list of docProps, which is then converted into an array (see setDocProps(String[]) . |
void |
setDocSort(atg.search.routing.command.search.DocSort docSort)
Each returned item set may contain index items, depending on the other search parameters. |
void |
setDocSortCase(java.lang.Boolean pDocSortCase)
Sets case-sensitivity for string-based docSort modes, e.g. |
void |
setDocSortOrder(atg.search.routing.command.search.DocSortOrder docSortOrder)
Each returned item set may contain index items, depending on the other search parameters. |
void |
setDocSortPred(java.lang.String docSortPred)
If getDocSort() is predicate, the predicate expression to use for sorting |
void |
setDocSortProp(java.lang.String docSortProp)
Each returned item set may contain index items, depending on the other search parameters. |
void |
setDocSortPropDefault(java.lang.String docSortPropDefault)
Sets the default doc sort property value to use when the property is missing. |
void |
setDocSortPropVal(DocSortPropVal pDocSortPropVal)
When sorting by property value, this parameter determines how the value of the property is selected when the property has multiple values. |
void |
setDocumentSetConstraints(DocumentSetConstraint documentSetConstraints)
Sets document set constraints |
void |
setFastPaging(java.lang.Boolean pFastPaging)
Fast paging never returns more than is required for a given page. |
void |
setIntersectMax(java.lang.Float intersectMax)
Sets percent of total collection that is too large to intersect for optimization |
void |
setLocale(java.lang.String pLocale)
Sets a string representing the locale with which the query results will be sorted. |
void |
setMaxDepth(java.lang.Integer maxDepth)
The browse algorithm begins at the starting item set, and recursively descends to its children and their children. |
void |
setMaxDescendentSets(java.lang.Integer maxDescendentSets)
Deprecated. in 9.1 |
void |
setMaxDocs(java.lang.Integer maxDocs)
Deprecated. in 9.1 |
void |
setMaxDocsPerSet(java.lang.Integer maxDocsPerSet)
Deprecated. in 9.1 |
void |
setMaxRelatedSets(java.lang.Integer maxRelatedSets)
ATG Search returns the retrieved index items along with the item sets. |
void |
setMaxSets(java.lang.Integer maxSets)
Deprecated. 9.1 |
void |
setMaxSize(java.lang.Integer maxSize)
Deprecated. in 9.1. |
void |
setMinSize(java.lang.Integer minSize)
Deprecated. in 9.1. |
void |
setPageNum(java.lang.Integer pageNum)
The browse algorithm begins at the starting item set, and recursively descends to its children and their children. |
void |
setPageOffsetInfo(atg.search.routing.command.search.PageOffsetInfo pPageOffsetInfo)
Sets the page offset information, which is used internally to manage fast paging for multiple partitions. |
void |
setPageSize(java.lang.Integer pageSize)
The browse algorithm begins at the starting item set, and recursively descends to its children and their children. |
void |
setParserOptions(ParserOptions parserOptions)
Sets text processing options |
void |
setRankConfig(java.lang.String rankConfig)
Sets the name of the ranking configuration |
void |
setRankConfigXml(java.lang.String pRankConfigXml)
Call this to provide full rankConfig XML for this request. |
void |
setRankPreferVar(java.lang.Boolean pRankPreferVar)
Sets whether variables that map to weights in a property prioritization should be preferred over an explicit property value. |
void |
setRecurseDocuments(BrowseRequest.RecurseDocumentsType recurseDocuments)
The browse algorithm begins at the starting item set, and recursively descends to its children and their children. |
void |
setRefineConfig(java.lang.String refineConfig)
Sets the name of refinement configuration to use |
void |
setRefineConfigXml(java.lang.String pRefineConfigXml)
Call this to provide full refineConfig XML for this request. |
void |
setRefineConstraints(DocumentSetConstraint pRefineConstraints)
Sets refinement constraints |
void |
setRefineCount(RefineCountType pRefineCount)
Sets the refinement value counting mode |
void |
setRefineMax(java.lang.Integer refineMax)
ATG Search can calculate refinements based on the query results, in order to offer the end-user a quick way of narrowing the search. |
void |
setRefineMin(java.lang.Integer refineMin)
ATG Search can calculate refinements based on the query results, in order to offer the end-user a quick way of narrowing the search. |
void |
setRefineMinVal(java.lang.Integer refineMinVal)
ATG Search can calculate refinements based on the query results, in order to offer the end-user a quick way of narrowing the search. |
void |
setRefineTop(java.lang.Integer refineTop)
ATG Search can calculate refinements based on the query results, in order to offer the end-user a quick way of narrowing the search. |
void |
setRelatedSets(java.lang.String[] relatedSets)
ATG Search returns the retrieved documents along with the statement results. |
void |
setRelatedSetsString(java.lang.String pRelSets)
accepts a comma-delimited list of related sets |
void |
setResponseNumberSettings(java.util.Map pResponseNumberSettingsMap)
Sets the response number settings map |
void |
setResponseNumberSettingsString(java.lang.String responseNumberSettings)
Sets the result list controls in a big string of the form paramVal,paramVal,... |
void |
setSetSort(BrowseRequest.SetSort setSort)
The browse request returns the descendents of the starting item set and possibly descendents of these children sets, and so on. |
void |
setSorting(BrowseRequest.Sorting sorting)
ATG Search has two algorithms to group the final statement results: group-by-document and group-by-property. |
void |
setSortProperty(java.lang.String sortProperty)
Sets the sort propert. |
void |
setStartCategory(java.lang.String startingCategory)
|
void |
setTargetDocs(java.lang.Integer targetDocs)
Sets the desired number of items to retrieve based on intersection optimizations |
void |
setTextProps(java.lang.String[] pTextProps)
Sets an array of text fields (such as role:displayName) that controls how much of the meta-data of the response's document is returned |
void |
setTextPropsString(java.lang.String pTextProps)
Sets a comma-delimited list of text properties |
static BrowseRequest |
valueOf(java.lang.String pRequestXml)
Converts an xml string into a BrowseRequest |
static BrowseRequest |
valueOf(java.lang.String pRequestXml,
SearchRequest compRequest)
Converts an xml string into a BrowseRequest |
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
Constructor Detail |
---|
public BrowseRequest()
Method Detail |
---|
public void setPageOffsetInfo(atg.search.routing.command.search.PageOffsetInfo pPageOffsetInfo)
PagedRequest
setPageOffsetInfo
in interface PagedRequest
pPageOffsetInfo
- page offset infopublic atg.search.routing.command.search.PageOffsetInfo getPageOffsetInfo()
getPageOffsetInfo
in interface PagedRequest
public java.lang.String getStartCategory()
public void setStartCategory(java.lang.String startingCategory)
startingCategory
- Starting document set(s) for browsing. If more than one is provided, the syntax is /path//path//path...public java.lang.String getRankConfigXml()
public void setRankConfigXml(java.lang.String pRankConfigXml)
setRankConfig(String)
which
only specifies the rankConfig name to use and requires that it be in the index.
pRankConfigXml
- well-formed rankConfig XML that starts with <rankConfig>
.public java.lang.String getRefineConfigXml()
public void setRefineConfigXml(java.lang.String pRefineConfigXml)
setRefineConfig(String)
which only specifies the refineConfig name to use and requires that it be in the index.
pRefineConfigXml
- well-formed refineConfig XML that starts with <refineConfig>
.public ParserOptions getParserOptions()
public void setParserOptions(ParserOptions parserOptions)
parserOptions
- Text processing optionspublic DocumentSetConstraint getDocumentSetConstraints()
public void setDocumentSetConstraints(DocumentSetConstraint documentSetConstraints)
documentSetConstraints
- Document constraint expressionpublic DocumentSetConstraint getRefineConstraints()
public void setRefineConstraints(DocumentSetConstraint pRefineConstraints)
pRefineConstraints
- document set constraintsprotected 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 BrowseRequest.Sorting getSorting()
public void setSorting(BrowseRequest.Sorting sorting)
sorting
- can either be document, for the group-by-document algorithm. or property,
for group by property. For group-by-property, use the setSortProperty(String)
to specify the property value.public java.lang.String getSortProperty()
public void setSortProperty(java.lang.String sortProperty)
sortProperty
- sort propertypublic java.lang.String getLocale()
public void setLocale(java.lang.String pLocale)
pLocale
- the desired locale for governing the sort of resultspublic java.lang.String getRankConfig()
public void setRankConfig(java.lang.String rankConfig)
rankConfig
- Name of ranking configuration to usepublic java.lang.Boolean getRankPreferVar()
public void setRankPreferVar(java.lang.Boolean pRankPreferVar)
pRankPreferVar
- enables or disables preference for variablespublic java.lang.String getRefineConfig()
public void setRefineConfig(java.lang.String refineConfig)
refineConfig
- Name of refinement configuration to usepublic java.lang.Integer getRefineMax()
public void setRefineMax(java.lang.Integer refineMax)
refineMax
- The maximum number of refinement properties to return, even if the refinement configuration could generate more.
The default value for max is 0, which means no refinement calculation will be made.public BrowseRequest.RecurseDocumentsType getRecurseDocuments()
public void setRecurseDocuments(BrowseRequest.RecurseDocumentsType recurseDocuments)
recurseDocuments
- A mode value of on means that index items may be collected from child item sets.
A mode value of off means that index items may only be collected from the
immediate item set, excluding any from child sets. A mode value of empty means the
same as off, unless the immediate item set has no documents. The default value is off.public java.lang.Integer getRefineTop()
public void setRefineTop(java.lang.Integer refineTop)
refineTop
- refinement values are selected in sort order, which usually is in terms of the number of index items that has each value.
The default value is 5.public java.lang.Integer getRefineMin()
public void setRefineMin(java.lang.Integer refineMin)
refineMin
- the minimum size of a refinement property value, in terms of the number of index items with that value.
The default value for min is 0.public java.lang.Integer getRefineMinVal()
public void setRefineMinVal(java.lang.Integer refineMinVal)
refineMinVal
- the minimum number of refinement property valuespublic RefineCountType getRefineCount()
public void setRefineCount(RefineCountType pRefineCount)
pRefineCount
- the refinement value counting modepublic java.lang.Integer getMaxRelatedSets()
public void setMaxRelatedSets(java.lang.Integer maxRelatedSets)
maxRelatedSets
- Specifies the maximum number of related sets to return per document. The default is
1000.public java.lang.String[] getRelatedSets()
public void setRelatedSets(java.lang.String[] relatedSets)
relatedSets
- a list of document sets, which form a constraint on the returned related sets to
return. Only related sets that are descendents of a member of this list are returned. The default is no value, which means there are
no constraints on the related sets.public void setRelatedSetsString(java.lang.String pRelSets)
pRelSets
- setRelatedSets(String[])
public java.lang.String getRelatedSetsString()
getRelatedSets()
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)
setPageNum(Integer)
and this one, pageSize.
setPageSize
in interface PagedRequest
pageSize
- Specifies the size of the page, in results. If size is empty or missing, a default page size is used.public java.lang.Integer getPageNum()
getPageNum
in interface PagedRequest
public void setPageNum(java.lang.Integer pageNum)
setPageNum
in interface PagedRequest
pageNum
- which page number to return, starting from the first page 0 and so on.public java.lang.String[] getDocFlags()
setDocFlagsString(String)
public void setDocFlags(java.lang.String[] pDocFlags)
pDocFlags
- array of doc flagspublic void setDocFlagsString(java.lang.String pDocFlags)
pDocFlags
- setDocFlags(String[])
public java.lang.String getDocFlagsString()
getDocFlags()
public java.lang.String[] getTextProps()
public void setTextProps(java.lang.String[] pTextProps)
pTextProps
- array of text fields, such as role:displayNamepublic void setTextPropsString(java.lang.String pTextProps)
pTextProps
- comma-delimited list of text propertiessetTextProps(String[])
public java.lang.String getTextPropsString()
getTextProps()
public BrowseRequest.AncestryType getAncestry()
public void setAncestry(BrowseRequest.AncestryType ancestry)
ancestry
- A value of 'none' means no ancestry information
is returned. If no value is passed in, the default value of 'none' is used .public java.lang.Integer getMaxSets()
public void setMaxSets(java.lang.Integer maxSets)
public java.lang.Integer getMaxDepth()
public void setMaxDepth(java.lang.Integer maxDepth)
maxDepth
- The maximum depth from the starting item set that can be returned. A
value of 0 means infinite. The default is 2.public java.lang.Integer getMaxSize()
public void setMaxSize(java.lang.Integer maxSize)
public java.lang.Integer getMinSize()
public void setMinSize(java.lang.Integer minSize)
public java.lang.Integer getMaxDescendentSets()
public void setMaxDescendentSets(java.lang.Integer maxDescendentSets)
public java.lang.Integer getMaxDocs()
public void setMaxDocs(java.lang.Integer maxDocs)
public java.lang.Integer getMaxDocsPerSet()
public void setMaxDocsPerSet(java.lang.Integer maxDocsPerSet)
public java.lang.Integer getDocDepth()
public void setDocDepth(java.lang.Integer docDepth)
public java.lang.Integer getTargetDocs()
public void setTargetDocs(java.lang.Integer targetDocs)
targetDocs
- Desired number of items to retrieve based on intersection optimizationspublic java.lang.Float getIntersectMax()
public void setIntersectMax(java.lang.Float intersectMax)
intersectMax
- Percent of total collection that is too large to intersect for optimizationpublic atg.search.routing.command.search.DocSort getDocSort()
public void setDocSort(atg.search.routing.command.search.DocSort docSort)
setDocSort(atg.search.routing.command.search.DocSort)
,
#setDocSortOrder(atg.search.routing.command.search.BrowseRequest.DocSortOrder)
,
setDocSortProp(String)
, and setDocSortPropDefault(String)
.
docSort
- Specifies how the result groups will be sorted, and can be one of the following:
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. The value should be either ascending or descending.public java.lang.String getDocSortProp()
public DocSortPropVal getDocSortPropVal()
public void setDocSortPropVal(DocSortPropVal pDocSortPropVal)
pDocSortPropVal
- public void setDocSortProp(java.lang.String docSortProp)
docSortProp
- Specifies the property name to use for the strprop or numprop modes. The
property name must be a valid property of the given type; i.e. for strprop, either string or enum, and for
numprop, either integer, float, boolean or date. Index items that don't have this property will be excluded from
the sort. To prevent that, the docSortPropDefault value can specify the default property value to
use for these exceptional cases. The default value should agree with the type of the property.public java.lang.String getDocSortPropDefault()
public void setDocSortPropDefault(java.lang.String docSortPropDefault)
docSortPropDefault
- the default property valuepublic java.lang.String getDocSortPred()
getDocSort()
is predicate
public void setDocSortPred(java.lang.String docSortPred)
getDocSort()
is predicate, the predicate expression to use for sorting
docSortPred
- predicate expressionpublic BrowseRequest.SetSort getSetSort()
public void setSetSort(BrowseRequest.SetSort setSort)
setSort
- The sort value deterimes the sort order of the descendent sets. A value of alpha means
the sets are sorted by name. A value of size means the sets are sorted by largest to
smallest size. The default value is none, which means no sorting is performed.public java.lang.String getConstrainDocCounts()
public void setConstrainDocCounts(java.lang.String constrainDocCounts)
constrainDocCounts
- Acceptable values are true, false, and a non-negative integer. The boolean
values tell the engine to enable the feature using engine-selected values.
A value of 0 (or true) means that static sizes will be returned and the effect of constraints
ignored. A positive value represents the maximum (static) size of an item set that will
have its dynamic (constraint-based) size computed. For example, a value of 100 means
that only item sets whose static size is less than 100 will have constraint-based sizes
computed; all other returned item sets will return their static size. The logic of this
attribute is that the exact size of very large sets is less important than small sets, so ATG Search
will pay the cost of computation only on small sets.public java.lang.String[] getDocProps()
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)
setDocProps(String[])
.
docProps
- comma-delimited list of doc propssetDocProps(String[])
public java.lang.String getDocPropsString()
getDocProps()
array as a comma-delimited string
getDocProps()
public java.lang.String getResponseNumberSettingsString()
public void setResponseNumberSettingsString(java.lang.String responseNumberSettings)
responseNumberSettings
- the result list controls in a big string of the form paramVal,paramVal,...public java.util.Map getResponseNumberSettings()
public void setResponseNumberSettings(java.util.Map pResponseNumberSettingsMap)
pResponseNumberSettingsMap
- the response number settings mappublic int getRequestId()
getRequestId
in class SearchRequest
public static BrowseRequest valueOf(java.lang.String pRequestXml)
pRequestXml
- browse xml
public static BrowseRequest valueOf(java.lang.String pRequestXml, SearchRequest compRequest)
pRequestXml
- browse xmlcompRequest
- an existing (browse) request object to combine with the provide xml, typically
initalized as a nucleus component
protected static BrowseRequest fromXml(atg.search.routing.utils.SearchMessageParser xml, SearchRequest compRequest)
public java.lang.Boolean getDocSortCase()
public void setDocSortCase(java.lang.Boolean pDocSortCase)
pDocSortCase
- Control case-sensitivity for string-based docSort modes, e.g. strprop, title, addressprotected 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)
protected SearchResponse doMerge(java.util.List<SearchResponse> pParsedResponses) throws atg.search.routing.MergeException
doMerge
in class SearchRequest
pParsedResponses
- incoming engine responses
atg.search.routing.MergeException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |