com.endeca.navigation
Class FieldList

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList
          com.endeca.navigation.FieldList

All Implemented Interfaces:

Iterable, Collection, List

public class FieldList
extends AbstractList
implements List

A list of Endeca property or dimension names that will be used to specify which values will be returned for each record in the result set of a navigation query. The ENEQuery.setSelection(FieldList) method is used to set the FieldList for the query.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

FieldList()
Constructs a new, empy FieldList.

Method Summary

void	addField(Dimension d) Appends the name of the specified dimension to the end of this list.
void	addField(Property p) Appends the name of the specified property to the end of this list.
void	addField(String s) Appends the specified dimension or property name to the end of this list.
Object	get(int index) Gets the object at position index.
Object	remove(int index) Removes the Endeca property or dimension at the specified position in this list.
int	size() Returns the number of Endeca property or dimension elements in this FieldList.

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, 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, removeAll, retainAll, set, subList, toArray, toArray

Constructor Detail

FieldList

public FieldList()

Constructs a new, empy FieldList.

Method Detail

addField

public void addField(Dimension d)

Appends the name of the specified dimension to the end of this list.

Parameters:

d - the Endeca dimension to be inserted. The name of the dimension is retrieved from the Dimension object and inserted into the list.

addField

public void addField(Property p)

Appends the name of the specified property to the end of this list.

Parameters:

p - the Endeca property to be inserted. The name of the property is retrieved from the Property object and inserted into the list.

addField

public void addField(String s)

Appends the specified dimension or property name to the end of this list.

Parameters:

s - the name of an Endeca dimension or property to be inserted.

remove

public Object remove(int index)

Removes the Endeca property or dimension at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.

Specified by:

remove in interface List

Overrides:

remove in class AbstractList

Parameters:

index - offset of the element to be removed.

Returns:

element previously at position index.

Throws:

IndexOutOfBoundsException - if index is out of range.

get

public Object get(int index)

Gets the object at position index.

Specified by:

get in interface List

Specified by:

get in class AbstractList

Parameters:

index - offset of the desired object.

Returns:

object at position index.

Throws:

IndexOutOfBoundsException - if index is out of range.

size

public int size()

Returns the number of Endeca property or dimension elements in this FieldList.

Specified by:

size in interface Collection

Specified by:

size in interface List

Specified by:

size in class AbstractCollection

Returns:

Number of elements in the list.