com.primus.searchcommon.constants
Interface SimilarTextConstants

All Superinterfaces:

CommonRequestConstants

public interface SimilarTextConstants
extends CommonRequestConstants

Nested Class Summary

static class	SimilarTextConstants.InputType
static class	SimilarTextConstants.ResultCategorySortMode

Field Summary

static java.lang.String	INPUT_TYPE
static java.lang.String	ITEM_PROPERTY_CONTROL ATG Search returns the meta-data properties associated with the index item of each result.
static java.lang.String	MAX_RELATED_SETS The Similar Text request returns the retrieved documents that contain associated information, including the document sets (or categories) of the document.
static java.lang.String	MAXIMUM_RESULTS
static java.lang.String	PAGE_NUM
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	RELATED_SET_CONTROL The Similar Text request returns the retrieved documents that contain associated information, including the document sets (or categories) of the document.
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	SECONDARY_SORT_MODE
static java.lang.String	SECONDARY_SORT_ORDER Normally, ATG Search returns results 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.
static java.lang.String	SECONDARY_SORT_PROPERTY Normally, ATG Search returns results 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.
static java.lang.String	SECONDARY_SORT_PROPERTY_DEFAULT Normally, ATG Search returns results 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.

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

ADVANCED, DEBUG, DUMP_FILES, MERGE_SETTINGS

Field Detail

INPUT_TYPE

static final java.lang.String INPUT_TYPE

See Also:

Constant Field Values

MAXIMUM_RESULTS

static final java.lang.String MAXIMUM_RESULTS

See Also:

Constant Field Values

PAGE_NUM

static final java.lang.String PAGE_NUM

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

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 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

SECONDARY_SORT_MODE

static final java.lang.String SECONDARY_SORT_MODE

See Also:

Constant Field Values

SECONDARY_SORT_ORDER

static final java.lang.String SECONDARY_SORT_ORDER

Normally, ATG Search returns results 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 the final results are, just the order of the returned results. Secondary sorting is performed before paging. Secondary sorting is controlled by four attributes: DOC_SORT, DOC_SORT_ORDER, DOC_SORT_PROP, and DOC_SORT_PROP_DEFAULT.

The DOC_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

Normally, ATG Search returns results 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 the final results are, just the order of the returned results. Secondary sorting is performed before paging. Secondary sorting is controlled by four attributes: DOC_SORT, DOC_SORT_ORDER, DOC_SORT_PROP, and DOC_SORT_PROP_DEFAULT.

The DOC_SORT_PROP 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 DOC_SORT_PROP_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

Normally, ATG Search returns results 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 the final results are, just the order of the returned results. Secondary sorting is performed before paging. Secondary sorting is controlled by four attributes: DOC_SORT, DOC_SORT_ORDER, DOC_SORT_PROP, and DOC_SORT_PROP_DEFAULT.

The DOC_SORT_PROP 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 DOC_SORT_PROP_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

MAX_RELATED_SETS

static final java.lang.String MAX_RELATED_SETS

The Similar Text request returns the retrieved documents that 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_SETS 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

The Similar Text request returns the retrieved documents that 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_SETS attributes.

The RELATED_SETS 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

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