com.primus.searchcommon.constants
Interface AdvancedStructuredQueryConstants

public interface AdvancedStructuredQueryConstants

Field Summary

static java.lang.String	AUTOMATIC_CONSTRAIN_QUERY_CATEGORIES 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.
static java.lang.String	ITEM_PROPERTY_CONTROL ATG Search returns the meta-data properties associated with the index item of each statement result.
static java.lang.String	MAX_RELATED_SETS ATG Search returns the retrieved documents along with the statement results.
static java.lang.String	META_DATA_WEIGHTED_EXPRESSION_CONTRIBUTION
static java.lang.String	RELATED_SET_CONTROL ATG Search returns the retrieved documents along with the statement results.
static java.lang.String	RETURN_FEEDBACK ATG Search returns feedback about related terms and phrases for the query.
static java.lang.String	SUGGEST_QUERY_CATEGORIES 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.

Field Detail

ITEM_PROPERTY_CONTROL

static final java.lang.String ITEM_PROPERTY_CONTROL

ATG Search returns the meta-data properties associated with the index item of each statement result. These returned properties can be used for user interface functionality, such as customized result pages. By default, ATG Search returns all stored meta-data properties, but the list of returned properties can be controlled by this attribute. The value can be "all", which is the default, and simply indicates that all properties are returned. The value can also be a comma-delimited list of the property names that can be returned. The value can also be in the form of: config;testprop|val,...,val|retprop,...;testprop|val,...,val|retprop,...;... Basically, this syntax allows for conditional selection of returned properties, depending on another property of the index item. The config; prefix denotes the new special syntax. The testprop is a name of a property that will be tested for one of the values in the list that follow it. If an index item has one of the values for the testprop, then the list of retprop properties is used to control what properties to return just for that index item. If not, the next testprop sequence is used, and so on until no more configuration data is left. If testprop is empty, then the sequence is unconditional and all index items will satisfy it. This is useful as the last item of the sequence to denote the default properties for any index item that does not satisfy the specific property tests. If the val list is empty, then any value satisfies the test. If the retprop list is empty, then no properties will be returned for index items satisfying the given test.

See Also:

Constant Field Values

MAX_RELATED_SETS

static final java.lang.String MAX_RELATED_SETS

ATG Search returns the retrieved documents along with the statement results. The retrieved documents contain associated information, including the document sets (or categories) of the document. How many of these related sets and what kind of sets to return are controlled by the MAX_RELATED_SETS and RELATED_SET_CONTROL attributes. The MAX_RELATED_SETS value specifies the maximum number of related sets to return per document. The default is 1000.

See Also:

Constant Field Values

RELATED_SET_CONTROL

static final java.lang.String RELATED_SET_CONTROL

ATG Search returns the retrieved documents along with the statement results. The retrieved documents contain associated information, including the document sets (or categories) of the document. How many of these related sets and what kind of sets to return are controlled by the MAX_RELATED_SETS and RELATED_SET_CONTROL attributes. The RELATED_SET_CONTROL value specifies a comma-delimited 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.

See Also:

Constant Field Values

AUTOMATIC_CONSTRAIN_QUERY_CATEGORIES

static final java.lang.String AUTOMATIC_CONSTRAIN_QUERY_CATEGORIES

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. One use of this functionality is to automatically add the most relevant categories as constraints on the query itself, thus narrowing the search to the more appropriate content. These automatic constraints are controlled by the following attribute. The value is the maximum number of categories to add as constraints. Multiple categories are added as a Boolean OR of document set constraints, joined (i.e. AND-ed) to the pre-existing constraints. If the value is appended with a p, then the optional taxonomy pruning post-processing algorithm is used during categorization.

See Also:

Constant Field Values

SUGGEST_QUERY_CATEGORIES

static final java.lang.String SUGGEST_QUERY_CATEGORIES

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. One use of this functionality is to provide feedback to the end-user about the most relevant categories to the current query, allowing the end-user to manually refine (or narrow) the search. This categorization feedback is controlled by the following attribute. The value is the maximum number of categories to return in the feedback. If the max value is appended with a p, then the optional taxonomy pruning post-processing algorithm is used during categorization.

See Also:

Constant Field Values

RETURN_FEEDBACK

static final java.lang.String RETURN_FEEDBACK

ATG Search returns feedback about related terms and phrases for the query. This functionality is enabled by the following attribute. The value must be either true or false, and defaults to false.

See Also:

Constant Field Values

META_DATA_WEIGHTED_EXPRESSION_CONTRIBUTION

static final java.lang.String META_DATA_WEIGHTED_EXPRESSION_CONTRIBUTION

See Also:

Constant Field Values