com.endeca.navigation
Class DimLocationList
java.lang.Object
java.util.AbstractCollection<E>
java.util.AbstractList
com.endeca.navigation.DimLocationList
- All Implemented Interfaces:
- Iterable, Collection, List
public class DimLocationList
- extends AbstractList
- implements List
List containing dimension locations (DimLocation
objects).
The list implements java.util.List
.
Unlike AssocDimLocations
objects, the
DimLocation
objects in DimLocationList
can be from different dimensions. Therefore, the contents of a
DimLocationList
often contain values from different dimensions.
As such, the intended use of this class in the API is to return results
from a compound dimension search. Each individual compound dimension
search result is a DimLocationList
and typically
contains dimension values from multiple dimensions.
Note: DimLocationList
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
).
Method Summary |
Object |
get(int index)
Gets the dimension location at position index . |
int |
size()
Returns the number of DimLocation objects 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 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 |
get
public Object get(int index)
- Gets the dimension location at position
index
. The
object returned is of type DimLocation
.
- Specified by:
get
in interface List
- Specified by:
get
in class AbstractList
- Returns:
- The dimension location (
DimLocation
object) at offset index
.
size
public int size()
- Returns the number of
DimLocation
objects in this
list.
- Specified by:
size
in interface Collection
- Specified by:
size
in interface List
- Specified by:
size
in class AbstractCollection
- Returns:
- Size of list.
© 2008 Endeca Technologies, Inc.
Endeca Confidential