Each search form handler has properties that store the values that are sent to ATG Search when a query is submitted. Each form handler uses a different set of these properties, depending on the tags the individual query type supports.

The following table describes all of the form handler properties that can be set in JSPs. Some of the more complex properties are described in more detail below the table.

Form Handler Property

Description

Form Handlers

docContextID

A String used to set the contents of the <docContextID> tag of the query.

ViewInContextFormHandler

docProps

An array of Strings used to set the docProps request attribute, which controls the meta properties returned with each result.

QueryFormHandler

documentSetsBuilder

Sets the contents of the <documentSets> tag of the query, using the XML Builder feature described in Using the XML Builder.

BrowseFormHandler
CategorizeFormHandler
QueryFormHandler
SimilarDocsFormHandler
StructuredQueryFormHandler

input

A String used to set the contents of the <input> tag of the query.

BrowseFormHandler
CategorizeFormHandler
SimilarDocsFormHandler
ViewInContextFormHandler

parserOptionsBuilder

Sets the contents of the <parserOptions> tag of the query, using the XML Builder feature described in Using the XML Builder.

BrowseFormHandler
CategorizeFormHandler
QueryFormHandler
SimilarDocsFormHandler
StructuredQueryFormHandler

prefAnswerConstrBuilder

Sets the contents of the <prefAnswerConstr> tag of the query, using the XML Builder feature described in Using the XML Builder.

QueryFormHandler

priorInput

An array of Strings used to set the contents of <priorInput> tags of the query. Each String in the array is used as the body of a separate <priorInput> tag.

QueryFormHandler

property

A String used to set the contents of the <property> tag of the query.

ViewInContextFormHandler

question

The search String entered by the user.

QueryFormHandler

relQuestSettings

A Map used to set the value of the relQuestSettings request attribute of the <query> query type. See Setting the relQuestSettings and responseNumberSettings Attributes.

QueryFormHandler

requestAttributes

The request attributes for the query. This property is a Map of key/value pairs, where the keys are attribute names and the values are used to set the corresponding attribute in the query.

BrowseFormHandler
CategorizeFormHandler
QueryFormHandler
SimilarDocsFormHandler
StructuredQueryFormHandler

responseNumberSettings

A Map used to set the value of the responseNumberSettings request attribute of the <query> query type. See Setting the relQuestSettings and responseNumberSettings Attributes.

QueryFormHandler

return

A String used to set the value of the returnType request attribute.

ViewInContextFormHandler

structuredStatements

An array of StructuredStatement objects used to set the <statement> tags of the query. See Specifying Structured Statements.

StructuredQueryFormHandler

url

A String used to set the contents of the <url> tag of the query.

ViewInContextFormHandler

value

A String used to set the contents of the <value> tag of the query.

ViewInContextFormHandler

weightedPropsBuilder

Sets the contents of the <weightedProps> tag of the query, using the XML Builder feature described in Using the XML Builder.

QueryFormHandler
StructuredQueryFormHandler

 
loading table of contents...