com.endeca.navigation
Class DimLocation

java.lang.Object
  com.endeca.navigation.DimLocation

public class DimLocation
extends Object

A class representing a specific location in a dimension. The dimension location comprises one dimension value (DimVal object) and a DimValList that contains all of the dimension locations' ancestors (also DimVal objects) up to, but not including, the dimension root.

DimLocation objects are returned as part of an Endeca record, via an AssocDimLocationsList object in the ERec data structure. The dimension locations designate the record's location within the dimension hierarchy.

Note that when returned in an AssocDimLocations object, the dimension locations are all from the same dimension. However, when returned in a DimLocationList, the dimension locations can be from different dimensions (which is typically the result of a compound dimension search).

Method Summary

DimValList	getAncestors() Gets the ancestors of the dimension location.
DimVal	getDimValue() Gets the dimension value of this dimension location.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDimValue

public DimVal getDimValue()

Gets the dimension value of this dimension location.

Returns:

The dimension value (DimVal object) of this DimLocation.

getAncestors

public DimValList getAncestors()

Gets the ancestors of the dimension location. Ancestors are ordered from parent to child (the list does not include the dimension root).

Returns:

A DimValList object containing the ancestors of this dimension location.