atg.search.routing.command.search
Class QueryRequest.Response

java.lang.Object
  atg.search.routing.command.SearchXMLObject
      atg.search.routing.command.SearchEngineCommandResponse
          atg.search.routing.command.search.SearchResponse
              atg.search.routing.command.search.SearchResultsResponse
                  atg.search.routing.command.search.QueryRequest.Response

All Implemented Interfaces:

PagedResponse, java.io.Serializable

Enclosing class:

QueryRequest

public static class QueryRequest.Response
extends SearchResultsResponse

Query Response type

See Also:

Serialized Form

Field Summary

Fields inherited from class atg.search.routing.command.search.SearchResultsResponse

CLASS_VERSION

Fields inherited from class atg.search.routing.command.search.SearchResponse

mMultiPartitionSearch

Constructor Summary

QueryRequest.Response()

QueryRequest.Response(QueryRequest pRequest, java.util.List<SearchResponse> pParsedResponses)
This Java Merge instead of the engine's merge.

QueryRequest.Response(atg.search.routing.command.SearchEngineResponse response)

Method Summary

boolean	equals(java.lang.Object pObject)
atg.search.routing.command.search.AndFeedback	getAndFeedback() Returns boolean AND feedback
int	getAnswerCandidates() Returns the number of sentence candidates considered during retrieval
java.lang.String	getAnswerCandidatesXml() Statement candidate information for inspection tool
int	getAnswerMax() Returns an estimate of how many sentences are retrievable by the current query
int	getAnswerMin() Returns the minimum number of sentences that could be considered, if all query terms were in the same sentences
int	getAnswerPool() Returns the number of sentence results in the final result pool, before grouping and paging
protected void	getAttributeXML(java.lang.StringBuilder buf) Override to provide attributes.
boolean	getAutoSpell() Returns whether autospell is enabled
protected void	getBodyXML(java.lang.StringBuilder buf) Override to provide the body of the xml.
java.lang.String	getContentId() Returns the unique content guid for the partition that provided this response, if the request type supports its return.
java.lang.String	getDebug() Returns debug information from the engine
int	getDefaultXmlBytes()
Diagnostics	getDiagnostics() Search diagnostic and trace output
int	getDocCandidates() Number of document candidates considered during retrieval
java.lang.String	getDocCandidatesXml() Document candidate information for inspection tool
int	getDocMax() Returns an estimate of how many documents are retrievable by the current query
int	getDocMin() Returns the minimum number of documents that could be considered, if all query terms were in the same documents
QueryRequest.DocSetSort	getDocSetSort() returns the doc set sorting
atg.search.routing.command.search.DocSort	getDocSort() Returns doc sorting
atg.search.routing.command.search.DocSortOrder	getDocSortOrder() Returns doc sort order
java.lang.String	getDocSortPred() Returns doc sort predicate
java.lang.String	getDocSortProp() Returns doc sort property
java.lang.String	getDocSortPropDefault() Returns doc sort property default
DocSortPropVal	getDocSortPropVal() Returns docsort prop val
DocumentSetConstraint	getDocumentSets() Returns the document constraint expression
FeedbackReport	getFeedbackReport() Returns query feedback data
int	getGroupCount() Returns the total number of answer groups in the results, regardless of paging.
boolean	getHighlight() Returns whether highlights are enabled
java.lang.String	getInfo() Returns miscellaneous information
java.lang.String	getLogicTree() Custom query logic tree
int	getMaxRelatedSets() Returns max related sets
java.lang.String	getMergeSettings() Returns the mergeSettings that were used in the query
QueryRequest.Mode	getMode() Returns the query mode
ParserOptions	getParserOptions() Returns the text processing options
DocumentSetConstraint	getPrefAnswerConstraints() Preferred answer constraint expression
java.util.List<java.lang.String>	getPriorInput() Returns a Collection of Strings representing prior or secondary user input
java.util.List<ProcessedResponse>	getProcessedPartitionResponses() Gets the processed the engine responses from individual partitions.
QueryAction	getQueryAction() Query action results.
QueryRule	getQueryRule() Query analysis rule results
QueryTerms	getQueryTerms() Advanced query term vector data
java.lang.String	getQuestion() User search input, possibly modified with auto-corrections.
java.lang.String	getRanking() Returns the custom ranking algorithm
java.lang.String	getRefineConfig() Returns the refine config name
int	getRefineMax() Returns the maximum number of refinements
Refinements	getRefinements() Returns query refinement data
int	getRefineMin() Returns the minimum number of refinements
int	getRefineMinVal() Returns the minimum number of refinement values
int	getRefineTop() Returns the number of top refinements to return
java.lang.String	getRelQuestSettings() Returns the relQuestSettings that were used in the query
ReportDataResults	getReportDataResults() Report data derived from input query
java.lang.String	getRequestTag() Gets the xml element tag used in the request
int	getResponseCount() Returns the total number of results returned, before paging
java.lang.String	getResponseNumberSettings() Returns the responseNumSettings that were used in the query
float	getResponseScore() Returns the relevancy score of the top result.
ResponseTree	getResponseTree() Returns the categorization of the results
RuleAppendix	getRuleAppendix() Source format of any rules referred to in the response
RuleExclusions	getRuleExclusions() Query rules that would have excluded documents if enabled (debugExclusion="true")
RulePositioning	getRulePositioning() Returns the query rules that re-positioned results
QueryRequest.Sorting	getSorting() Returns result sorting (grouping)
java.lang.String	getSortProp() returns the sort property
java.lang.String	getStartCategory() Returns user category navigation input.
QueryRequest.Strategy	getStrategy() Returns the query strategy
java.lang.String	getTopicSettings() Returns the topic settings that were used
java.lang.String	getUserQuestion() Returns the user's search input, unmodified
Validation	getValidation() Returns various checks on the validity of the request given the content
DocumentSetConstraint	getWeightedProperties() Document preference expression
int	hashCode()
boolean	isDocSortCase() Returns whether doc sorting is case sensitive in the results
boolean	isRefineDebug() Returns whether refinement debugging is enabled
protected void	merge(SearchRequest pSearchRequest, java.util.List<SearchResponse> pParsedResponses) This is Java merge for QueryRequest.Response.
void	setAndFeedback(atg.search.routing.command.search.AndFeedback pAndFeedback) Sets boolean AND feedback results
void	setAnswerCandidates(int answerCandidates) Sets the number of sentence candidates considered during retrieval
void	setAnswerCandidatesXml(java.lang.String answerCandidatesXml) Sets statement candidate information for inspection tool
void	setAnswerMax(int answerMax) Sets an estimate of how many sentences are retrievable by the current query
void	setAnswerMin(int answerMin) Sets the minimum number of sentences that could be considered, if all query terms were in the same sentences
void	setAnswerPool(int answerPool) Sets the number of sentence results in the final result pool, before grouping and paging
void	setAutoSpell(boolean autoSpell) Sets whether autospell is enabled
void	setContentId(java.lang.String contentId)
void	setDebug(java.lang.String pDebug) Sets debug information from the engine
void	setDiagnostics(Diagnostics pDiagnostics) Sets Search diagnostic and trace output
void	setDocCandidates(int docCandidates) Sets the number of document candidates considered during retrieval
void	setDocCandidatesXml(java.lang.String docCandidatesXml) Sets document candidate information for inspection tool
void	setDocMax(int docMax) Sets an estimate of how many documents are retrievable by the current query
void	setDocMin(int docMin) Sets the minimum number of documents that could be considered, if all query terms were in the same documents
void	setDocSetSort(QueryRequest.DocSetSort docSetSort) Sets doc set sorting
void	setDocSort(atg.search.routing.command.search.DocSort docSort) Sets doc sorting
void	setDocSortCase(boolean pDocSortCase) Sets whether doc sorting is case sensitive in the results
void	setDocSortOrder(atg.search.routing.command.search.DocSortOrder docSortOrder) Sets doc sort order
void	setDocSortPred(java.lang.String docSortPred) Sets doc sort predicate
void	setDocSortProp(java.lang.String docSortProp) Sets doc sort property
void	setDocSortPropDefault(java.lang.String docSortPropDefault) Sets doc sort property default
void	setDocSortPropVal(DocSortPropVal pDocSortPropVal) Sets doc sort prop val
void	setDocumentSets(DocumentSetConstraint documentSets) Sets the docset constraint
void	setFeedbackReport(FeedbackReport feedbackReport) Sets query feedback data
void	setGroupCount(int groupCount) Sets the group count without taking paging into account
void	setHighlight(boolean highlight) Sets whether highlights are enabled
void	setInfo(java.lang.String info) Sets info
void	setLogicTree(java.lang.String logicTree) Sets the logic tree
void	setMaxRelatedSets(int pMaxRelatedSets) Sets max related sets
void	setMergeSettings(java.lang.String mergeSettings) Sets the mergeSettings that were used in the query
void	setMode(QueryRequest.Mode mode) Sets the query mode
void	setParserOptions(ParserOptions parserOptions) Sets the text processing options
void	setPrefAnswerConstraints(DocumentSetConstraint prefAnswerConstraints) Sets the preferred answer constraint expression
void	setPriorInput(java.util.List<java.lang.String> priorInput) Sets prior input
void	setQueryAction(QueryAction pAction) Sets the query action results.
void	setQueryRule(QueryRule queryRule) Sets query rule results
void	setQueryTerms(QueryTerms queryTerms) Sets advanced query term vector data
void	setQuestion(java.lang.String question) Sets the user question
void	setRanking(java.lang.String ranking) Sets the custom ranking algorithm
void	setRefineConfig(java.lang.String pRefineConfig) Sets the refine config name
void	setRefineDebug(boolean refineDebug) Sets whether refinement debugging is enabled
void	setRefineMax(int refineMax) Sets the maximum number of refinements
void	setRefinements(Refinements refinements) Sets query refinement data
void	setRefineMin(int refineMin) Sets the minimum number of refinements
void	setRefineMinVal(int refineMinVal) Sets the minimum number of refinements
void	setRefineTop(int refineTop) Sets the number of top refinements to return
void	setRelQuestSettings(java.lang.String relQuestSettings) Sets relQuestSettings that were used in the query
void	setReportDataResults(ReportDataResults reportDataResults) Sets report data derived from input query
void	setResponseCount(int responseCount) Sets the total number of results returned, before paging
void	setResponseNumberSettings(java.lang.String responseNumSettings) Sets the responseNumSettings that were used in the query
void	setResponseScore(float responseScore) Sets the relevancy score of the top result.
void	setResponseTree(ResponseTree responseTree) Sets the categorization of the results
void	setRuleAppendix(RuleAppendix pRuleAppendix) Sets the source format of any rules referred to in the response
void	setRuleExclusions(RuleExclusions pRuleExclusions) Sets rule exclusions
void	setRulePositioning(RulePositioning pRulePositioning) Sets the query rules that re-positioned results
void	setSorting(QueryRequest.Sorting sorting) Sets result sorting (grouping)
void	setSortProp(java.lang.String sortProp) Sets the sort property
void	setStartCategory(java.lang.String pStartCategory) Sets the user's catnav input
void	setStrategy(QueryRequest.Strategy strategy) Sets the query strategy
void	setTopicSettings(java.lang.String topicSettings) Sets the topic settings that were used
void	setUserQuestion(java.lang.String userQuestion) Sets the user's unmodified input
void	setValidation(Validation pValidation) Sets various checks on the validity of the request given the content
void	setWeightedProperties(DocumentSetConstraint weightedProperties) Sets the document preference expression

Methods inherited from class atg.search.routing.command.search.SearchResultsResponse

addResult, addResults, getGroups, getHasMoreResults, getMinScore, getPageNum, getPageOffsetInfo, getPageSize, getResults, getResultsWithGrouping, getSpellingTerms, getSuggestedCategories, setMinScore, setPageNum, setPageOffsetInfo, setPageSize, setResults, setSpellingTerms, setSuggestedCategories

Methods inherited from class atg.search.routing.command.search.SearchResponse

addError, getBuildTimeMs, getErrors, getListableProperties, getMergeTimeMs, getParseTimeMs, getPartitionResponses, getRequestChainToken, getRequestIdentifier, getRequestTime, getSearchTargetNames, getTotalResponseTimeMs, getXmlString, handleMerge, isAllowListProperties, isLocalMergeEnabled, isMultiPartitionSearch, isOverloaded, isTimedOut, setAllowListProperties, setBuildTimeMs, setErrors, setListableProperties, setLocalMergeEnabled, setMergeTimeMs, setMultiPartitionSearch, setParseTimeMs, setPartitionResponses, setRequestChainToken, setRequestIdentifier, setRequestTime, setSearchTargetNames, setTotalResponseTimeMs, toString

Methods inherited from class atg.search.routing.command.SearchEngineCommandResponse

getNextResponse, getNonSAXParser, getSearchEngineResponse, parseResponse, setNextResponse, setSearchEngineResponse

Methods inherited from class atg.search.routing.command.SearchXMLObject

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toXML, toXML

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryRequest.Response

public QueryRequest.Response()

QueryRequest.Response

public QueryRequest.Response(atg.search.routing.command.SearchEngineResponse response)

QueryRequest.Response

public QueryRequest.Response(QueryRequest pRequest,
                             java.util.List<SearchResponse> pParsedResponses)
                      throws atg.search.routing.MergeException

This Java Merge instead of the engine's merge. Invocation of this constructor results in a single merged Response. See merge(SearchRequest, java.util.List).

Parameters:

pRequest - original request

pParsedResponses - parsed responses

Throws:

atg.search.routing.MergeException

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class SearchResultsResponse

hashCode

public int hashCode()

Overrides:

hashCode in class SearchResultsResponse

merge

protected void merge(SearchRequest pSearchRequest,
                     java.util.List<SearchResponse> pParsedResponses)
              throws atg.search.routing.MergeException

This is Java merge for QueryRequest.Response.

Specified by:

merge in class SearchResponse

Parameters:

pSearchRequest - the original request

pParsedResponses - the parsed responses

Throws:

atg.search.routing.MergeException - if the merge fails

getRequestTag

public java.lang.String getRequestTag()

Gets the xml element tag used in the request

Overrides:

getRequestTag in class atg.search.routing.command.SearchEngineCommandResponse

Returns:

xml element tag

getDefaultXmlBytes

public int getDefaultXmlBytes()

Overrides:

getDefaultXmlBytes in class atg.search.routing.command.SearchXMLObject

getAttributeXML

protected void getAttributeXML(java.lang.StringBuilder buf)
                        throws atg.search.routing.command.IncompleteCommandException

Override to provide attributes.

Overrides:

getAttributeXML in class atg.search.routing.command.SearchXMLObject

Throws:

atg.search.routing.command.IncompleteCommandException - if required values are missing

getBodyXML

protected void getBodyXML(java.lang.StringBuilder buf)
                   throws atg.search.routing.command.IncompleteCommandException

Override to provide the body of the xml. Do not include the main element tag.

Overrides:

getBodyXML in class atg.search.routing.command.SearchXMLObject

Parameters:

buf - shared buffer

Throws:

atg.search.routing.command.IncompleteCommandException

getProcessedPartitionResponses

public java.util.List<ProcessedResponse> getProcessedPartitionResponses()

Gets the processed the engine responses from individual partitions. This is only for multi-partition results. This is a very costly operation, and is made available only for debugging purposes. The original engine responses are normally not available due to the storage overhead. To enable their storage, call SearchEngineRequest.setKeepingResponseData(boolean).

Returns:

List of QueryRequest.Response, possibly empty but never null.

getContentId

public java.lang.String getContentId()

Description copied from class: SearchResponse

Returns the unique content guid for the partition that provided this response, if the request type supports its return. If not supported, null is returned.

Overrides:

getContentId in class SearchResponse

Returns:

content guid, if supported, otherwise null

setContentId

public void setContentId(java.lang.String contentId)

Parameters:

contentId - content ID for index partition

getDebug

public java.lang.String getDebug()

Returns debug information from the engine

Returns:

debug information from the engine

setDebug

public void setDebug(java.lang.String pDebug)

Sets debug information from the engine

Parameters:

pDebug - debug information from the engine

getSorting

public QueryRequest.Sorting getSorting()

Returns result sorting (grouping)

Returns:

result sorting (grouping)

setSorting

public void setSorting(QueryRequest.Sorting sorting)

Sets result sorting (grouping)

Parameters:

sorting - result sorting (grouping)

isDocSortCase

public boolean isDocSortCase()

Returns whether doc sorting is case sensitive in the results

Returns:

whether doc sorting is case sensitive in the results

setDocSortCase

public void setDocSortCase(boolean pDocSortCase)

Sets whether doc sorting is case sensitive in the results

Parameters:

pDocSortCase - Sets whether doc sorting is case sensitive

getSortProp

public java.lang.String getSortProp()

returns the sort property

Returns:

sort property

setSortProp

public void setSortProp(java.lang.String sortProp)

Sets the sort property

Parameters:

sortProp - sort property

getDocSetSort

public QueryRequest.DocSetSort getDocSetSort()

returns the doc set sorting

Returns:

doc set sorting

setDocSetSort

public void setDocSetSort(QueryRequest.DocSetSort docSetSort)

Sets doc set sorting

Parameters:

docSetSort - doc set sorting

getMode

public QueryRequest.Mode getMode()

Returns the query mode

Returns:

query mode

setMode

public void setMode(QueryRequest.Mode mode)

Sets the query mode

Parameters:

mode -

getStrategy

public QueryRequest.Strategy getStrategy()

Returns the query strategy

Returns:

the query strategy

setStrategy

public void setStrategy(QueryRequest.Strategy strategy)

Sets the query strategy

Parameters:

strategy - the query strategy

getRefineConfig

public java.lang.String getRefineConfig()

Returns the refine config name

Returns:

refine config name

setRefineConfig

public void setRefineConfig(java.lang.String pRefineConfig)

Sets the refine config name

Parameters:

pRefineConfig - the refine config name

getRefineMax

public int getRefineMax()

Returns the maximum number of refinements

Returns:

the maximum number of refinements

setRefineMax

public void setRefineMax(int refineMax)

Sets the maximum number of refinements

Parameters:

refineMax - the maximum number of refinements

getRefineMin

public int getRefineMin()

Returns the minimum number of refinements

Returns:

the minimum number of refinements

setRefineMin

public void setRefineMin(int refineMin)

Sets the minimum number of refinements

Parameters:

refineMin - the minimum number of refinements

getRefineMinVal

public int getRefineMinVal()

Returns the minimum number of refinement values

Returns:

the minimum number of refinements

setRefineMinVal

public void setRefineMinVal(int refineMinVal)

Sets the minimum number of refinements

Parameters:

refineMinVal - the minimum number of refinements

getRefineTop

public int getRefineTop()

Returns the number of top refinements to return

Returns:

the number of top refinements to return

setRefineTop

public void setRefineTop(int refineTop)

Sets the number of top refinements to return

Parameters:

refineTop - the number of top refinements to return

isRefineDebug

public boolean isRefineDebug()

Returns whether refinement debugging is enabled

Returns:

whether refinement debugging is enabled

setRefineDebug

public void setRefineDebug(boolean refineDebug)

Sets whether refinement debugging is enabled

Parameters:

refineDebug - whether refinement debugging is enabled

getAutoSpell

public boolean getAutoSpell()

Returns whether autospell is enabled

Returns:

whether autospell is enabled

setAutoSpell

public void setAutoSpell(boolean autoSpell)

Sets whether autospell is enabled

Parameters:

autoSpell - whether autospell is enabled

getHighlight

public boolean getHighlight()

Returns whether highlights are enabled

Returns:

whether highlights are enabled

setHighlight

public void setHighlight(boolean highlight)

Sets whether highlights are enabled

Parameters:

highlight - whether highlights are enabled

getMaxRelatedSets

public int getMaxRelatedSets()

Returns max related sets

Returns:

max related sets

setMaxRelatedSets

public void setMaxRelatedSets(int pMaxRelatedSets)

Sets max related sets

Parameters:

pMaxRelatedSets - max related sets

getDocSort

public atg.search.routing.command.search.DocSort getDocSort()

Returns doc sorting

Returns:

doc sorting

setDocSort

public void setDocSort(atg.search.routing.command.search.DocSort docSort)

Sets doc sorting

Parameters:

docSort -

getDocSortPred

public java.lang.String getDocSortPred()

Returns doc sort predicate

Returns:

doc sort predicate

setDocSortPred

public void setDocSortPred(java.lang.String docSortPred)

Sets doc sort predicate

Parameters:

docSortPred -

getDocSortProp

public java.lang.String getDocSortProp()

Returns doc sort property

Returns:

doc sort property

setDocSortProp

public void setDocSortProp(java.lang.String docSortProp)

Sets doc sort property

Parameters:

docSortProp -

getDocSortPropVal

public DocSortPropVal getDocSortPropVal()

Returns docsort prop val

Returns:

docsort prop val

setDocSortPropVal

public void setDocSortPropVal(DocSortPropVal pDocSortPropVal)

Sets doc sort prop val

Parameters:

pDocSortPropVal -

getDocSortPropDefault

public java.lang.String getDocSortPropDefault()

Returns doc sort property default

Returns:

doc sort property default

setDocSortPropDefault

public void setDocSortPropDefault(java.lang.String docSortPropDefault)

Sets doc sort property default

Parameters:

docSortPropDefault -

getDocSortOrder

public atg.search.routing.command.search.DocSortOrder getDocSortOrder()

Returns doc sort order

Returns:

doc sort order

setDocSortOrder

public void setDocSortOrder(atg.search.routing.command.search.DocSortOrder docSortOrder)

Sets doc sort order

Parameters:

docSortOrder -

getRelQuestSettings

public java.lang.String getRelQuestSettings()

Returns the relQuestSettings that were used in the query

Returns:

relQuestSettings that were used in the query

setRelQuestSettings

public void setRelQuestSettings(java.lang.String relQuestSettings)

Sets relQuestSettings that were used in the query

Parameters:

relQuestSettings -

getResponseNumberSettings

public java.lang.String getResponseNumberSettings()

Returns the responseNumSettings that were used in the query

Returns:

responseNumSettings that were used in the query

setResponseNumberSettings

public void setResponseNumberSettings(java.lang.String responseNumSettings)

Sets the responseNumSettings that were used in the query

Parameters:

responseNumSettings -

getMergeSettings

public java.lang.String getMergeSettings()

Returns the mergeSettings that were used in the query

Returns:

mergeSettings that were used in the query

setMergeSettings

public void setMergeSettings(java.lang.String mergeSettings)

Sets the mergeSettings that were used in the query

Parameters:

mergeSettings -

getTopicSettings

public java.lang.String getTopicSettings()

Returns the topic settings that were used

Returns:

topic settings that were used

setTopicSettings

public void setTopicSettings(java.lang.String topicSettings)

Sets the topic settings that were used

Parameters:

topicSettings -

getResponseCount

public int getResponseCount()

Returns the total number of results returned, before paging

Returns:

Total number of results returned, before paging

setResponseCount

public void setResponseCount(int responseCount)

Sets the total number of results returned, before paging

Parameters:

responseCount - the total number of results returned, before paging

getGroupCount

public int getGroupCount()

Description copied from class: SearchResultsResponse

Returns the total number of answer groups in the results, regardless of paging. For requests that don't result in answer groups, such as SimilarDocsRequest, this is simply the number of results.

Specified by:

getGroupCount in interface PagedResponse

Specified by:

getGroupCount in class SearchResultsResponse

Returns:

total number of answer groups in the results, ignoring paging

setGroupCount

public void setGroupCount(int groupCount)

Sets the group count without taking paging into account

Parameters:

groupCount -

getDocMax

public int getDocMax()

Returns an estimate of how many documents are retrievable by the current query

Returns:

An estimate of how many documents are retrievable by the current query

setDocMax

public void setDocMax(int docMax)

Sets an estimate of how many documents are retrievable by the current query

Parameters:

docMax -

getDocMin

public int getDocMin()

Returns the minimum number of documents that could be considered, if all query terms were in the same documents

Returns:

Minimum number of documents that could be considered, if all query terms were in the same documents

setDocMin

public void setDocMin(int docMin)

Sets the minimum number of documents that could be considered, if all query terms were in the same documents

Parameters:

docMin -

getResponseScore

public float getResponseScore()

Returns the relevancy score of the top result.

Returns:

Relevancy score of top result

setResponseScore

public void setResponseScore(float responseScore)

Sets the relevancy score of the top result.

Parameters:

responseScore -

getAnswerCandidates

public int getAnswerCandidates()

Returns the number of sentence candidates considered during retrieval

Returns:

Number of sentence candidates considered during retrieval

setAnswerCandidates

public void setAnswerCandidates(int answerCandidates)

Sets the number of sentence candidates considered during retrieval

Parameters:

answerCandidates - the number of sentence candidates considered during retrieval

getAnswerMax

public int getAnswerMax()

Returns an estimate of how many sentences are retrievable by the current query

Returns:

An estimate of how many sentences are retrievable by the current query

setAnswerMax

public void setAnswerMax(int answerMax)

Sets an estimate of how many sentences are retrievable by the current query

Parameters:

answerMax - an estimate of how many sentences are retrievable by the current query

getAnswerMin

public int getAnswerMin()

Returns the minimum number of sentences that could be considered, if all query terms were in the same sentences

Returns:

Minimum number of sentences that could be considered, if all query terms were in the same sentences

setAnswerMin

public void setAnswerMin(int answerMin)

Sets the minimum number of sentences that could be considered, if all query terms were in the same sentences

Parameters:

answerMin - the minimum number of sentences that could be considered, if all query terms were in the same sentences

getAnswerPool

public int getAnswerPool()

Returns the number of sentence results in the final result pool, before grouping and paging

Returns:

Number of sentence results in the final result pool, before grouping and paging

setAnswerPool

public void setAnswerPool(int answerPool)

Sets the number of sentence results in the final result pool, before grouping and paging

Parameters:

answerPool - the number of sentence results in the final result pool, before grouping and paging

getDiagnostics

public Diagnostics getDiagnostics()

Search diagnostic and trace output

Returns:

Search diagnostic and trace output

setDiagnostics

public void setDiagnostics(Diagnostics pDiagnostics)

Sets Search diagnostic and trace output

Parameters:

pDiagnostics - Search diagnostic and trace output

getRuleExclusions

public RuleExclusions getRuleExclusions()

Query rules that would have excluded documents if enabled (debugExclusion="true")

Returns:

Query rules that would have excluded documents if enabled (see QueryRequest.setDebugExclusion(Boolean))

setRuleExclusions

public void setRuleExclusions(RuleExclusions pRuleExclusions)

Sets rule exclusions

Parameters:

pRuleExclusions - rule exclusions

getRulePositioning

public RulePositioning getRulePositioning()

Returns the query rules that re-positioned results

Returns:

Query rules that re-positioned results

setRulePositioning

public void setRulePositioning(RulePositioning pRulePositioning)

Sets the query rules that re-positioned results

Parameters:

pRulePositioning - Query rules that re-positioned results

getRuleAppendix

public RuleAppendix getRuleAppendix()

Source format of any rules referred to in the response

Returns:

Source format of any rules referred to in the response

setRuleAppendix

public void setRuleAppendix(RuleAppendix pRuleAppendix)

Sets the source format of any rules referred to in the response

Parameters:

pRuleAppendix - Source format of any rules referred to in the response

getValidation

public Validation getValidation()

Returns various checks on the validity of the request given the content

Returns:

Various checks on the validity of the request given the content

setValidation

public void setValidation(Validation pValidation)

Sets various checks on the validity of the request given the content

Parameters:

pValidation - Various checks on the validity of the request given the content

getDocCandidatesXml

public java.lang.String getDocCandidatesXml()

Document candidate information for inspection tool

Returns:

Document candidate information for inspection tool

setDocCandidatesXml

public void setDocCandidatesXml(java.lang.String docCandidatesXml)

Sets document candidate information for inspection tool

Parameters:

docCandidatesXml -

getAnswerCandidatesXml

public java.lang.String getAnswerCandidatesXml()

Statement candidate information for inspection tool

Returns:

Statement candidate information for inspection tool

setAnswerCandidatesXml

public void setAnswerCandidatesXml(java.lang.String answerCandidatesXml)

Sets statement candidate information for inspection tool

Parameters:

answerCandidatesXml -

getQuestion

public java.lang.String getQuestion()

User search input, possibly modified with auto-corrections. Null if this was a response for category navigation. getStartCategory()

Returns:

User search input, possibly modified with auto-corrections, possibly null

See Also:

getUserQuestion()

setQuestion

public void setQuestion(java.lang.String question)

Sets the user question

Parameters:

question -

getStartCategory

public java.lang.String getStartCategory()

Returns user category navigation input. It will be null if a question was provided instead.

Returns:

category navigation input, or null

setStartCategory

public void setStartCategory(java.lang.String pStartCategory)

Sets the user's catnav input

Parameters:

pStartCategory -

getUserQuestion

public java.lang.String getUserQuestion()

Returns the user's search input, unmodified

Returns:

User search input, unmodified

See Also:

getQuestion()

setUserQuestion

public void setUserQuestion(java.lang.String userQuestion)

Sets the user's unmodified input

Parameters:

userQuestion -

getInfo

public java.lang.String getInfo()

Returns miscellaneous information

Returns:

Miscellaneous information

setInfo

public void setInfo(java.lang.String info)

Sets info

Parameters:

info -

getPriorInput

public java.util.List<java.lang.String> getPriorInput()

Returns a Collection of Strings representing prior or secondary user input

Returns:

Collection of Strings representing prior or secondary user input

setPriorInput

public void setPriorInput(java.util.List<java.lang.String> priorInput)

Sets prior input

Parameters:

priorInput - Collection of Strings

getDocumentSets

public DocumentSetConstraint getDocumentSets()

Returns the document constraint expression

Returns:

Document constraint expression

setDocumentSets

public void setDocumentSets(DocumentSetConstraint documentSets)

Sets the docset constraint

Parameters:

documentSets -

getPrefAnswerConstraints

public DocumentSetConstraint getPrefAnswerConstraints()

Preferred answer constraint expression

Returns:

Preferred answer constraint expression

setPrefAnswerConstraints

public void setPrefAnswerConstraints(DocumentSetConstraint prefAnswerConstraints)

Sets the preferred answer constraint expression

Parameters:

prefAnswerConstraints -

getWeightedProperties

public DocumentSetConstraint getWeightedProperties()

Document preference expression

Returns:

Document preference expression

setWeightedProperties

public void setWeightedProperties(DocumentSetConstraint weightedProperties)

Sets the document preference expression

Parameters:

weightedProperties -

getRanking

public java.lang.String getRanking()

Returns the custom ranking algorithm

Returns:

Custom ranking algorithm

setRanking

public void setRanking(java.lang.String ranking)

Sets the custom ranking algorithm

Parameters:

ranking - the custom ranking algorithm

getLogicTree

public java.lang.String getLogicTree()

Custom query logic tree

Returns:

Custom query logic tree

setLogicTree

public void setLogicTree(java.lang.String logicTree)

Sets the logic tree

Parameters:

logicTree -

getParserOptions

public ParserOptions getParserOptions()

Returns the text processing options

Returns:

text processing options

setParserOptions

public void setParserOptions(ParserOptions parserOptions)

Sets the text processing options

Parameters:

parserOptions - the text processing options

getQueryTerms

public QueryTerms getQueryTerms()

Advanced query term vector data

Returns:

Advanced query term vector data

setQueryTerms

public void setQueryTerms(QueryTerms queryTerms)

Sets advanced query term vector data

Parameters:

queryTerms -

getQueryRule

public QueryRule getQueryRule()

Query analysis rule results

Returns:

Query analysis rule results

setQueryRule

public void setQueryRule(QueryRule queryRule)

Sets query rule results

Parameters:

queryRule -

getQueryAction

public QueryAction getQueryAction()

Query action results. Contains all action types, including advisor actions.

Returns:

Query action results. Contains all action types, including advisor actions.

setQueryAction

public void setQueryAction(QueryAction pAction)

Sets the query action results.

Parameters:

pAction -

getResponseTree

public ResponseTree getResponseTree()

Returns the categorization of the results

Returns:

The categorization of the results

setResponseTree

public void setResponseTree(ResponseTree responseTree)

Sets the categorization of the results

Parameters:

responseTree - the categorization of the results

getFeedbackReport

public FeedbackReport getFeedbackReport()

Returns query feedback data

Returns:

Query feedback data

setFeedbackReport

public void setFeedbackReport(FeedbackReport feedbackReport)

Sets query feedback data

Parameters:

feedbackReport -

getAndFeedback

public atg.search.routing.command.search.AndFeedback getAndFeedback()

Returns boolean AND feedback

Returns:

and feedback

setAndFeedback

public void setAndFeedback(atg.search.routing.command.search.AndFeedback pAndFeedback)

Sets boolean AND feedback results

Parameters:

pAndFeedback - feedback results

getRefinements

public Refinements getRefinements()

Returns query refinement data

Returns:

Query refinement data

setRefinements

public void setRefinements(Refinements refinements)

Sets query refinement data

Parameters:

refinements - query refinement data

getReportDataResults

public ReportDataResults getReportDataResults()

Report data derived from input query

Returns:

Report data derived from input query

setReportDataResults

public void setReportDataResults(ReportDataResults reportDataResults)

Sets report data derived from input query

Parameters:

reportDataResults -

getDocCandidates

public int getDocCandidates()

Number of document candidates considered during retrieval

Returns:

Number of document candidates considered during retrieval

setDocCandidates

public void setDocCandidates(int docCandidates)

Sets the number of document candidates considered during retrieval

Parameters:

docCandidates - number of document candidates considered during retrieval