org.noorm.jdbc

Class PageableBeanList<T extends IBean>

java.lang.Object

org.noorm.jdbc.PageableBeanList<T>

All Implemented Interfaces:

Serializable, Iterable<T>, Collection<T>, List<T>

public class PageableBeanList<T extends IBean>
extends Object
implements Serializable, List<T>

Pageable list to provide detached access to data from a data source. Instead of backing the complete contents of the respective data objects, this list only stores an array of Ids, assuming that each data object is uniquely identified by an Id of type Long. The list primarily overrides method subList to retrieve the required page on demand, passing the Ids contained in the requested sublist to the repository responsible for the data object type. This mechanism does not only avoid re-issuing the complete initial query, the list is based on, but also guarantees a consistent snapshot based on the time the initial query was issued (at least, as long no data has been deleted in between). The PageableDataList has also a second backing store for the Beans themselves. This second backing store, the "preFetchArray" is initially empty, but stores the Beans retrieved by calls to subList(). This avoids multiple calls to the same record.

Author:

Ulf Pietruschka / ulf.pietruschka@etenso.com

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PageableBeanList.BeanTransformer<T>

Constructor Summary

Constructors

Constructor and Description
PageableBeanList(Long[] pIDArray, String pPLSQLIdListCallable, String pRefCursorName, String pIDListName, Class pBeanClass)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, T element)
boolean	add(T o)
boolean	addAll(Collection c)
boolean	addAll(int index, Collection c)
void	addBeanTransformer(PageableBeanList.BeanTransformer<T> pBeanTransformer)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
T	get(int pIndex) Throws an UnsupportedOperationException.
PageableBeanList.BeanTransformer	getBeanTransformer()
int	indexOf(Object o)
boolean	isEmpty()
Iterator<T>	iterator()
int	lastIndexOf(Object o)
ListIterator<T>	listIterator()
ListIterator<T>	listIterator(int index)
T	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection c)
void	removeBeanTransformer()
boolean	retainAll(Collection c)
IBean	set(int index, IBean element)
int	size()
List<T>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.List

equals, hashCode

Constructor Detail

PageableBeanList

public PageableBeanList(Long[] pIDArray,
                String pPLSQLIdListCallable,
                String pRefCursorName,
                String pIDListName,
                Class pBeanClass)

Method Detail

subList

public List<T> subList(int fromIndex,
              int toIndex)

Specified by:

subList in interface List<T extends IBean>

addBeanTransformer

public void addBeanTransformer(PageableBeanList.BeanTransformer<T> pBeanTransformer)

getBeanTransformer

public PageableBeanList.BeanTransformer getBeanTransformer()

removeBeanTransformer

public void removeBeanTransformer()

add

public boolean add(T o)

Specified by:

add in interface Collection<T extends IBean>

Specified by:

add in interface List<T extends IBean>

addAll

public boolean addAll(Collection c)

Specified by:

addAll in interface Collection<T extends IBean>

Specified by:

addAll in interface List<T extends IBean>

add

public void add(int index,
       T element)

Specified by:

add in interface List<T extends IBean>

addAll

public boolean addAll(int index,
             Collection c)

Specified by:

addAll in interface List<T extends IBean>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T extends IBean>

Specified by:

remove in interface List<T extends IBean>

remove

public T remove(int index)

Specified by:

remove in interface List<T extends IBean>

removeAll

public boolean removeAll(Collection c)

Specified by:

removeAll in interface Collection<T extends IBean>

Specified by:

removeAll in interface List<T extends IBean>

retainAll

public boolean retainAll(Collection c)

Specified by:

retainAll in interface Collection<T extends IBean>

Specified by:

retainAll in interface List<T extends IBean>

clear

public void clear()

Specified by:

clear in interface Collection<T extends IBean>

Specified by:

clear in interface List<T extends IBean>

get

public T get(int pIndex)

Throws an UnsupportedOperationException. Could be implemented using a single round-trip to the data-source for a single data object, which is not the desired behaviour.

Specified by:

get in interface List<T extends IBean>

Parameters:

pIndex - position of the element.

Returns:

the element at the position given with index pIndex

size

public int size()

Specified by:

size in interface Collection<T extends IBean>

Specified by:

size in interface List<T extends IBean>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T extends IBean>

Specified by:

isEmpty in interface List<T extends IBean>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T extends IBean>

Specified by:

contains in interface List<T extends IBean>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends IBean>

Specified by:

iterator in interface Collection<T extends IBean>

Specified by:

iterator in interface List<T extends IBean>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T extends IBean>

Specified by:

toArray in interface List<T extends IBean>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<T extends IBean>

Specified by:

toArray in interface List<T extends IBean>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T extends IBean>

Specified by:

containsAll in interface List<T extends IBean>

set

public IBean set(int index,
        IBean element)

Specified by:

set in interface List<T extends IBean>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<T extends IBean>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<T extends IBean>

listIterator

public ListIterator<T> listIterator()

Specified by:

listIterator in interface List<T extends IBean>

listIterator

public ListIterator<T> listIterator(int index)

Specified by:

listIterator in interface List<T extends IBean>