com.primus.searchcommon.constants
Interface ViewItemConstants

All Superinterfaces:

CommonRequestConstants

public interface ViewItemConstants
extends CommonRequestConstants

Nested Class Summary

static class	ViewItemConstants.QueryMode
static class	ViewItemConstants.ReturnType
static class	ViewItemConstants.SectionsType what to return

Field Summary

static java.lang.String	QUERY_MODE ATG Search handles natural language and Boolean queries.
static java.lang.String	RETURN_TYPE Besides returning the source content of an item (with the document type), the View Item request can return the highlight information instead, for situations where the application is rendering the source content outside of ATG Search.

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

ADVANCED, DEBUG, DUMP_FILES, MERGE_SETTINGS

Field Detail

RETURN_TYPE

static final java.lang.String RETURN_TYPE

Besides returning the source content of an item (with the document type), the View Item request can return the highlight information instead, for situations where the application is rendering the source content outside of ATG Search. These different responses are enabled by the following attribute. The type value can be one of the following: - fieldoffset - return the relative offsets into the fields of the source content for the text regions, in the form: field.begin-end,field.begin-end,... - offset - return absolute offsets into source content for text regions, in the form: begin-end,begin-end,... - information - returns a document element as in a regular query

See Also:

ViewItemConstants.ReturnType, 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, ATG Search parses the query as normal, but each query term is required to appear in the result statements.

See Also:

ViewItemConstants.QueryMode, Constant Field Values