|
|||||||||
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.StructuredQueryRequest
public class StructuredQueryRequest
Structured query request, also called 'fielded search.'
Required: Statements setStatements(java.util.List
, addStatement(atg.search.routing.command.search.StructuredStatement)
Optional: everything else
Nested Class Summary | |
---|---|
static class |
StructuredQueryRequest.DocSetSort
Doc set sort enumeration. |
static class |
StructuredQueryRequest.DocSortOrder
Doc sort order enumeration. |
static class |
StructuredQueryRequest.Response
Response type for StructuredQueryRequest . |
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, PAGE_OFFSET_INFO |
Constructor Summary | |
---|---|
StructuredQueryRequest()
|
Method Summary | |
---|---|
void |
addStatement(StructuredStatement statement)
Adds a statement to the list of statements |
protected SearchResponse |
doMerge(java.util.List<SearchResponse> pParsedResponses)
Default implementation returns the first element of the array and tosses the rest. |
protected static StructuredQueryRequest |
fromXml(atg.search.routing.utils.SearchMessageParser xml,
SearchRequest compRequest)
|
protected void |
getAttributeXML(java.lang.StringBuilder buf)
|
java.lang.Integer |
getAutomaticConstrainCategories()
Returns the maximum number of categories to add as constraints. |
java.lang.Boolean |
getAutomaticConstrainCategoriesPruning()
Indicates whether pruning is enabled |
java.lang.Boolean |
getAutoSpell()
Indicates whether autospell is enabled |
protected void |
getBodyXML(java.lang.StringBuilder buf)
|
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 the list of docprops |
java.lang.String |
getDocPropsString()
Returns the comma-delimited list of docprops. |
StructuredQueryRequest.DocSetSort |
getDocSetSort()
Returns the doc set sort mode |
atg.search.routing.command.search.DocSortCommon |
getDocSort()
Returns how the result groups will be sorted |
java.lang.Boolean |
getDocSortCase()
Returns the case-sensitivity for string-based docSort modes, e.g. |
StructuredQueryRequest.DocSortOrder |
getDocSortOrder()
Returns whether the sort is ascending or descending, either alphabetically or numerically, depending on the sort mode. |
java.lang.String |
getDocSortPred()
Returns the doc sort predicate |
java.lang.String |
getDocSortProp()
Returns the property name to use for the strprop or numprop modes |
java.lang.String |
getDocSortPropDefault()
ATG Search returns a list of result groups in its query response. |
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 set constraints |
java.lang.Boolean |
getFastPaging()
Returns an indication of whether fast paging is enabled for this request. |
java.lang.Integer |
getMaxRelatedSets()
Returns the maximum number of related sets to return per document |
java.lang.Integer |
getMaxRelatedStatements()
Returns the maximum number of related statements to return |
java.lang.Integer |
getMinScore()
Returns a value that will range from 0 to 1000, and defaults to 0. |
java.lang.Integer |
getPageNum()
Returns the 0-based page number that should be retrieved. |
atg.search.routing.command.search.PageOffsetInfo |
getPageOffsetInfo()
Returns internal page offset information when fast paging is used with a multi-partition index. |
java.lang.Integer |
getPageSize()
Returns the number of results that should be returned per page |
ParserOptions |
getParserOptions()
Returns the text processing options |
java.lang.String |
getRefineConfig()
Returns the refinement configuration |
DocumentSetConstraint |
getRefineConstraints()
Returns the refinement constraints |
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 |
getRefineTop()
Returns the number of index items that have 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 the comma-delimited list of related sets. |
int |
getRequestId()
This identifies the type of request, one of SearchRequest.QUERY , SearchRequest.BROWSE , etc. |
java.lang.Boolean |
getReturnFeedback()
ATG Search returns feedback about related terms and phrases for the query. |
java.util.List<StructuredStatement> |
getStatements()
Returns the List of StructuredStatement objects |
StructuredStatement |
getStatements(int pIndex)
Gets the statement at a particular index. |
java.lang.Integer |
getSuggestQueryCategories()
Returns the maximum number of categories to return in the feedback. |
java.lang.Boolean |
getSuggestQueryCategoriesPruning()
Returns true if pruning has been enabled |
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 |
java.lang.Integer |
getTop()
Returns the maximum number of results to return |
java.lang.Integer |
getWeightContribution()
Returns the relative contribution of the weighted preference value to the total relevance |
DocumentSetConstraint |
getWeightedProperties()
Returns the weighted property constraints |
SearchResponse |
processSearchResponse(atg.search.routing.command.SearchEngineResponse response)
Override to provide search response processing (parsing, generally). |
void |
setAutomaticConstrainCategories(java.lang.Integer automaticConstrainCategories)
ATG Search includes a categorization module that applies rules to decide what categories of a taxonomy are relevant to the content, or in this case user queries. |
void |
setAutomaticConstrainCategoriesPruning(java.lang.Boolean automaticConstrainCategoriesPruning)
Controls whether pruning is enabled |
void |
setAutoSpell(java.lang.Boolean autoSpellingCorrection)
ATG Search performs spelling correction and can return suggestions as part of the response. |
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 index item of each statement result. |
void |
setDocPropsString(java.lang.String docProps)
accepts a comma-delimited list of docProps |
void |
setDocSetSort(StructuredQueryRequest.DocSetSort docSetSort)
ATG Search can return categorization feedback about the returned results in the form of a tree. |
void |
setDocSort(atg.search.routing.command.search.DocSortCommon docSort)
ATG Search returns a list of result groups in its query response. |
void |
setDocSortCase(java.lang.Boolean pDocSortCase)
default is true in the engine |
void |
setDocSortOrder(StructuredQueryRequest.DocSortOrder docSortOrder)
ATG Search returns a list of result groups in its query response. |
void |
setDocSortPred(java.lang.String docSortPred)
Sets the doc sort predicate |
void |
setDocSortProp(java.lang.String docSortProp)
ATG Search returns a list of result groups in its query response. |
void |
setDocSortPropDefault(java.lang.String docSortPropDefault)
ATG Search returns a list of result groups in its query response. |
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 the document set constraints |
void |
setFastPaging(java.lang.Boolean pFastPaging)
Sets whether fast paging is enabled for this request. |
void |
setMaxRelatedSets(java.lang.Integer maxRelatedSets)
ATG Search returns the retrieved documents along with the statement results. |
void |
setMaxRelatedStatements(java.lang.Integer maxRelatedStatements)
Sets the maximum number of related statements to return |
void |
setMinScore(java.lang.Integer minScore)
The ATG Search results are ranked by relevancy. |
void |
setPageNum(java.lang.Integer pageNum)
Sets the 0-based page number that should be retrieved. |
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)
Sets the number of results that should be returned per page. |
void |
setParserOptions(ParserOptions parserOptions)
Sets the text processing options |
void |
setRefineConfig(java.lang.String refineConfig)
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 |
setRefineConstraints(DocumentSetConstraint pRefineConstraints)
Sets the refinement constraints |
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 |
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 |
setReturnFeedback(java.lang.Boolean returnFeedback)
ATG Search returns feedback about related terms and phrases for the query. |
void |
setStatements(int pIndex,
StructuredStatement pStatement)
Sets a statement at a particular index, increasing the size of the list if necessary. |
void |
setStatements(java.util.List<StructuredStatement> statements)
Sets the List of StructuredStatement objects |
void |
setSuggestQueryCategories(java.lang.Integer suggestQueryCategories)
ATG Search includes a categorization module that applies rules to decide what categories of a taxonomy are relevant to the content, or in this case user queries. |
void |
setSuggestQueryCategoriesPruning(java.lang.Boolean suggestQueryCategoriesPruning)
Controls whether the optional taxonomy pruning post-processing algorithm is used during categorization. |
void |
setTextProps(java.lang.String[] pTextProps)
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 the comma-delimited list of text properties |
void |
setTop(java.lang.Integer top)
Sets the maximum number of results to return |
void |
setWeightContribution(java.lang.Integer weightContribution)
Sets the relative contribution of the weighted preference value to the total relevance |
void |
setWeightedProperties(DocumentSetConstraint weightedProperties)
Sets weighted property constraints |
static StructuredQueryRequest |
valueOf(java.lang.String pRequestXml)
Constructs a new request from an xml string |
static StructuredQueryRequest |
valueOf(java.lang.String pRequestXml,
SearchRequest compRequest)
Converts an xml string into a StructuredQueryRequest |
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 StructuredQueryRequest()
Method Detail |
---|
public java.util.List<StructuredStatement> getStatements()
StructuredStatement
objects
StructuredStatement
objectspublic void setStatements(java.util.List<StructuredStatement> statements)
StructuredStatement
objects
statements
- List of StructuredStatement
objectspublic void addStatement(StructuredStatement statement)
statement
- adds it to the list of statementspublic void setStatements(int pIndex, StructuredStatement pStatement)
pIndex
- the indexpStatement
- the statementpublic StructuredStatement getStatements(int pIndex)
pIndex
- the index
public java.lang.Boolean getDocSortCase()
public void setDocSortCase(java.lang.Boolean pDocSortCase)
pDocSortCase
- case-sensitivity for string-based docSort modes, e.g. strprop, title, addresspublic java.lang.Integer getWeightContribution()
public void setWeightContribution(java.lang.Integer weightContribution)
weightContribution
- Relative contribution of the weighted preference value to the total relevancepublic java.lang.Integer getMaxRelatedStatements()
public void setMaxRelatedStatements(java.lang.Integer maxRelatedStatements)
maxRelatedStatements
- Maximum number of related statements to returnpublic StructuredQueryRequest.DocSetSort getDocSetSort()
public void setDocSetSort(StructuredQueryRequest.DocSetSort docSetSort)
docSetSort
- can be none, which means no categorization feedback tree is constructed. The mode value can be fulltree,
which means that a full categorization tree is returned, with all intervening levels, even if they have no direct connection
to the results. The mode value can be sparsetree, which means that that a categorization tree is returned, but intervening
levels that have no direct connection to the results are omitted. There are several other experimental values for this attribute,
but they are not in use. The default value is none.public java.lang.Integer getSuggestQueryCategories()
public void setSuggestQueryCategories(java.lang.Integer suggestQueryCategories)
suggestQueryCategories
- the maximum number of categories to return in the feedback.
Call setSuggestQueryCategoriesPruning(java.lang.Boolean)
then the optional
taxonomy pruning post-processing algorithm is used during categorization.public java.lang.Boolean getSuggestQueryCategoriesPruning()
setSuggestQueryCategoriesPruning(Boolean)
public void setSuggestQueryCategoriesPruning(java.lang.Boolean suggestQueryCategoriesPruning)
suggestQueryCategoriesPruning
- if true, then the optional
taxonomy pruning post-processing algorithm is used during categorization.public java.lang.Boolean getReturnFeedback()
public void setReturnFeedback(java.lang.Boolean returnFeedback)
returnFeedback
- whether feedback should be returnedpublic ParserOptions getParserOptions()
public void setParserOptions(ParserOptions parserOptions)
parserOptions
- tex processing optionspublic 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 DocumentSetConstraint getDocumentSetConstraints()
public void setDocumentSetConstraints(DocumentSetConstraint documentSetConstraints)
documentSetConstraints
- document set constraintspublic DocumentSetConstraint getRefineConstraints()
public void setRefineConstraints(DocumentSetConstraint pRefineConstraints)
pRefineConstraints
- the refinement 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 java.lang.Integer getMinScore()
public void setMinScore(java.lang.Integer minScore)
minScore
- The value must range from 0 to 1000, and defaults to 0. Results that do not meet the minimum threshold are discarded.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()
PagedRequest
getPageOffsetInfo
in interface PagedRequest
public java.lang.Boolean getAutoSpell()
public void setAutoSpell(java.lang.Boolean autoSpellingCorrection)
autoSpellingCorrection
- true or false, and defaults to true in the engine. The spelling suggestion feedback is always returned,
and is not effected by this attribute.public java.lang.String getRefineConfig()
public void setRefineConfig(java.lang.String refineConfig)
setRefineMax(java.lang.Integer)
, setRefineTop(java.lang.Integer)
, and setRefineMin(java.lang.Integer)
.
refineConfig
- valid name of a refinement configuration loaded into the index. If no value is given, no refinement calculation is made.public 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 java.lang.Integer getRefineTop()
public void setRefineTop(java.lang.Integer refineTop)
refineTop
- 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.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
- a comma-delimited list of docPropssetDocProps(String[])
public java.lang.String getDocPropsString()
getDocProps()
public java.lang.Integer getMaxRelatedSets()
public void setMaxRelatedSets(java.lang.Integer maxRelatedSets)
setRelatedSets(java.lang.String[])
.
maxRelatedSets
- 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()
PagedRequest
getFastPaging
in interface PagedRequest
public void setFastPaging(java.lang.Boolean pFastPaging)
PagedRequest
setFastPaging
in interface PagedRequest
pFastPaging
- true to enable fast pagingpublic java.lang.Integer getPageSize()
PagedRequest
getPageSize
in interface PagedRequest
public void setPageSize(java.lang.Integer pageSize)
PagedRequest
setPageSize
in interface PagedRequest
pageSize
- number of results that should be returned per pagepublic java.lang.Integer getPageNum()
PagedRequest
getPageNum
in interface PagedRequest
public void setPageNum(java.lang.Integer pageNum)
PagedRequest
setPageNum
in interface PagedRequest
pageNum
- specifies which 0-based page number to return, starting from the first page 0 and so on.public java.lang.Integer getAutomaticConstrainCategories()
public void setAutomaticConstrainCategories(java.lang.Integer automaticConstrainCategories)
automaticConstrainCategories
- The maximum number of categories to add as constraints. Multiple categories are added as a Boolean OR of document set constraints,
joined (i.e. AND-ed) to the pre-existing constraints. If setAutomaticConstrainCategoriesPruning(Boolean)
is called, then the optional taxonomy pruning post-processing
algorithm is used during categorization.public java.lang.Boolean getAutomaticConstrainCategoriesPruning()
public void setAutomaticConstrainCategoriesPruning(java.lang.Boolean automaticConstrainCategoriesPruning)
automaticConstrainCategoriesPruning
- if true, then the optional taxonomy pruning post-processing
algorithm is used during categorization.public atg.search.routing.command.search.DocSortCommon getDocSort()
public void setDocSort(atg.search.routing.command.search.DocSortCommon docSort)
docSort
- specifies how the result groups will be sorted, and can be one of the following:
public java.lang.String getDocSortPred()
public void setDocSortPred(java.lang.String docSortPred)
docSortPred
- the doc sort predicatepublic StructuredQueryRequest.DocSortOrder getDocSortOrder()
public void setDocSortOrder(StructuredQueryRequest.DocSortOrder docSortOrder)
setDocSort(atg.search.routing.command.search.DocSortCommon)
, setDocSortOrder(atg.search.routing.command.search.StructuredQueryRequest.DocSortOrder)
, setDocSortProp(java.lang.String)
, setDocSortPropDefault(java.lang.String)
.
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 void setDocSortProp(java.lang.String docSortProp)
setDocSort(atg.search.routing.command.search.DocSortCommon)
, setDocSortOrder(atg.search.routing.command.search.StructuredQueryRequest.DocSortOrder)
, setDocSortProp(java.lang.String)
, setDocSortPropDefault(java.lang.String)
.
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, 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.public DocSortPropVal getDocSortPropVal()
public void setDocSortPropVal(DocSortPropVal pDocSortPropVal)
pDocSortPropVal
- public java.lang.String getDocSortPropDefault()
setDocSort(atg.search.routing.command.search.DocSortCommon)
, setDocSortOrder(atg.search.routing.command.search.StructuredQueryRequest.DocSortOrder)
, setDocSortProp(java.lang.String)
, setDocSortPropDefault(java.lang.String)
.
public void setDocSortPropDefault(java.lang.String docSortPropDefault)
setDocSort(atg.search.routing.command.search.DocSortCommon)
, setDocSortOrder(atg.search.routing.command.search.StructuredQueryRequest.DocSortOrder)
, setDocSortProp(java.lang.String)
, setDocSortPropDefault(java.lang.String)
.
docSortPropDefault
- 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, 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.public DocumentSetConstraint getWeightedProperties()
public void setWeightedProperties(DocumentSetConstraint weightedProperties)
weightedProperties
- weighted property constraintspublic int getRequestId()
SearchRequest
SearchRequest.QUERY
, SearchRequest.BROWSE
, etc.
getRequestId
in class SearchRequest
public static StructuredQueryRequest valueOf(java.lang.String pRequestXml)
pRequestXml
- an xml string
public static StructuredQueryRequest valueOf(java.lang.String pRequestXml, SearchRequest compRequest)
pRequestXml
- StructuredQuery xmlcompRequest
- an existing (StructuredQuery) request object to combine with the provide xml, typically
initalized as a nucleus component
protected static StructuredQueryRequest fromXml(atg.search.routing.utils.SearchMessageParser xml, SearchRequest compRequest)
public java.lang.Integer getTop()
public void setTop(java.lang.Integer top)
top
- Maximum number of results to returnpublic SearchResponse processSearchResponse(atg.search.routing.command.SearchEngineResponse response) throws atg.search.routing.command.RoutingCommandException
SearchRequest
processSearchResponse
in class SearchRequest
response
- the engine 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
SearchRequest
doMerge
in class SearchRequest
pParsedResponses
- parsed responses
atg.search.routing.MergeException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |