com.endeca.navigation
Class DimSearchRefinementConfigList

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

All Implemented Interfaces:

Iterable, Collection, List

public class DimSearchRefinementConfigList
extends AbstractList
implements List

Class that encapsulates a collection of refinement configs for dimension value search (DimSearchRefinementConfig objects).

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

DimSearchRefinementConfigList()
Default constructor that creates an empty list.

Method Summary

void	add(int index, Object elementAt) Inserts the specified DimSearchRefinementConfig at the specified position in this list.
Object	get(int index) Gets the DimSearchRefinementConfig at position index.
GlobalDimSearchRefinementConfig	getGlobalDimSearchRefinementConfig() Gets the GlobalDimSearchRefinementConfig.
void	setGlobalDimSearchRefinementConfig(GlobalDimSearchRefinementConfig config) Sets the GlobalDimSearchRefinementConfig object.
int	size() Returns the number of elements in this list.
String	toString() Returns the string representation of the dynamic refinement config list.

Methods inherited from class java.util.AbstractList

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

add, addAll, addAll, clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, subList, toArray, toArray

Constructor Detail

DimSearchRefinementConfigList

public DimSearchRefinementConfigList()

Default constructor that creates an empty list.

Method Detail

add

public void add(int index,
                Object elementAt)

Inserts the specified DimSearchRefinementConfig at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Specified by:

add in interface List

Overrides:

add in class AbstractList

Parameters:

index - Offset of the element.

elementAt - DimSearchRefinementConfig object to be inserted.

Throws:

IndexOutOfBoundsException - If index is out of range.

get

public Object get(int index)

Gets the DimSearchRefinementConfig at position index.

Specified by:

get in interface List

Specified by:

get in class AbstractList

Parameters:

index - Offset of element.

Returns:

DimSearchRefinementConfig object at position index.

Throws:

IndexOutOfBoundsException - If index is out of range.

size

public int size()

Returns the number of elements in this list.

Specified by:

size in interface Collection

Specified by:

size in interface List

Specified by:

size in class AbstractCollection

Returns:

Number of elements (DimSearchRefinementConfig objects) in the list.

setGlobalDimSearchRefinementConfig

public void setGlobalDimSearchRefinementConfig(GlobalDimSearchRefinementConfig config)

Sets the GlobalDimSearchRefinementConfig object. This object is used to store config applicable to all the dimensions in the dimension search.

Parameters:

config - a filled GlobalDimSearchRefinementConfig object.

getGlobalDimSearchRefinementConfig

public GlobalDimSearchRefinementConfig getGlobalDimSearchRefinementConfig()

Gets the GlobalDimSearchRefinementConfig. This object can contain config applicable to all the dimensions in the dimension search.

Returns:

GlobalDimSearchRefinementConfig object.

toString

public String toString()

Returns the string representation of the dynamic refinement config list.

Overrides:

toString in class AbstractCollection

Returns:

The string representation of the dynamic refinement config list.