com.endeca.navigation
Class AssocDimLocationsList

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

public class AssocDimLocationsList
extends AbstractList
implements List

The class encapsulates a list of associated dimension location groups (AssocDimLocations objects). The list is exposed as a java.util.List. For a given AssocDimLocations, the dimension locations are all from the same dimension.

Note: AssocDimLocationsList 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 index)
          Gets the associated dimension location group at position index.
 AssocDimLocations getAssocDimLocations(long dimensionId)
          Gets the associated dimension group that is from the dimension whose ID is dimensionId.
 AssocDimLocations getAssocDimLocations(String dimensionName)
          Gets the associated dimension group that is from the dimension named dimensionName.
 int size()
          Gets the number of associated dimension location groups in this 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 index)
Gets the associated dimension location group at position index. The object returned is of type AssocDimLocations.

Specified by:
get in interface List
Specified by:
get in class AbstractList
Parameters:
index - offset of the desired associated dimension location group.
Returns:
AssocDimLocations object at index.
Throws:
IndexOutOfBoundsException - If the index is out of range.

getAssocDimLocations

public AssocDimLocations getAssocDimLocations(long dimensionId)
Gets the associated dimension group that is from the dimension whose ID is dimensionId. Returns null if no dimension location group can be found with this dimension ID.

Parameters:
dimensionId - ID of the dimension to which the dimension locations belong.
Returns:
AssocDimLocations object with a dimension ID of dimensionId. Returns null if none can be found.

getAssocDimLocations

public AssocDimLocations getAssocDimLocations(String dimensionName)
Gets the associated dimension group that is from the dimension named dimensionName. Returns null if no dimension location group can be found with this dimension name.

Parameters:
dimensionName - name of the dimension to which the dimension locations belong.
Returns:
AssocDimLocations object with a dimension name of dimensionName. Returns null if none can be found.

size

public int size()
Gets the number of associated dimension location groups in this list.

Specified by:
size in interface Collection
Specified by:
size in interface List
Specified by:
size in class AbstractCollection
Returns:
Number of associated dimension location groups in list.


2010 Endeca Technologies, Inc.
Endeca Confidential