com.endeca.navigation
Class DimValList

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList
          extended by com.endeca.navigation.DimValList
All Implemented Interfaces:
Iterable, Collection, List

public class DimValList
extends AbstractList
implements List

A list of dimension values (DimVal objects). DimValList objects are returned from the MDEX Engine by various methods. For example, the Dimension.getRefinements() method returns a DimValList object containing the refinements in a given dimension.

A DimValIdList is a list of dimension value IDs, while a DimValList is a list of the actual dimension values (DimVal objects).

Note: DimValList objects are unmodifiable and therefore do not support any modification operations (such as add, remove, and clear) that are inherited. Attempting to modify the object may result in a runtime exception (UnsupportedOperationException).


Field Summary
 
Fields inherited from class java.util.AbstractList
modCount
 
Method Summary
 Object get(int i)
          Gets the DimVal at index i.
 DimVal getDimValue(int i)
          Gets the DimVal at index i.
 int size()
          Gets the size of the list.
 
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

get

public Object get(int i)
Gets the DimVal at index i. If i is not greater than 0 and not less than the size of the list, throws ArrayIndexOutOfBoundsException.

Specified by:
get in interface List
Specified by:
get in class AbstractList
Returns:
The DimVal at index i.
Throws:
ArrayIndexOutOfBoundsException - Index out of range.

getDimValue

public DimVal getDimValue(int i)
Gets the DimVal at index i. If i is less than zero or greater than or equal to the size of the list, throws ArrayIndexOutOfBoundsException.

Returns:
The DimVal at index i.
Throws:
ArrayIndexOutOfBoundsException - Index out of range.

size

public int size()
Gets the size of the list.

Specified by:
size in interface Collection
Specified by:
size in interface List
Specified by:
size in class AbstractCollection
Returns:
The number of dimension values in this list.


2010 Endeca Technologies, Inc.
Endeca Confidential