com.endeca.navigation
Class DimGroupList
java.lang.Object
java.util.AbstractCollection<E>
java.util.AbstractList
com.endeca.navigation.DimGroupList
- All Implemented Interfaces:
- Iterable, Collection, List
public class DimGroupList
- extends AbstractList
- implements List
List of dimension groups (DimGroup
objects) exposed as a java.util.List
.
The dimension groups can be explicit dimension groups (which have a name and a unique ID)
or implicit dimension groups (which have no name and an ID of zero).
Note: DimGroupList
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 group at position index . |
DimGroup |
getDimGroup(String dimensionGroupName)
Gets the dimension group with the name
dimensionGroupName from
this list. |
int |
size()
Returns the number of dimension 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 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 |
size
public int size()
- Returns the number of dimension 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 dimension groups in the list.
get
public Object get(int index)
- Gets the dimension group at position
index
. Dimension
group returned is of type DimGroup
.
- Specified by:
get
in interface List
- Specified by:
get
in class AbstractList
- Parameters:
index
- offset of the desired dimension group.
- Returns:
- Dimension group at position
index
.
- Throws:
IndexOutOfBoundsException
- If the index is out of range.
getDimGroup
public DimGroup getDimGroup(String dimensionGroupName)
- Gets the dimension group with the name
dimensionGroupName
from
this list. If the dimension group is not found in this list,
null
is returned.
- Returns:
DimGroup
with the name
dimensionGroupName
or null
if the
dimension was not found.
© 2003, 2012 Oracle and/or its affiliates. All rights reserved.