|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.AbstractCollection<E> java.util.AbstractList com.endeca.navigation.AssocDimLocationsList
public class AssocDimLocationsList
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 |
---|
public Object get(int index)
index
.
The object returned is of type AssocDimLocations
.
get
in interface List
get
in class AbstractList
index
- offset of the desired associated dimension location group.
AssocDimLocations
object at index
.
IndexOutOfBoundsException
- If the index is out of range.public AssocDimLocations getAssocDimLocations(long dimensionId)
dimensionId
. Returns null
if no dimension location group can be found with this dimension ID.
dimensionId
- ID of the dimension to which the dimension locations belong.
AssocDimLocations
object with a dimension ID of
dimensionId
. Returns null
if none
can be found.public AssocDimLocations getAssocDimLocations(String dimensionName)
dimensionName
. Returns null
if no dimension location group
can be found with this dimension name.
dimensionName
- name of the dimension to which the dimension locations belong.
AssocDimLocations
object with a dimension name of
dimensionName
. Returns null
if none
can be found.public int size()
size
in interface Collection
size
in interface List
size
in class AbstractCollection
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |