org.datanucleus.store.query

Class AbstractLazyLoadList

java.lang.Object

org.datanucleus.store.query.AbstractLazyLoadList

All Implemented Interfaces:

Iterable, Collection, List

Direct Known Subclasses:

AbstractCandidateLazyLoadList

public abstract class AbstractLazyLoadList
extends Object
implements List

Abstract implementation of a lazy loaded list of (persistent) objects. Needs to be extended to implement the

retrieveObjectForIndex()

method to retrieve the object at the specified index from whatever datasource is being used, and to implement the

getSize()

method to return the size of the list. The "datasource" could be results for a query, or a connection to a datastore, or whatever ... just a source of objects. TODO Change Localised message numbers to be generic

Field Summary

Fields

Modifier and Type	Field and Description
protected static Localiser	LOCALISER Localiser for messages.
protected int	size Cached size of the list.

Constructor Summary

Constructors

Constructor and Description
AbstractLazyLoadList(String cacheType) Constructor for a lazy load list.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, Object element)
boolean	add(Object e)
boolean	addAll(Collection c)
boolean	addAll(int index, Collection c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection c)
Object	get(int index)
protected abstract int	getSize() Method to return the size of the list.
int	indexOf(Object o)
boolean	isEmpty()
protected boolean	isOpen() Accessor whether the list is open.
Iterator	iterator()
int	lastIndexOf(Object o)
ListIterator	listIterator()
ListIterator	listIterator(int index)
Object	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection c)
boolean	retainAll(Collection c)
protected abstract Object	retrieveObjectForIndex(int index) Accessor to retrieve the object at an index.
Object	set(int index, Object element)
int	size()
List	subList(int fromIndex, int toIndex)
Object[]	toArray()
Object[]	toArray(Object[] 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

Field Detail

LOCALISER

protected static final Localiser LOCALISER

Localiser for messages.

size

protected int size

Cached size of the list. -1 when not known.

Constructor Detail

AbstractLazyLoadList

public AbstractLazyLoadList(String cacheType)

Constructor for a lazy load list.

Parameters:

cacheType - Type of caching of objects in the list

Method Detail

retrieveObjectForIndex

protected abstract Object retrieveObjectForIndex(int index)

Accessor to retrieve the object at an index. Is only called if the object is not currently cached.

Parameters:

index - The list index

Returns:

The object

getSize

protected abstract int getSize()

Method to return the size of the list.

Returns:

The size

isOpen

protected boolean isOpen()

Accessor whether the list is open. Always open in this implementation but can be overridden if you want to allow closure.

Returns:

Whether it is open.

add

public void add(int index,
       Object element)

Specified by:

add in interface List

add

public boolean add(Object e)

Specified by:

add in interface Collection

Specified by:

add in interface List

addAll

public boolean addAll(Collection c)

Specified by:

addAll in interface Collection

Specified by:

addAll in interface List

addAll

public boolean addAll(int index,
             Collection c)

Specified by:

addAll in interface List

clear

public void clear()

Specified by:

clear in interface Collection

Specified by:

clear in interface List

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection

Specified by:

contains in interface List

containsAll

public boolean containsAll(Collection c)

Specified by:

containsAll in interface Collection

Specified by:

containsAll in interface List

get

public Object get(int index)

Specified by:

get in interface List

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection

Specified by:

isEmpty in interface List

iterator

public Iterator iterator()

Specified by:

iterator in interface Iterable

Specified by:

iterator in interface Collection

Specified by:

iterator in interface List

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List

listIterator

public ListIterator listIterator()

Specified by:

listIterator in interface List

listIterator

public ListIterator listIterator(int index)

Specified by:

listIterator in interface List

remove

public Object remove(int index)

Specified by:

remove in interface List

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection

Specified by:

remove in interface List

removeAll

public boolean removeAll(Collection c)

Specified by:

removeAll in interface Collection

Specified by:

removeAll in interface List

retainAll

public boolean retainAll(Collection c)

Specified by:

retainAll in interface Collection

Specified by:

retainAll in interface List

set

public Object set(int index,
         Object element)

Specified by:

set in interface List

size

public int size()

Specified by:

size in interface Collection

Specified by:

size in interface List

subList

public List subList(int fromIndex,
           int toIndex)

Specified by:

subList in interface List

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection

Specified by:

toArray in interface List

toArray

public Object[] toArray(Object[] a)

Specified by:

toArray in interface Collection

Specified by:

toArray in interface List