com.primus.searchcommon.constants
Interface QueryConstants

All Superinterfaces:

CommonRequestConstants

public interface QueryConstants
extends CommonRequestConstants

Nested Class Summary

static class	QueryConstants.GroupMode
static class	QueryConstants.PageMode
static class	QueryConstants.QueryMode
static class	QueryConstants.ResultCategoryMode
static class	QueryConstants.SearchStrategyMode
static class	QueryConstants.SecondarySortMode
static class	QueryConstants.SecondarySortOrder

Field Summary

static java.lang.String	AUTOMATIC_FACET_PREPROCESSING Should automatic pre-processing of facet expressions be performed?
static java.lang.String	AUTOMATIC_SPELLING_CORRECTION ATG Search performs spelling correction and can return suggestions as part of the response.
static java.lang.String	GROUP_MODE ATG Search has three algorithms to group the final statement results: group-by-document, group-by-statement, and group-by-property.
static java.lang.String	GROUP_MODE_PROPERTY Required when GROUP_MODE=PROPERTY.
static java.lang.String	MINIMUM_RELEVANCE The ATG Search results are ranked by relevancy.
static java.lang.String	PAGE_MODE For efficiency, most search sites return results a page at a time, forcing the end-user to request additional results if necessary.
static java.lang.String	PAGE_NUM For efficiency, most search sites return results a page at a time, forcing the end-user to request additional results if necessary.
static java.lang.String	PAGE_SIZE For efficiency, most search sites return results a page at a time, forcing the end-user to request additional results if necessary.
static java.lang.String	QUERY_MODE ATG Search handles natural language and Boolean queries.
static java.lang.String	RANK_CONFIG name of rank config to use
static java.lang.String	REFINE_CONFIG ATG Search can calculate refinements based on the query results, in order to offer the end-user a quick way of narrowing the search.
static java.lang.String	REFINE_CONFIG_MAP_PROPERTY
static java.lang.String	REFINE_MAX ATG Search can calculate refinements based on the query results, in order to offer the end-user a quick way of narrowing the search.
static java.lang.String	REFINE_MIN ATG Search can calculate refinements based on the query results, in order to offer the end-user a quick way of narrowing the search.
static java.lang.String	REFINE_TOP ATG Search can calculate refinements based on the query results, in order to offer the end-user a quick way of narrowing the search.
static java.lang.String	RELATED_QUERY_THRESH
static java.lang.String	RELATED_QUERY_TOP
static java.lang.String	RESULT_CATEGORY_MODE ATG Search can return categorization feedback about the returned results in the form of a tree.
static java.lang.String	SEARCH_STRATEGY
static java.lang.String	SECONDARY_SORT_MODE ATG Search returns a list of result groups in its query response.
static java.lang.String	SECONDARY_SORT_ORDER ATG Search returns a list of result groups in its query response.
static java.lang.String	SECONDARY_SORT_PROPERTY ATG Search returns a list of result groups in its query response.
static java.lang.String	SECONDARY_SORT_PROPERTY_DEFAULT ATG Search returns a list of result groups in its query response.

Fields inherited from interface com.primus.searchcommon.constants.CommonRequestConstants

ADVANCED, DEBUG, DUMP_FILES, MERGE_SETTINGS

Field Detail

GROUP_MODE

static final java.lang.String GROUP_MODE

ATG Search has three algorithms to group the final statement results: group-by-document, group-by-statement, and group-by-property. This algorithm is controlled by the result list controls described elsewhere. The search request simply has to pick which algorithm to invoke, using this attribute. The value can either be document, for the group-by-document algorithm; text, for the group-by-statement; or property, for group by property. For group by property, use the GROUP_MODE_PROPERTY attribute to specify the property value. There is a special value docrank, which is the same as document, but it also uses the relevancy of the document instead of the relevancy of the statement for the ranking of results.

See Also:

Constant Field Values

GROUP_MODE_PROPERTY

static final java.lang.String GROUP_MODE_PROPERTY

Required when GROUP_MODE=PROPERTY. 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.

See Also:

Constant Field Values

MINIMUM_RELEVANCE

static final java.lang.String MINIMUM_RELEVANCE

The ATG Search results are ranked by relevancy. During the collection of the final results, before grouping and secondary sorting, ATG Search applies a minimum threshold on the relevancy score, using this attribute. The value must range from 0 to 1000, and defaults to 0. Results that do not meet the minimum threshold are discarded.

See Also:

Constant Field Values

PAGE_NUM

static final java.lang.String PAGE_NUM

For efficiency, most search sites return results a page at a time, forcing the end-user to request additional results if necessary. ATG Search supports result paging, and it is controlled by three attributes: PAGE_NUM, PAGE_SIZE, nad PAGE_MODE. The PAGE_NUM value specifies which page number to return, starting from the first page 0 and so on.

See Also:

Constant Field Values

PAGE_SIZE

static final java.lang.String PAGE_SIZE

For efficiency, most search sites return results a page at a time, forcing the end-user to request additional results if necessary. ATG Search supports result paging, and it is controlled by three attributes: PAGE_NUM, PAGE_SIZE, nad PAGE_MODE. The PAGE_SIZE value specifies the size of the page, with respect to the pageMode.

See Also:

Constant Field Values

PAGE_MODE

static final java.lang.String PAGE_MODE

For efficiency, most search sites return results a page at a time, forcing the end-user to request additional results if necessary. ATG Search supports result paging, and it is controlled by three attributes: PAGE_NUM, PAGE_SIZE, nad PAGE_MODE. The PAGE_MODE value specifies what constitutes an element on a page, and it has two possible values: * response -- each individual response counts towards page size * group -- each unique result group counts towards page size The default mode value is group, since ideally the user interface would not want to split a group across pages.

See Also:

Constant Field Values

AUTOMATIC_SPELLING_CORRECTION

static final java.lang.String AUTOMATIC_SPELLING_CORRECTION

ATG Search performs spelling correction and can return suggestions as part of the response. In addition, ATG Search can automatically correct the mistakes before issuing the query, using this attribute. The value must be either true or false, and defaults to true. The spelling suggestion feedback is always returned, and is not effected by this attribute.

See Also:

Constant Field Values

AUTOMATIC_FACET_PREPROCESSING

static final java.lang.String AUTOMATIC_FACET_PREPROCESSING

Should automatic pre-processing of facet expressions be performed?

See Also:

Constant Field Values

RANK_CONFIG

static final java.lang.String RANK_CONFIG

name of rank config to use

See Also:

Constant Field Values

REFINE_CONFIG

static final java.lang.String REFINE_CONFIG

ATG Search can calculate refinements based on the query results, in order to offer the end-user a quick way of narrowing the search. This refinement is calculated using configuration data as described in Admin Guide. At query time, ATG Search can control which configuration to use and global parameters for the calculation, using this attribute, plus REFINE_MAX, REFINE_TOP, and REFINE_MIN. The value must be a valid name of a refinement configuration loaded into the index. If no value is given, no refinement calculation is made.

See Also:

Constant Field Values

REFINE_CONFIG_MAP_PROPERTY

static final java.lang.String REFINE_CONFIG_MAP_PROPERTY

See Also:

Constant Field Values

REFINE_MAX

static final java.lang.String REFINE_MAX

ATG Search can calculate refinements based on the query results, in order to offer the end-user a quick way of narrowing the search. This refinement is calculated using configuration data as described in Admin Guide. At query time, ATG Search can control the maximum number of refinement properties to return using this attribute. The value is 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.

See Also:

Constant Field Values

REFINE_TOP

static final java.lang.String REFINE_TOP

ATG Search can calculate refinements based on the query results, in order to offer the end-user a quick way of narrowing the search. This refinement is calculated using configuration data as described in Admin Guide. At query time, ATG Search can control how many refinement property values (per property) with this attribute. The refinement values are selected in sort order, which usually is in terms of the number of index items that has each value. The default value is 5.

See Also:

Constant Field Values

REFINE_MIN

static final java.lang.String REFINE_MIN

ATG Search can calculate refinements based on the query results, in order to offer the end-user a quick way of narrowing the search. This refinement is calculated using configuration data as described in Admin Guide. At query time, ATG Search can eliminate refinement property values by their size with this attribute. The value is 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.

See Also:

Constant Field Values

RELATED_QUERY_TOP

static final java.lang.String RELATED_QUERY_TOP

See Also:

Constant Field Values

RELATED_QUERY_THRESH

static final java.lang.String RELATED_QUERY_THRESH

See Also:

Constant Field Values

SEARCH_STRATEGY

static final java.lang.String SEARCH_STRATEGY

See Also:

Constant Field Values

RESULT_CATEGORY_MODE

static final java.lang.String RESULT_CATEGORY_MODE

ATG Search can return categorization feedback about the returned results in the form of a tree. This functionality is controlled by this attribute. The mode value 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.

See Also:

Constant Field Values

QUERY_MODE

static final java.lang.String QUERY_MODE

ATG Search handles natural language and Boolean queries. Simple Boolean syntax is handled automatically as part of the natural language processing, but complex Boolean expressions require a special mode of processing. Furthermore, ATG Search can support simple keyword search behavior in several additional modes. These modes are controlled by this attribute. The value can be 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.

See Also:

Constant Field Values

SECONDARY_SORT_MODE

static final java.lang.String SECONDARY_SORT_MODE

ATG Search returns a list of result groups in its query response. These final results are pulled from the pool of raw results. Normally, the result groups are sorted in relevance order, but user interfaces often allow the final results to be sorted by some secondary criteria, such as date or source or format. This secondary sort does not effect what results are in the final result groups, just the order of the returned groups. Secondary sorting is performed before paging. Secondary sorting is controlled by four attributes: SECONDARY_SORT_MODE, SECONDARY_SORT_ORDER, SECONDARY_SORT_PROPERTY, and SECONDARY_SORT_PROPERTY_DEFAULT. The SECONDARY_SORT_MODE value specifies how the result groups will be sorted, and can be one of the following: - relevance -- the default value, return groups in relevance order - alpha -- sort groups by filename of index item, i.e. the last part of the full URL (e.g. index.htm) - address -- sort groups by web site address of the index item, i.e. the beginning of the full URL (e.g. http://www.atg.com) - url -- sort groups by full URL of the index item - date -- sort groups by last modified date of the index item - strprop -- sort groups by a meta-data string property, requires docSortProp attribute - numprop -- sort groups by a meta-data number property, requires docSortProp attribute - title -- sort groups by title of the index item - type -- sort groups by the type of the index item, e.g. HTML, PDF - docset -- sort groups by physical document set

See Also:

Constant Field Values

SECONDARY_SORT_ORDER

static final java.lang.String SECONDARY_SORT_ORDER

ATG Search returns a list of result groups in its query response. These final results are pulled from the pool of raw results. Normally, the result groups are sorted in relevance order, but user interfaces often allow the final results to be sorted by some secondary criteria, such as date or source or format. This secondary sort does not effect what results are in the final result groups, just the order of the returned groups. Secondary sorting is performed before paging. Secondary sorting is controlled by four attributes: SECONDARY_SORT_MODE, SECONDARY_SORT_ORDER, SECONDARY_SORT_PROPERTY, and SECONDARY_SORT_PROPERTY_DEFAULT. The SECONDARY_SORT_ORDER value 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.

See Also:

Constant Field Values

SECONDARY_SORT_PROPERTY

static final java.lang.String SECONDARY_SORT_PROPERTY

ATG Search returns a list of result groups in its query response. These final results are pulled from the pool of raw results. Normally, the result groups are sorted in relevance order, but user interfaces often allow the final results to be sorted by some secondary criteria, such as date or source or format. This secondary sort does not effect what results are in the final result groups, just the order of the returned groups. Secondary sorting is performed before paging. Secondary sorting is controlled by four attributes: SECONDARY_SORT_MODE, SECONDARY_SORT_ORDER, SECONDARY_SORT_PROPERTY, and SECONDARY_SORT_PROPERTY_DEFAULT. The SECONDARY_SORT_PROPERTY value specifies the property name to use for the strprop or numprop modes. The property name must be a valid property of the given type; i.e. for strprop, either string or enum, and for numprop, either integer, float, boolean or date. Index items that don't have this property will be excluded from the sort. To prevent that, the SECONDARY_SORT_PROPERTY_DEFAULT value can specify the default property value to use for these exceptional cases. The default value should agree with the type of the property.

See Also:

Constant Field Values

SECONDARY_SORT_PROPERTY_DEFAULT

static final java.lang.String SECONDARY_SORT_PROPERTY_DEFAULT

ATG Search returns a list of result groups in its query response. These final results are pulled from the pool of raw results. Normally, the result groups are sorted in relevance order, but user interfaces often allow the final results to be sorted by some secondary criteria, such as date or source or format. This secondary sort does not effect what results are in the final result groups, just the order of the returned groups. Secondary sorting is performed before paging. Secondary sorting is controlled by four attributes: SECONDARY_SORT_MODE, SECONDARY_SORT_ORDER, SECONDARY_SORT_PROPERTY, and SECONDARY_SORT_PROPERTY_DEFAULT. The SECONDARY_SORT_PROPERTY value specifies the property name to use for the strprop or numprop modes. The property name must be a valid property of the given type; i.e. for strprop, either string or enum, and for numprop, either integer, float, boolean or date. Index items that don't have this property will be excluded from the sort. To prevent that, the SECONDARY_SORT_PROPERTY_DEFAULT value can specify the default property value to use for these exceptional cases. The default value should agree with the type of the property.

See Also:

Constant Field Values