com.primus.searchcommon.constants
Interface BrowseConstants

All Superinterfaces:

CommonRequestConstants

public interface BrowseConstants
extends CommonRequestConstants

Nested Class Summary

static class	BrowseConstants.AncestryType
static class	BrowseConstants.BrowseType
static class	BrowseConstants.DescendentItemSortMode
static class	BrowseConstants.SecondarySortMode
static class	BrowseConstants.SecondarySortOrder

Field Summary

static java.lang.String	DESCENDENT_ITEM_SORT_MODE
static java.lang.String	INDEX_ITEM_DEPTH
static java.lang.String	MAX_RELATED_SETS ATG Search returns the retrieved index items along with the item sets.
static java.lang.String	MAXIMUM_DESCENDENT_DEPTH
static java.lang.String	MAXIMUM_DESCENDENT_SETS
static java.lang.String	MAXIMUM_DESCENDENT_SIZE
static java.lang.String	MAXIMUM_DESCENDENTS_PER_CHILD
static java.lang.String	MAXIMUM_INDEX_ITEMS_PER_SET
static java.lang.String	MAXIMUM_TOTAL_INDEX_ITEMS
static java.lang.String	MINIMUM_DESCENDENT_SIZE
static java.lang.String	PAGE_NUM
static java.lang.String	PAGE_SIZE The browse algorithm begins at the starting item set, and recursively descends to its children and their children.
static java.lang.String	RANK_CONFIG
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_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_SET_CONTROL ATG Search returns the retrieved index items along with the item sets.
static java.lang.String	SECONDARY_SORT_MODE Each returned item set may contain index items, depending on the other search parameters.
static java.lang.String	SECONDARY_SORT_ORDER Each returned item set may contain index items, depending on the other search parameters.
static java.lang.String	SECONDARY_SORT_PROPERTY Each returned item set may contain index items, depending on the other search parameters.
static java.lang.String	SECONDARY_SORT_PROPERTY_DEFAULT Each returned item set may contain index items, depending on the other search parameters.
static java.lang.String	TYPE Major type of browsing

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

ADVANCED, DEBUG, DUMP_FILES, MERGE_SETTINGS

Field Detail

TYPE

static final java.lang.String TYPE

Major type of browsing

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

The browse algorithm begins at the starting item set, and recursively descends to its children and their children. At each item set, the algorithm collects index items according to other parameters and returns some number of those. Because the number of index items may be great, parameters limit how many can be returned. The browse request also allows paging through of these index items, and it is controlled by two attributes: PAGE_NUM and PAGE_SIZE.

The PAGE_SIZE value specifies the size of the page. If size is empty or missing, no paging is performed. The paging calculation is based on the final browse results with respect to all other parameters. These attributes supercede the lastDoc attribute that was used in earlier versions.

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 the Admin Guide. This same process can execute during browse, using the index items of the starting item set for the calculation. At browse time, ATG Search can control which configuration to use and global parameters for the calculation, using 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_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 the Admin Guide. This same process can execute during browse, using the index items of the starting item set for the calculation. At browse 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 the Admin Guide. This same process can execute during browse, using the index items of the starting item set for the calculation. At browse 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 the Admin Guide. This same process can execute during browse, using the index items of the starting item set for the calculation. At browse time, ATG Search can 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

MAXIMUM_DESCENDENT_SETS

static final java.lang.String MAXIMUM_DESCENDENT_SETS

See Also:

Constant Field Values

MAX_RELATED_SETS

static final java.lang.String MAX_RELATED_SETS

ATG Search returns the retrieved index items along with the item sets. The retrieved items contain associated information, including the document sets (or categories) of the item. 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

ATG Search returns the retrieved index items along with the item sets. The retrieved items contain associated information, including the document sets (or categories) of the item. 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

MAXIMUM_DESCENDENT_DEPTH

static final java.lang.String MAXIMUM_DESCENDENT_DEPTH

See Also:

Constant Field Values

MAXIMUM_DESCENDENT_SIZE

static final java.lang.String MAXIMUM_DESCENDENT_SIZE

See Also:

Constant Field Values

MINIMUM_DESCENDENT_SIZE

static final java.lang.String MINIMUM_DESCENDENT_SIZE

See Also:

Constant Field Values

MAXIMUM_DESCENDENTS_PER_CHILD

static final java.lang.String MAXIMUM_DESCENDENTS_PER_CHILD

See Also:

Constant Field Values

MAXIMUM_TOTAL_INDEX_ITEMS

static final java.lang.String MAXIMUM_TOTAL_INDEX_ITEMS

See Also:

Constant Field Values

MAXIMUM_INDEX_ITEMS_PER_SET

static final java.lang.String MAXIMUM_INDEX_ITEMS_PER_SET

See Also:

Constant Field Values

INDEX_ITEM_DEPTH

static final java.lang.String INDEX_ITEM_DEPTH

See Also:

Constant Field Values

SECONDARY_SORT_MODE

static final java.lang.String SECONDARY_SORT_MODE

Each returned item set may contain index items, depending on the other search parameters. Normally, the index items are returned in index order, but user interfaces often allow the final results to be sorted by some secondary criteria, such as date or source or format. 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 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

Each returned item set may contain index items, depending on the other search parameters. Normally, the index items are returned in index order, but user interfaces often allow the final results to be sorted by some secondary criteria, such as date or source or format. 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

RANK_CONFIG

static final java.lang.String RANK_CONFIG

See Also:

Constant Field Values

SECONDARY_SORT_PROPERTY

static final java.lang.String SECONDARY_SORT_PROPERTY

Each returned item set may contain index items, depending on the other search parameters. Normally, the index items are returned in index order, but user interfaces often allow the final results to be sorted by some secondary criteria, such as date or source or format. 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

Each returned item set may contain index items, depending on the other search parameters. Normally, the index items are returned in index order, but user interfaces often allow the final results to be sorted by some secondary criteria, such as date or source or format. 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

DESCENDENT_ITEM_SORT_MODE

static final java.lang.String DESCENDENT_ITEM_SORT_MODE

See Also:

Constant Field Values