org.jpox.store.scostore
Interface ListStore

All Superinterfaces:

CollectionStore, Store

All Known Implementing Classes:

FKListStore, JoinListStore

public interface ListStore
extends CollectionStore

Interface representation of the backing store for a List. Takes the collection methods and extends them for lists.

Version:

$Revision: 1.4 $

Method Summary

void	add(StateManager ownerSM, int index, java.lang.Object element) Method to add an element to the List.
boolean	addAll(StateManager ownerSM, java.util.Collection c, boolean initialising) Method to add a collection of elements to the List.
boolean	addAll(StateManager ownerSM, int index, java.util.Collection c) Method to add a collection of elements to the List.
java.lang.Object	get(StateManager ownerSM, int index) Method to retrieve an element from a position in the List.
int	indexOf(StateManager ownerSM, java.lang.Object element) Method to return the position of an element in the List.
int	lastIndexOf(StateManager ownerSM, java.lang.Object element) Method to return the last position of an element in the List.
java.util.ListIterator	listIterator(StateManager ownerSM) Accessor for a list iterator for the List.
java.util.ListIterator	listIterator(StateManager ownerSM, int index) Accessor for a list iterator for the List.
java.lang.Object	remove(StateManager ownerSM, int index) Method to remove an element from the List.
java.lang.Object	set(StateManager ownerSM, int index, java.lang.Object element, boolean allowDependentField) Method to update an element at a position in the List.
java.util.List	subList(StateManager ownerSM, int from, int to) Accessor for a sublist of elements between from and to indices.

Methods inherited from interface org.jpox.store.scostore.CollectionStore

add, addAll, clear, contains, getElementType, getExistsSubquery, getSizeSubquery, hasOrderMapping, iterator, joinElementsTo, newQueryStatement, newResultObjectFactory, remove, removeAll, size, updateEmbeddedElement

Methods inherited from interface org.jpox.store.scostore.Store

getOwnerMapping, getStoreManager

Method Detail

add

void add(StateManager ownerSM,
         int index,
         java.lang.Object element)

Method to add an element to the List.

Parameters:

ownerSM - State Manager for the List.

index - Position to add the element.

element - Element to add

addAll

boolean addAll(StateManager ownerSM,
               int index,
               java.util.Collection c)

Method to add a collection of elements to the List.

Parameters:

ownerSM - State Manager for the List.

index - Position to add the elements.

c - Collection of elements to add

Returns:

Whether the elements were added ok

addAll

boolean addAll(StateManager ownerSM,
               java.util.Collection c,
               boolean initialising)

Method to add a collection of elements to the List.

Parameters:

ownerSM - State Manager for the List.

c - Collection of elements to add

initialising - Whether we are initialising the list with these elements

Returns:

Whether the elements were added ok

remove

java.lang.Object remove(StateManager ownerSM,
                        int index)

Method to remove an element from the List.

Parameters:

ownerSM - State Manager for the List.

index - Position to remove the element.

Returns:

The element that was removed.

get

java.lang.Object get(StateManager ownerSM,
                     int index)

Method to retrieve an element from a position in the List.

Parameters:

ownerSM - State Manager for the List.

index - Position of the element.

Returns:

The element at that position.

set

java.lang.Object set(StateManager ownerSM,
                     int index,
                     java.lang.Object element,
                     boolean allowDependentField)

Method to update an element at a position in the List.

Parameters:

ownerSM - State Manager for the List.

index - Position of the element.

element - The element value

allowDependentField - Whether to enable dependent field during this operation

Returns:

The previous element at that position.

subList

java.util.List subList(StateManager ownerSM,
                       int from,
                       int to)

Accessor for a sublist of elements between from and to indices.

Parameters:

ownerSM - State Manager for the List.

from - Start position (inclusive)

to - End position (exclusive)

Returns:

List of elements in this range.

indexOf

int indexOf(StateManager ownerSM,
            java.lang.Object element)

Method to return the position of an element in the List.

Parameters:

ownerSM - State Manager for the List.

element - The element value

Returns:

The position of the element.

lastIndexOf

int lastIndexOf(StateManager ownerSM,
                java.lang.Object element)

Method to return the last position of an element in the List.

Parameters:

ownerSM - State Manager for the List.

element - The element value

Returns:

The last position of the element.

listIterator

java.util.ListIterator listIterator(StateManager ownerSM)

Accessor for a list iterator for the List.

Parameters:

ownerSM - State Manager for the List.

Returns:

List iterator for the List.

listIterator

java.util.ListIterator listIterator(StateManager ownerSM,
                                    int index)

Accessor for a list iterator for the List.

Parameters:

ownerSM - State Manager for the List.

index - start position of the iterator.

Returns:

List iterator for the List.