|
|||||||||
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.DimensionList
public class DimensionList
List of dimensions (Dimension
objects).
Note: DimensionList
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 Dimension at index index . |
Dimension |
getDimension(long dimensionId)
Gets the dimension with the ID dimensionId from this
list. |
Dimension |
getDimension(String dimensionName)
Gets the dimension with the name dimensionName from
this list. |
int |
size()
Returns the number of dimensions 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 int size()
size
in interface Collection
size
in interface List
size
in class AbstractCollection
public Object get(int index)
Dimension
at index index
. If
index
is less than 0 or greater than or equal to the
size of the list, throws ArrayIndexOutOfBoundsException
.
get
in interface List
get
in class AbstractList
index
- offset of the desired dimension.
Dimension
at index index
.
ArrayIndexOutOfBoundsException
- Index out of range.public Dimension getDimension(long dimensionId)
dimensionId
from this
list. If the dimension is not found in this list null
is returned.
Note that when dealing with multi-select dimensions, it is possible
for the list to have multiple Dimension
objects for the same dimension.
In this case, several share the same ID and this method does not
define which one is returned.
dimensionId
- ID of the desired dimension.
Dimension
with the ID dimensionId
or
null
if the dimension is not found.public Dimension getDimension(String dimensionName)
dimensionName
from
this list. If the dimension is not found in this list,
null
is returned.
Note that if several dimensions share the same name, this method does not define which one is returned.
dimensionName
- name of the desired dimension.
Dimension
with the name dimensionName
or
null
if the dimension is not found.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |