|
|||||||||
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.DimValIdList
public class DimValIdList
Every dimension value (DimVal
object) has a unique ID.
A DimValIdList
object contains a list of dimension value IDs.
Typically, the developer does not create and populate the DimValIdList
object,
but instead it is returned by methods such as ENEQuery.getDimSearchDimensions()
.
Note that while DimValIdList
objects are lists of dimension value IDs,
DimValList
objects are lists of the actual dimension values.
DimValIdList
objects are primarily used to generate MDEX Engine
queries. For example, dimension value IDs are used before executing a basic navigation query,
as the input argument to the ENEQuery.setNavDescriptors(DimValIdList)
method.
There will be a one-to-one mapping between the IDs in the DimValIdList
argument
and the dimension values (DimVal
objects) that are returned by the query.
Field Summary |
---|
Fields inherited from class java.util.AbstractList |
---|
modCount |
Constructor Summary | |
---|---|
DimValIdList()
Default constructor that will contain an empty list. |
|
DimValIdList(DimValList values)
Constructor that takes a dimension value list and extracts the IDs from the DimVal objects in the list. |
|
DimValIdList(String ids)
Constructor that takes a string-based set of dimension value IDs, and parses and populates the list with the string. |
Method Summary | |
---|---|
void |
addDimValue(DimVal val)
Adds a dimension value ID to the DimValIdList list. |
void |
addDimValueId(long id)
Adds a dimension value ID to the DimValIdList list. |
Object |
get(int index)
Gets the element at position index . |
long |
getDimValueId(int i)
Gets a dimension value ID from the DimValIdList object. |
Object |
remove(int index)
Removes the element at the specified position in this list. |
int |
size()
Returns the number of dimension value IDs in this list. |
String |
toString()
Generates the string-based representation of the list by returning a space-delimited sequence of dimension value IDs. |
Methods inherited from class java.util.AbstractList |
---|
add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, set, subList |
Methods inherited from class java.util.AbstractCollection |
---|
addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray |
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, removeAll, retainAll, set, subList, toArray, toArray |
Constructor Detail |
---|
public DimValIdList()
public DimValIdList(String ids)
ids
- a space-delimited sequence of dimension value IDs.public DimValIdList(DimValList values)
DimVal
objects in the list.
values
- DimValList
object from which the IDs will be extracted.Method Detail |
---|
public void addDimValueId(long id)
DimValIdList
list.
id
- a dimension value ID to add to the list.public void addDimValue(DimVal val)
DimValIdList
list.
The ID is extracted from val
, which is a dimension value.
val
- DimVal
object from which the ID will be extracted.public long getDimValueId(int i)
DimValIdList
object.
i
.public Object remove(int index)
remove
in interface List
remove
in class AbstractList
index
- The offset of the element in the list.
index
.
IndexOutOfBoundsException
- If the index is out of range.public Object get(int index)
index
. Object
returned is of type Long
. Use of this method is not recommended
as object returned is of type Long
.
Interface present for List
interface.
get
in interface List
get
in class AbstractList
index
- Offset of element.
index
.
IndexOutOfBoundsException
- If the index is out of range.public int size()
size
in interface Collection
size
in interface List
size
in class AbstractCollection
public String toString()
toString
in class AbstractCollection
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |