org.datanucleus.store.types.sco.simple
Class List

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList
          org.datanucleus.store.types.sco.simple.List

All Implemented Interfaces:

Serializable, Cloneable, Iterable, Collection, List, SCO, SCOCollection, SCOContainer, SCOList

Direct Known Subclasses:

List

public class List
extends AbstractList
implements SCOList, Cloneable, Serializable

A mutable second-class List object. This is the simplified form that intercepts mutators and marks the field as dirty. It also handles cascade-delete triggering for persistable elements.

See Also:

Serialized Form

Field Summary

protected ArrayList	delegate The internal "delegate".
protected String	fieldName
protected int	fieldNumber
protected static Localiser	LOCALISER
protected ObjectProvider	ownerSM

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

List(ObjectProvider ownerSM, String fieldName)
Constructor, using the StateManager of the "owner" and the field name.

Method Summary

void	add(int index, Object element) Method to add an element to the List at a position.
boolean	add(Object element) Method to add an element to the List
boolean	addAll(Collection elements) Method to add a Collection to the ArrayList.
boolean	addAll(int index, Collection elements) Method to add a collection of elements.
void	attachCopy(Object value) Method to return an attached copy of the passed (detached) value.
void	clear() Method to clear the List
Object	clone() Creates and returns a copy of this object.
boolean	contains(Object element) Accessor for whether an element is contained in the List.
boolean	containsAll(Collection c) Accessor for whether a collection of elements are contained here.
Object	detachCopy(FetchPlanState state) Method to return a detached copy of the container.
boolean	equals(Object o) Equality operator.
void	flush() Method to flush the changes to the datastore when operating in queued mode.
Object	get(int index) Method to retrieve an element no.
String	getFieldName() Accessor for the field name.
Object	getOwner() Accessor for the owner object.
Object	getValue() Accessor for the unwrapped value that we are wrapping.
int	hashCode() Hashcode operator.
int	indexOf(Object element) Method to the position of an element.
void	initialise() Method to initialise the SCO for use.
void	initialise(Object o, boolean forInsert, boolean forUpdate) Method to initialise the SCO from an existing value.
boolean	isEmpty() Accessor for whether the List is empty.
boolean	isLoaded() Method to return if the SCO has its contents loaded.
Iterator	iterator() Accessor for an iterator for the List
int	lastIndexOf(Object element) Method to retrieve the last position of the element.
ListIterator	listIterator() Method to retrieve a List iterator for the list.
ListIterator	listIterator(int index) Method to retrieve a List iterator for the list from the index.
void	load() Method to effect the load of the data in the SCO.
void	makeDirty() Utility to mark the object as dirty
Object	remove(int index) Method to remove an element from the ArrayList.
boolean	remove(Object element) Method to remove an element from the List
boolean	remove(Object element, boolean allowCascadeDelete) Method to remove an element from the List
boolean	removeAll(Collection elements) Method to remove a collection of elements from the List.
boolean	retainAll(Collection c) Method to retain a Collection of elements (and remove all others).
Object	set(int index, Object element) Method to set the element at a position in the ArrayList.
Object	set(int index, Object element, boolean allowDependentField) wrapper addition that allows turning off of the dependent-field checks when doing the position setting.
int	size() Accessor for the size of the List
List	subList(int from, int to) Accessor for the subList of elements between from and to of the List
Object[]	toArray() Method to return the List as an array.
Object[]	toArray(Object[] a) Method to return the List as an array.
void	unsetOwner() Method to unset the owner and field information.
void	updateEmbeddedElement(Object element, int fieldNumber, Object value) Method to update an embedded element in this collection.
protected Object	writeReplace() The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream.

Methods inherited from class java.util.AbstractList

removeRange

Methods inherited from class java.util.AbstractCollection

toString

Methods inherited from class java.lang.Object

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

Field Detail

LOCALISER

protected static final Localiser LOCALISER

ownerSM

protected ObjectProvider ownerSM

fieldName

protected String fieldName

fieldNumber

protected int fieldNumber

delegate

protected ArrayList delegate

The internal "delegate".

Constructor Detail

List

public List(ObjectProvider ownerSM,
            String fieldName)

Constructor, using the StateManager of the "owner" and the field name.

Parameters:

ownerSM - The owner StateManager

fieldName - The name of the field of the SCO.

Method Detail

initialise

public void initialise(Object o,
                       boolean forInsert,
                       boolean forUpdate)

Method to initialise the SCO from an existing value.

Specified by:

initialise in interface SCO

Parameters:

o - The object to set from

forInsert - Whether the object needs inserting in the datastore with this value

forUpdate - Whether to update the datastore with this value

initialise

public void initialise()

Method to initialise the SCO for use.

Specified by:

initialise in interface SCO

getValue

public Object getValue()

Accessor for the unwrapped value that we are wrapping.

Specified by:

getValue in interface SCO

Returns:

The unwrapped value

load

public void load()

Method to effect the load of the data in the SCO. Used when the SCO supports lazy-loading to tell it to load all now.

Specified by:

load in interface SCOContainer

isLoaded

public boolean isLoaded()

Method to return if the SCO has its contents loaded. Returns true.

Specified by:

isLoaded in interface SCOContainer

Returns:

Whether it is loaded

flush

public void flush()

Method to flush the changes to the datastore when operating in queued mode. Does nothing in "direct" mode.

Specified by:

flush in interface SCOContainer

updateEmbeddedElement

public void updateEmbeddedElement(Object element,
                                  int fieldNumber,
                                  Object value)

Method to update an embedded element in this collection.

Specified by:

updateEmbeddedElement in interface SCOCollection

Parameters:

element - The element

fieldNumber - Number of field in the element

value - New value for this field

getFieldName

public String getFieldName()

Accessor for the field name.

Specified by:

getFieldName in interface SCO

Returns:

The field name

getOwner

public Object getOwner()

Accessor for the owner object.

Specified by:

getOwner in interface SCO

Returns:

The owner object

unsetOwner

public void unsetOwner()

Method to unset the owner and field information.

Specified by:

unsetOwner in interface SCO

makeDirty

public void makeDirty()

Utility to mark the object as dirty

detachCopy

public Object detachCopy(FetchPlanState state)

Method to return a detached copy of the container. Recurse sthrough the elements so that they are likewise detached.

Specified by:

detachCopy in interface SCO

Parameters:

state - State for detachment process

Returns:

The detached container

attachCopy

public void attachCopy(Object value)

Method to return an attached copy of the passed (detached) value. The returned attached copy is a SCO wrapper. Goes through the existing elements in the store for this owner field and removes ones no longer present, and adds new elements. All elements in the (detached) value are attached.

Specified by:

attachCopy in interface SCO

Parameters:

value - The new (collection) value

clone

public Object clone()

Creates and returns a copy of this object.

Mutable second-class Objects are required to provide a public clone method in order to allow for copying PersistenceCapable objects. In contrast to Object.clone(), this method must not throw a CloneNotSupportedException.

Specified by:

clone in interface SCO

Overrides:

clone in class Object

Returns:

The cloned object

contains

public boolean contains(Object element)

Accessor for whether an element is contained in the List.

Specified by:

contains in interface Collection

Specified by:

contains in interface List

Overrides:

contains in class AbstractCollection

Parameters:

element - The element

Returns:

Whether the element is contained here

containsAll

public boolean containsAll(Collection c)

Accessor for whether a collection of elements are contained here.

Specified by:

containsAll in interface Collection

Specified by:

containsAll in interface List

Overrides:

containsAll in class AbstractCollection

Parameters:

c - The collection of elements.

Returns:

Whether they are contained.

equals

public boolean equals(Object o)

Equality operator.

Specified by:

equals in interface Collection

Specified by:

equals in interface List

Overrides:

equals in class AbstractList

Parameters:

o - The object to compare against.

Returns:

Whether this object is the same.

get

public Object get(int index)

Method to retrieve an element no.

Specified by:

get in interface List

Specified by:

get in class AbstractList

Parameters:

index - The item to retrieve

Returns:

The element at that position.

hashCode

public int hashCode()

Hashcode operator.

Specified by:

hashCode in interface Collection

Specified by:

hashCode in interface List

Overrides:

hashCode in class AbstractList

Returns:

The Hash code.

indexOf

public int indexOf(Object element)

Method to the position of an element.

Specified by:

indexOf in interface List

Overrides:

indexOf in class AbstractList

Parameters:

element - The element.

Returns:

The position.

isEmpty

public boolean isEmpty()

Accessor for whether the List is empty.

Specified by:

isEmpty in interface Collection

Specified by:

isEmpty in interface List

Overrides:

isEmpty in class AbstractCollection

Returns:

Whether it is empty.

lastIndexOf

public int lastIndexOf(Object element)

Method to retrieve the last position of the element.

Specified by:

lastIndexOf in interface List

Overrides:

lastIndexOf in class AbstractList

Parameters:

element - The element

Returns:

The last position of this element in the List.

iterator

public Iterator iterator()

Accessor for an iterator for the List

Specified by:

iterator in interface Iterable

Specified by:

iterator in interface Collection

Specified by:

iterator in interface List

Overrides:

iterator in class AbstractList

Returns:

The iterator

listIterator

public ListIterator listIterator()

Method to retrieve a List iterator for the list.

Specified by:

listIterator in interface List

Overrides:

listIterator in class AbstractList

Returns:

The iterator

listIterator

public ListIterator listIterator(int index)

Method to retrieve a List iterator for the list from the index.

Specified by:

listIterator in interface List

Overrides:

listIterator in class AbstractList

Parameters:

index - The start point

Returns:

The iterator

size

public int size()

Accessor for the size of the List

Specified by:

size in interface Collection

Specified by:

size in interface List

Specified by:

size in class AbstractCollection

Returns:

The size

subList

public List subList(int from,
                    int to)

Accessor for the subList of elements between from and to of the List

Specified by:

subList in interface List

Overrides:

subList in class AbstractList

Parameters:

from - Start index (inclusive)

to - End index (exclusive)

Returns:

The subList

toArray

public Object[] toArray()

Method to return the List as an array.

Specified by:

toArray in interface Collection

Specified by:

toArray in interface List

Overrides:

toArray in class AbstractCollection

Returns:

The array

toArray

public Object[] toArray(Object[] a)

Method to return the List as an array.

Specified by:

toArray in interface Collection

Specified by:

toArray in interface List

Overrides:

toArray in class AbstractCollection

Parameters:

a - The array to copy to

Returns:

The array

add

public boolean add(Object element)

Method to add an element to the List

Specified by:

add in interface Collection

Specified by:

add in interface List

Overrides:

add in class AbstractList

Parameters:

element - The element to add

Returns:

Whether it was added successfully.

add

public void add(int index,
                Object element)

Method to add an element to the List at a position.

Specified by:

add in interface List

Overrides:

add in class AbstractList

Parameters:

element - The element to add

index - The position

addAll

public boolean addAll(Collection elements)

Method to add a Collection to the ArrayList.

Specified by:

addAll in interface Collection

Specified by:

addAll in interface List

Overrides:

addAll in class AbstractCollection

Parameters:

elements - The collection

Returns:

Whether it was added ok.

addAll

public boolean addAll(int index,
                      Collection elements)

Method to add a collection of elements.

Specified by:

addAll in interface List

Overrides:

addAll in class AbstractList

Parameters:

elements - The collection of elements to add.

index - The position to add them

Returns:

Whether they were added successfully.

clear

public void clear()

Method to clear the List

Specified by:

clear in interface Collection

Specified by:

clear in interface List

Overrides:

clear in class AbstractList

remove

public boolean remove(Object element)

Method to remove an element from the List

Specified by:

remove in interface Collection

Specified by:

remove in interface List

Overrides:

remove in class AbstractCollection

Parameters:

element - The Element to remove

Returns:

Whether it was removed successfully.

remove

public boolean remove(Object element,
                      boolean allowCascadeDelete)

Method to remove an element from the List

Specified by:

remove in interface SCOCollection

Parameters:

element - The Element to remove

allowCascadeDelete - Whether to allow cascade delete

Returns:

Whether it was removed successfully.

remove

public Object remove(int index)

Method to remove an element from the ArrayList.

Specified by:

remove in interface List

Overrides:

remove in class AbstractList

Parameters:

index - The element position.

Returns:

The object that was removed

removeAll

public boolean removeAll(Collection elements)

Method to remove a collection of elements from the List.

Specified by:

removeAll in interface Collection

Specified by:

removeAll in interface List

Overrides:

removeAll in class AbstractCollection

Parameters:

elements - Collection of elements to remove

Returns:

Whether it was successful.

retainAll

public boolean retainAll(Collection c)

Method to retain a Collection of elements (and remove all others).

Specified by:

retainAll in interface Collection

Specified by:

retainAll in interface List

Overrides:

retainAll in class AbstractCollection

Parameters:

c - The collection to retain

Returns:

Whether they were retained successfully.

set

public Object set(int index,
                  Object element,
                  boolean allowDependentField)

wrapper addition that allows turning off of the dependent-field checks when doing the position setting. This means that we can prevent the deletion of the object that was previously in that position. This particular feature is used when attaching a list field and where some elements have changed positions.

Specified by:

set in interface SCOList

Parameters:

index - The position

element - The new element

allowDependentField - Whether to allow dependent-field deletes

Returns:

The element previously at that position

set

public Object set(int index,
                  Object element)

Method to set the element at a position in the ArrayList.

Specified by:

set in interface List

Overrides:

set in class AbstractList

Parameters:

index - The position

element - The new element

Returns:

The element previously at that position

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException

The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream. The ObjectOutputStream checks whether the class defines the writeReplace method. If the method is defined, the writeReplace method is called to allow the object to designate its replacement in the stream. The object returned should be either of the same type as the object passed in or an object that when read and resolved will result in an object of a type that is compatible with all references to the object.

Returns:

the replaced object

Throws:

ObjectStreamException