|
|||||||||
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.QueryRequest
public class QueryRequest
The query request is the most widely used search request type. It supports ordinary text queries and category navigation requests.
Required: Question setQuestion(java.lang.String)
or StartCategory setStartCategory(String)
.
Optional: Everything else
Nested Class Summary | |
---|---|
static class |
QueryRequest.DocSetSort
Enumeration for docset sorting. |
static class |
QueryRequest.Mode
Query mode enumeration. |
static class |
QueryRequest.RequestMode
Reuqest mode enumeration type. |
static class |
QueryRequest.Response
Query Response type |
static class |
QueryRequest.RuleMode
Rule mode enumeration type. |
static class |
QueryRequest.Sorting
Enumeration type for answer sorting or grouping. |
static class |
QueryRequest.Strategy
Search strategy type. |
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
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_NUM, PAGE_OFFSET_INFO, PAGE_SIZE |
Constructor Summary | |
---|---|
QueryRequest()
|
Method Summary | |
---|---|
SearchResponse |
doMerge(java.util.List<SearchResponse> pParsedResponses)
Default implementation returns the first element of the array and tosses the rest. |
protected static QueryRequest |
fromXml(atg.search.routing.utils.SearchMessageParser pParser,
SearchRequest compRequest)
|
java.lang.Boolean |
getAdvanced()
Indicates whether advanced query features, such as queryTerms, are enabled |
java.lang.Integer |
getAndFeedback()
Returns the andFeedback threshold for generating the feedback on mode=and searches, based on the number of results. |
protected void |
getAttributeXML(java.lang.StringBuilder buf)
|
java.lang.Boolean |
getAutoFacet()
Indicates whether automatic pre-processing of facet expressions be performed |
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 autospelling is enabled |
protected void |
getBodyXML(java.lang.StringBuilder buf)
Override to provide the body of the xml. |
java.lang.Boolean |
getDebugExclusion()
Indicates whether debugging of exclusions is enabled |
java.lang.Boolean |
getDisablePositioning()
Indicates whether positioning has been disabled. |
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. |
QueryRequest.DocSetSort |
getDocSetSort()
Returns the doc set sort mode. |
atg.search.routing.command.search.DocSort |
getDocSort()
Returns sorting for the result groups |
java.lang.Boolean |
getDocSortCase()
Indicates whether the doc sort is case sensitive |
atg.search.routing.command.search.DocSortOrder |
getDocSortOrder()
Indicates whether the sort is ascending or descending, either alphabetically or numerically, depending on the sort mode. |
java.lang.String |
getDocSortPred()
If docSort is predicate, returns the predicate expression to use for sorting. |
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 the document set constraints. |
java.lang.String |
getFacetTrail()
Gets the facet trail string |
java.lang.Boolean |
getFastPaging()
Returns an indication of whether fast paging is enabled for this request. |
java.lang.Boolean |
getHighlight()
Indicates whether query highlighting is enabled |
java.lang.String |
getLocale()
Returns a string representing the locale with which the query results will be sorted. |
LogicTree |
getLogicTree()
Returns the custom query logic tree |
java.lang.Integer |
getMaxRelatedSets()
Returns the maximum number of related sets to return per document |
java.lang.Integer |
getMinScore()
Returns the minimum score; the value will range from 0 to 1000, and defaults to 0. |
QueryRequest.Mode |
getMode()
Returns the query mode. |
java.lang.Integer |
getOptimize()
Returns the optimize level |
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 text processing options |
DocumentSetConstraint |
getPrefAnswerConstraints()
Returns preferred answer document set constraints |
java.lang.String[] |
getPriorInput()
Returns a List of Strings of prior input |
java.lang.String |
getPriorInputString()
Returns the prior input list as a |-delimited String |
java.lang.String |
getQuestion()
Returns the user's search input |
java.lang.String |
getRankConfig()
Returns the ranking configuration |
java.lang.String |
getRankConfigXml()
Returns full rankConfig XML for this request |
Ranking |
getRanking()
Returns the custom ranking algorithm |
java.lang.Boolean |
getRankPreferVar()
Indicates whether variables that map to weights in a property prioritization should be preferred over an explicit property value. |
java.lang.String |
getRefineConfig()
Returns the refinement configuration |
java.lang.String |
getRefineConfigDefault()
Returns the refine config default to use when $map fails |
java.lang.String |
getRefineConfigMapKey()
Returns the refine config map key |
java.lang.String |
getRefineConfigMapProperty()
If refineConfig equals "$map", returns the name of property to use for automatically selecting the configuration. |
java.lang.String |
getRefineConfigXml()
Returns full refineConfig XML for this request |
DocumentSetConstraint |
getRefineConstraints()
Returns document set constraints for refinements |
RefineCountType |
getRefineCount()
Returns the refinement value counting mode |
java.lang.Boolean |
getRefineDebug()
Indicates whether refinement debugging is enabled |
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()
Returns 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. |
atg.nucleus.ResolvingMap |
getRelQuestSettings()
Returns the relQuest settings as a resolving map |
java.lang.String |
getRelQuestSettingsString()
Returns the rel quest settings in a big string of the form /param=val;/param=Val;... |
ReportDataControl |
getReportDataControl()
Returns the control for individual reports in the results |
int |
getRequestId()
This identifies the type of request, one of SearchRequest.QUERY , SearchRequest.BROWSE , etc. |
QueryRequest.RequestMode |
getRequestMode()
Returns the request mode |
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,... |
java.lang.Boolean |
getReturnFeedback()
ATG Search returns feedback about related terms and phrases for the query. |
QueryRequest.RuleMode |
getRuleMode()
Returns the rule mode |
QueryRequest.Sorting |
getSorting()
Sets document grouping algorithm used to group the search result documents. |
java.lang.String |
getSortProperty()
The sort property is actually used for grouping results. |
java.lang.String |
getStartCategory()
Returns the start category for category navigation |
QueryRequest.Strategy |
getStrategy()
Returns how restrictive the search should be |
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 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.Boolean |
getTextSort()
Indicates whether the text statements for each response should be sorted in the order in which they appeared in the document. |
TraceExpression |
getTraceExpression()
Returns the trace expression |
RequestVariables |
getVariables()
Returns the request variables for rank rules. |
DocumentSetConstraint |
getWeightedProperties()
Returns weighted property constraints |
boolean |
isCatNavRequest()
Indicates true if startCategory was specified, false otherwise |
boolean |
isFacetSearchRequest()
Not part of the request |
SearchResponse |
processSearchResponse(atg.search.routing.command.SearchEngineResponse response)
Override to provide search response processing (parsing, generally). |
void |
setAdvanced(java.lang.Boolean advanced)
Controls whether advanced query features, such as queryTerms, are enabled |
void |
setAndFeedback(java.lang.Integer pAndFeedback)
Sets the andFeedback threshold for generating the feedback on mode=and searches, based on the number of results. |
void |
setAutoFacet(java.lang.Boolean autoFacet)
Controls whether automatic pre-processing of facet expressions be performed |
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 autoSpell)
ATG Search performs spelling correction and can return suggestions as part of the response. |
void |
setDebugExclusion(java.lang.Boolean pDebugExclusion)
Sets whether debugging of exclusions is enabled |
void |
setDisablePositioning(java.lang.Boolean pDisablePositioning)
Sets whether positioning should be disabled |
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(QueryRequest.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.DocSort docSort)
ATG Search returns a list of result groups in its query response. |
void |
setDocSortCase(java.lang.Boolean pDocSortCase)
Controls whether the doc sort is case sensitive |
void |
setDocSortOrder(atg.search.routing.command.search.DocSortOrder docSortOrder)
ATG Search returns a list of result groups in its query response. |
void |
setDocSortPred(java.lang.String docSortPred)
Sets the predicate expression to use for sorting. |
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 document set constraints |
void |
setFacetSearchRequest(boolean pFacetSearchRequest)
Not part of the request |
void |
setFacetTrail(java.lang.String pFacetTrail)
Sets the facet trail string. |
void |
setFastPaging(java.lang.Boolean pFastPaging)
Sets whether fast paging is enabled for this request. |
void |
setHighlight(java.lang.Boolean highlight)
Controls whether query highlighting is enabled |
void |
setLocale(java.lang.String pLocale)
Sets a string representing the locale with which the query results will be sorted. |
void |
setLogicTree(LogicTree logicTree)
Sets the custom query logic tree |
void |
setMaxRelatedSets(java.lang.Integer maxRelatedSets)
ATG Search returns the retrieved documents along with the statement results. |
void |
setMinScore(java.lang.Integer minScore)
The ATG Search results are ranked by relevancy. |
void |
setMode(QueryRequest.Mode mode)
ATG Search handles natural language and Boolean queries. |
void |
setOptimize(java.lang.Integer pOptimize)
-1 is old-style search, 0 is the default, 1 eliminates statement relevancy calculations, and 2 eliminates statement candidate retrieval altogether. |
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 text processing options |
void |
setPrefAnswerConstraints(DocumentSetConstraint prefAnswerConstraints)
Sets preferred answer document set constraints |
void |
setPrefAnswerConstraints(java.lang.String pPrefAnswerConstraintsXml)
Creates a new preferred answer DocumentSetConstraint from the XML. |
void |
setPriorInput(java.lang.String[] priorInput)
Sets List of Strings of prior input |
void |
setPriorInputString(java.lang.String priorInput)
Sets the list of prior input using a |-delimited String |
void |
setQuestion(java.lang.String question)
This specifies the question a query request. |
void |
setRankConfig(java.lang.String rankConfig)
Sets the ranking configuration |
void |
setRankConfigXml(java.lang.String pRankConfigXml)
Call this to provide full rankConfig XML for this request. |
void |
setRanking(Ranking ranking)
Sets the custom ranking algorithm |
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 |
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 |
setRefineConfigDefault(java.lang.String pRefineConfigDefault)
Sets the refine config default to use when $map fails |
void |
setRefineConfigMapKey(java.lang.String pRefineConfigMapKey)
Sets the refine config map key, for use with $map |
void |
setRefineConfigMapProperty(java.lang.String refineConfigMapProperty)
If refineConfig equals "$map", call this to set the name of property to use for automatically selecting the configuration. |
void |
setRefineConfigXml(java.lang.String pRefineConfigXml)
Call this to provide full refineConfig XML for this request. |
void |
setRefineConstraints(DocumentSetConstraint pRefineConstraints)
Sets document set constraints for refinements |
void |
setRefineCount(RefineCountType pRefineCount)
Sets the refinement value counting mode |
void |
setRefineDebug(java.lang.Boolean pRefineDebug)
Sets whether refinement debugging is enabled |
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 |
setRelQuestSettings(atg.nucleus.ResolvingMap pRelQuestSettingsMap)
Sets the relQuest settings using a resolving map |
void |
setRelQuestSettingsString(java.lang.String relQuestSettings)
Sets the rel quest settings in a big string of the form /param=val;/param=Val;... |
void |
setReportDataControl(ReportDataControl reportDataControl)
Sets the control for individual reports in the results |
void |
setRequestMode(QueryRequest.RequestMode requestMode)
Normally, ATG Search treats each user query as a separate isolated request, with no pre-existing state or context. |
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 |
setReturnFeedback(java.lang.Boolean returnFeedback)
ATG Search returns feedback about related terms and phrases for the query. |
void |
setRuleMode(QueryRequest.RuleMode ruleMode)
ATG Search includes a query module that analyzes user queries and executes special actions which can modify the search behavior. |
void |
setSorting(QueryRequest.Sorting sorting)
Sets document grouping algorithm used to group the search result documents. |
void |
setSortProperty(java.lang.String sortProperty)
The sort property is actually used for grouping results. |
void |
setStartCategory(java.lang.String pStartCategory)
This specifies the start category for category navigation. |
void |
setStrategy(QueryRequest.Strategy strategy)
ATG Search has a large number of search parameters that control the generic search algorithm. |
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 comma-delimited list of text properties |
void |
setTextSort(java.lang.Boolean pTextSort)
Sets whether the text statements for each response should be sorted in the order in which they appeared in the document. |
void |
setTraceExpression(TraceExpression pTraceExpression)
Sets the trace expression |
void |
setVariables(RequestVariables pRequestVariables)
Sets the request variables for rank rules. |
void |
setWeightedProperties(DocumentSetConstraint weightedProperties)
Sets weighted property constraints |
void |
setWeightedProperties(java.lang.String pWeightedPropertiesXml)
Creates a new weighted properties DocumentSetConstraint from the XML. |
static QueryRequest |
valueOf(java.lang.String pRequestXml)
Converts XML into a QueryRequest |
static QueryRequest |
valueOf(java.lang.String pRequestXml,
SearchRequest compRequest)
Converts XML into a QueryRequest |
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 QueryRequest()
Method Detail |
---|
public java.lang.String getQuestion()
public void setQuestion(java.lang.String question)
setStartCategory(String)
}
are mutually exclusive: calling the former makes this a query
request; calling the latter makes this a category navigation
request.
question
- User search inputsetStartCategory(String)
public java.lang.String getStartCategory()
public void setStartCategory(java.lang.String pStartCategory)
setQuestion(String)
are mutually exclusive: calling the former makes this a category navigation request; calling the latter makes this a
query request.
pStartCategory
- start category for category navigationsetQuestion(String)
public java.lang.Boolean getDisablePositioning()
public void setDisablePositioning(java.lang.Boolean pDisablePositioning)
pDisablePositioning
- true to disable positioningpublic java.lang.String getDocSortPred()
public void setDocSortPred(java.lang.String docSortPred)
docSortPred
- predicate expressionpublic java.lang.Boolean getDocSortCase()
public void setDocSortCase(java.lang.Boolean pDocSortCase)
pDocSortCase
- whether the doc sort is case sensitivepublic java.lang.Boolean getTextSort()
Result.getTextMatches()
.
public void setTextSort(java.lang.Boolean pTextSort)
Result.getTextMatches()
.
pTextSort
- whether the text statements for each response
should be sorted in the order in which they appeared in the
document.public java.lang.Integer getOptimize()
public void setOptimize(java.lang.Integer pOptimize)
pOptimize
- optimize levelpublic java.lang.String[] getDocFlags()
setDocFlagsString(String)
public void setDocFlags(java.lang.String[] pDocFlags)
getOptimize()
< 1
).
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 ParserOptions getParserOptions()
public void setParserOptions(ParserOptions parserOptions)
parserOptions
- text processing optionspublic 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 QueryRequest.Sorting getSorting()
setSortProperty(String)
to specify the property information.
public void setSorting(QueryRequest.Sorting sorting)
setSortProperty(String)
to specify the property information.
sorting
- may be either "document", to group results by
document, or "property" to group results by a property of the
document.public java.lang.String getSortProperty()
public void setSortProperty(java.lang.String sortProperty)
sortProperty
- Format is "type:name:default". The value
includes the type of property, the name of the property, and a
default value to use for the property, all separated by colons.public DocumentSetConstraint getDocumentSetConstraints()
public void setDocumentSetConstraints(DocumentSetConstraint documentSetConstraints)
documentSetConstraints
- document set constraintspublic DocumentSetConstraint getRefineConstraints()
public void setRefineConstraints(DocumentSetConstraint pRefineConstraints)
pRefineConstraints
- document set constraints for refinementspublic TraceExpression getTraceExpression()
public void setTraceExpression(TraceExpression pTraceExpression)
pTraceExpression
- the trace expressionpublic java.lang.Boolean getDebugExclusion()
public void setDebugExclusion(java.lang.Boolean pDebugExclusion)
pDebugExclusion
- enables or disables debugging of exclusionspublic void setRankPreferVar(java.lang.Boolean pRankPreferVar)
pRankPreferVar
- enables or disables preference for variablespublic java.lang.String getRefineConfigDefault()
public void setRefineConfigDefault(java.lang.String pRefineConfigDefault)
pRefineConfigDefault
- refine config default to use when $map failspublic RequestVariables getVariables()
public void setVariables(RequestVariables pRequestVariables)
pRequestVariables
- the request variables for rank rules.public java.lang.Boolean getRefineDebug()
public void setRefineDebug(java.lang.Boolean pRefineDebug)
pRefineDebug
- enables or disables refinement debuggingpublic java.lang.Boolean getRankPreferVar()
public java.lang.String getLocale()
public void setLocale(java.lang.String pLocale)
pLocale
- the desired locale for governing the sort of resultsprotected 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 boolean isCatNavRequest()
public static QueryRequest valueOf(java.lang.String pRequestXml)
pRequestXml
- query request XML
public static QueryRequest valueOf(java.lang.String pRequestXml, SearchRequest compRequest)
pRequestXml
- query request XMLcompRequest
- an existing request object to combine with the provide xml, typically
initalized as a nucleus component
protected static QueryRequest fromXml(atg.search.routing.utils.SearchMessageParser pParser, SearchRequest compRequest)
public QueryRequest.Strategy getStrategy()
public void setStrategy(QueryRequest.Strategy strategy)
strategy
- One of the following five values, which represent how restrictive the search should be:
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 getHighlight()
public void setHighlight(java.lang.Boolean highlight)
highlight
- if true query highlighting is enabledpublic java.lang.Boolean getAutoSpell()
public void setAutoSpell(java.lang.Boolean autoSpell)
autoSpell
- true or false, and defaults to true in the engine. The spelling suggestion feedback is always returned.public java.lang.Boolean getAutoFacet()
public void setAutoFacet(java.lang.Boolean autoFacet)
autoFacet
- Should automatic pre-processing of facet expressions be performed?public java.lang.String getRankConfig()
public void setRankConfig(java.lang.String rankConfig)
rankConfig
- rank configuration to usepublic 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.String getRefineConfigMapProperty()
setRefineConfig(String)
public void setRefineConfigMapProperty(java.lang.String refineConfigMapProperty)
refineConfigMapProperty
- If refineConfig equals "$map", the name of property to use for automatically selecting the
configuration. If all search results have the same property
value, and if this value is mapped to a refinement configuration.setRefineConfig(String)
public java.lang.String getRefineConfigMapKey()
public void setRefineConfigMapKey(java.lang.String pRefineConfigMapKey)
pRefineConfigMapKey
- refine config map key, for use with $mappublic RefineCountType getRefineCount()
public void setRefineCount(RefineCountType pRefineCount)
pRefineCount
- the refinement value counting modepublic 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.Integer getRefineMinVal()
public void setRefineMinVal(java.lang.Integer refineMinVal)
refineMinVal
- the minimum number of refinement property valuespublic QueryRequest.DocSetSort getDocSetSort()
public void setDocSetSort(QueryRequest.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 QueryRequest.Mode getMode()
public void setMode(QueryRequest.Mode mode)
mode
- nlp, for natural language and simple Boolean queries. This is the default value.
The value can also be boolean, for parsing of complex Boolean expressions.
The value can also be keyword, which handles natural language queries in a simplistic keyword search model. Essentially, ATG Search
parses the query as normal, but each query term is double-quoted and required to appear in the index items of the results.
The value can also be and, which handles natural language queries in an expanded keyword search model. Essentially, ATG Search
parses the query as normal, but each query term is required to appear in the index items of the results. This is similar to the
keyword mode, but without the double-quotes, which means the query terms could match morphological variants and use term expansions.
The value can also be matchall, which handles natural language queries as a Boolean AND of terms, as opposed to ATG Search's default
Boolean OR. Essentially, AS parses the query as normal, but each query term is required to appear in the result statements.public java.lang.Integer getAndFeedback()
public void setAndFeedback(java.lang.Integer pAndFeedback)
pAndFeedback
- the andFeedback valuepublic 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
- setDocProps(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 0.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)
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 java.lang.Boolean getAdvanced()
public void setAdvanced(java.lang.Boolean advanced)
advanced
- enables/disabled advanced query features, such as queryTermspublic atg.search.routing.command.search.DocSort getDocSort()
public void setDocSort(atg.search.routing.command.search.DocSort docSort)
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)
setDocSort(atg.search.routing.command.search.DocSort)
, setDocSortOrder(atg.search.routing.command.search.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.DocSort)
, setDocSortOrder(atg.search.routing.command.search.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.DocSort)
, setDocSortOrder(atg.search.routing.command.search.DocSortOrder)
, setDocSortProp(java.lang.String)
, setDocSortPropDefault(java.lang.String)
.
public void setDocSortPropDefault(java.lang.String docSortPropDefault)
setDocSort(atg.search.routing.command.search.DocSort)
, setDocSortOrder(atg.search.routing.command.search.DocSortOrder)
, setDocSortProp(java.lang.String)
, setDocSortPropDefault(java.lang.String)
.
docSortPropDefault
- the property value to use for the strprop or numprop modes. The property value must be
of the same type as the property from docSortProp; 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 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
- true or falsepublic QueryRequest.RuleMode getRuleMode()
public void setRuleMode(QueryRequest.RuleMode ruleMode)
ruleMode
- public QueryRequest.RequestMode getRequestMode()
public void setRequestMode(QueryRequest.RequestMode requestMode)
requestMode
- The value specifies how the context string in the priorInput element is interpreted, and can be one of the following values:
public java.lang.String getRelQuestSettingsString()
public void setRelQuestSettingsString(java.lang.String relQuestSettings)
relQuestSettings
- the search parameters in a big string of the form /param=val;/param=Val;...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 atg.nucleus.ResolvingMap getRelQuestSettings()
public void setRelQuestSettings(atg.nucleus.ResolvingMap pRelQuestSettingsMap)
pRelQuestSettingsMap
- public java.util.Map getResponseNumberSettings()
public void setResponseNumberSettings(java.util.Map pResponseNumberSettingsMap)
pResponseNumberSettingsMap
- public java.lang.String[] getPriorInput()
public void setPriorInput(java.lang.String[] priorInput)
priorInput
- List of Strings of prior inputpublic java.lang.String getPriorInputString()
public void setPriorInputString(java.lang.String priorInput)
priorInput
- |-delimited String of prior inputpublic DocumentSetConstraint getPrefAnswerConstraints()
public void setPrefAnswerConstraints(DocumentSetConstraint prefAnswerConstraints)
prefAnswerConstraints
- preferred answer document set constraintspublic void setPrefAnswerConstraints(java.lang.String pPrefAnswerConstraintsXml)
pPrefAnswerConstraintsXml
- well-formed constraint XML that starts with: <prefAnswerConstr>public DocumentSetConstraint getWeightedProperties()
public void setWeightedProperties(DocumentSetConstraint weightedProperties)
weightedProperties
- weighted property constraintspublic void setWeightedProperties(java.lang.String pWeightedPropertiesXml)
pWeightedPropertiesXml
- well-formed constraint XML that starts with: <weightedProps>public ReportDataControl getReportDataControl()
public void setReportDataControl(ReportDataControl reportDataControl)
reportDataControl
- control for individual reports in the resultspublic Ranking getRanking()
public void setRanking(Ranking ranking)
ranking
- custom ranking algorithmpublic LogicTree getLogicTree()
public void setLogicTree(LogicTree logicTree)
logicTree
- custom query logic treepublic void setFacetSearchRequest(boolean pFacetSearchRequest)
pFacetSearchRequest
- when true, flags this as a faceted search requestpublic boolean isFacetSearchRequest()
public java.lang.String getFacetTrail()
public void setFacetTrail(java.lang.String pFacetTrail)
pFacetTrail
- facet trail stringpublic int getRequestId()
SearchRequest
SearchRequest.QUERY
, SearchRequest.BROWSE
, etc.
getRequestId
in class SearchRequest
public 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)
public 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 |