Retrieving refinement dimensions

The first step in displaying refinements is to retrieve the dimensions that potentially have refinements.

Refinement dimensions contain refinement dimension values for the current record set, including both standard refinements and implicit refinements.

Descriptor dimensions contain the dimension values (or descriptors) that were used to query for the current record set. Integrated dimensions represent a consolidation of those dimensions that contain either descriptors or refinement values for the current record set.

Complete dimensions represent a consolidation of all dimensions that have at least one of the following: a descriptor, a standard refinement, or an implicit refinement.

Accessing refinement dimension values for a given Navigation query begins with accessing the Navigation object from the query results object. Once an application has retrieved the Navigation object, there are a number of methods for accessing dimensions that contain dimension values.

The following calls access dimensions directly:

API method or property

Purpose

Java: Navigation.getRefinementDimensions()

.NET: Navigation.RefinementDimensions

Returns a DimensionList object that has dimensions that potentially still have refinements available with respect to this query.

Java: Navigation.getDescriptorDimensions()

.NET: Navigation.DescriptorDimensions

Returns a DimensionList object that has the dimensions for the descriptors for this navigation.

Java: Navigation.getIntegratedDimensions()

.NET: Navigation.IntegratedDimensions

Returns a DimensionList object that has the dimensions integrated from the refinement dimensions and the descriptor dimensions.

Java: Navigation.getCompleteDimensions()

.NET: Navigation.CompleteDimensions

Returns a DimensionList object that has the complete dimensions integrated from the refinement dimensions, the descriptor dimensions, and those that are completely implicit.

The following calls access dimension groups directly:

API method or property

Purpose

Java: Navigation.getRefinementDimGroups()

.NET: Navigation.RefinementDimGroups

Returns a DimGroupList object that contains the dimensions that potentially have refinements available in the current navigation state.

Java: Navigation.getDescriptorDimGroups()

.NET: Navigation.DescriptorDimGroups

Returns a DimGroupList object that contains the dimension groups of the dimensions for the descriptors for this navigation.

Java: Navigation.getIntegratedDimGroups()

.NET: Navigation.IntegratedDimGroups

Returns a DimGroupList object that contains the dimension groups of the dimensions integrated from the refinement and descriptor dimensions.

Java: Navigation.getCompleteDimGroups()

.NET: Navigation.CompleteDimGroups

Returns a DimGroupList object that contains the dimension groups of the complete dimensions integrated from the refinement dimensions, the descriptor dimensions, and those that are completely implicit.

Copyright © Legal Notices