com.endeca.navigation
Class DimensionSearchResultGroup

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList
          com.endeca.navigation.DimensionSearchResultGroup

All Implemented Interfaces:

Iterable, Collection, List

public class DimensionSearchResultGroup
extends AbstractList
implements List

Class encapsulating a group of value intersection references that all share a similar set of dimensions, corresponding to the a result group for a dimension search. Every set of values in this group are from the same set of dimensions.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Method Summary

Object	get(int i) Gets the navigation reference at position i.
DimValList	getRoots() Gets the roots of this result group.
long	getTotalNumResults() Return the total number of results for this result group, which may be larger than the number of results actually included, depending on the dimension search query parameters.
int	size() Gets the number of results actually stored in the group.

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, subList, toArray, toArray

Method Detail

getRoots

public DimValList getRoots()

Gets the roots of this result group.

Returns:

Roots of this result group.

get

public Object get(int i)

Gets the navigation reference at position i. Object returned of type DimLocationList.

Specified by:

get in interface List

Specified by:

get in class AbstractList

Parameters:

i - Position of navigation reference to return.

Returns:

Navigation reference at position i.

getTotalNumResults

public long getTotalNumResults()

Return the total number of results for this result group, which may be larger than the number of results actually included, depending on the dimension search query parameters.

Returns:

Total number of results for the group.

size

public int size()

Gets the number of results actually stored in the group.

Specified by:

size in interface Collection

Specified by:

size in interface List

Specified by:

size in class AbstractCollection

Returns:

Number of results in the group.