org.jpox.sco.simple
Class Collection

java.lang.Object
  java.util.AbstractCollection
      org.jpox.sco.simple.Collection

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, SCO, SCOCollection, SCOContainer, SCOMtoN

public class Collection
extends java.util.AbstractCollection
implements SCOCollection, SCOMtoN, java.lang.Cloneable, java.io.Serializable

A mutable second-class Collection object. This is the simplified form that intercepts mutators and marks the field as dirty.

Version:

$Revision: 1.4 $

See Also:

Serialized Form

Field Summary

protected boolean	allowNulls
protected java.util.Collection	delegate The internal "delegate".
protected java.lang.String	fieldName
protected int	fieldNumber
protected static Localiser	LOCALISER
protected java.lang.Object	owner
protected StateManager	ownerSM

Constructor Summary

Collection(StateManager ownerSM, java.lang.String fieldName)
Constructor.

Method Summary

boolean	add(java.lang.Object element) Method to add an element to the Collection.
boolean	addAll(java.util.Collection c) Method to add a collection of elements.
void	attachCopy(java.lang.Object value) Method to return an attached copy of the passed (detached) value.
void	clear() Method to clear the Collection.
java.lang.Object	clone() Creates and returns a copy of this object.
boolean	contains(java.lang.Object element) Accessor for whether an element is contained in the Collection.
boolean	containsAll(java.util.Collection c) Accessor for whether a collection of elements are contained here.
java.lang.Object	detachCopy(FetchPlanState state) Method to return a detached copy of the container.
boolean	equals(java.lang.Object o) Equality operator.
void	flush() Method to flush the changes to the datastore when operating in queued mode.
java.lang.String	getFieldName() Accessor for the field name.
java.lang.Object	getOwner() Accessor for the owner object.
java.lang.Object	getValue() Accessor for the unwrapped value that we are wrapping.
int	hashCode() Hashcode operator.
void	initialise() Method to initialise the SCO for use.
void	initialise(java.lang.Object o, boolean forInsert, boolean forUpdate) Method to initialise the SCO from an existing value.
boolean	isEmpty() Accessor for whether the Collection is empty.
java.util.Iterator	iterator() Accessor for an iterator for the Collection.
void	load() Method to effect the load of the data in the SCO.
void	makeDirty() Utility to mark the object as dirty
boolean	remove(java.lang.Object element) Method to remove an element from the List
boolean	remove(java.lang.Object element, boolean allowCascadeDelete) Method to remove an element from the List
boolean	removeAll(java.util.Collection c) Method to remove a Collection of elements.
boolean	retainAll(java.util.Collection c) Method to retain a Collection of elements (and remove all others).
int	size() Accessor for the size of the Collection.
java.lang.Object[]	toArray() Method to return the Collection as an array.
java.lang.Object[]	toArray(java.lang.Object[] a) Method to return the Collection as an array.
void	unsetOwner() Method to unset the owner and field information.
void	updateEmbeddedElement(java.lang.Object element, int fieldNumber, java.lang.Object value) Method to update an embedded element in this collection.
protected java.lang.Object	writeReplace() The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream.

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

owner

protected java.lang.Object owner

ownerSM

protected StateManager ownerSM

fieldName

protected java.lang.String fieldName

fieldNumber

protected int fieldNumber

allowNulls

protected boolean allowNulls

delegate

protected java.util.Collection delegate

The internal "delegate".

Constructor Detail

Collection

public Collection(StateManager ownerSM,
                  java.lang.String fieldName)

Constructor. Called from CollectionMapping.

Parameters:

ownerSM - The State Manager for this collection.

fieldName - Name of the field

Method Detail

initialise

public void initialise(java.lang.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 object in the datastore with this value

initialise

public void initialise()

Method to initialise the SCO for use.

Specified by:

initialise in interface SCO

getValue

public java.lang.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

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(java.lang.Object element,
                                  int fieldNumber,
                                  java.lang.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 java.lang.String getFieldName()

Accessor for the field name.

Specified by:

getFieldName in interface SCO

Returns:

The field name

getOwner

public java.lang.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 java.lang.Object detachCopy(FetchPlanState state)

Method to return a detached copy of the container. Recurses through 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(java.lang.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 java.lang.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 java.lang.Object

Returns:

A clone of the object

contains

public boolean contains(java.lang.Object element)

Accessor for whether an element is contained in the Collection.

Specified by:

contains in interface java.util.Collection

Specified by:

contains in interface SCOMtoN

Overrides:

contains in class java.util.AbstractCollection

Parameters:

element - The element

Returns:

Whether the element is contained here

containsAll

public boolean containsAll(java.util.Collection c)

Accessor for whether a collection of elements are contained here.

Specified by:

containsAll in interface java.util.Collection

Overrides:

containsAll in class java.util.AbstractCollection

Parameters:

c - The collection of elements.

Returns:

Whether they are contained.

equals

public boolean equals(java.lang.Object o)

Equality operator.

Specified by:

equals in interface java.util.Collection

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to compare against.

Returns:

Whether this object is the same.

hashCode

public int hashCode()

Hashcode operator.

Specified by:

hashCode in interface java.util.Collection

Overrides:

hashCode in class java.lang.Object

Returns:

The Hash code.

isEmpty

public boolean isEmpty()

Accessor for whether the Collection is empty.

Specified by:

isEmpty in interface java.util.Collection

Overrides:

isEmpty in class java.util.AbstractCollection

Returns:

Whether it is empty.

iterator

public java.util.Iterator iterator()

Accessor for an iterator for the Collection.

Specified by:

iterator in interface java.lang.Iterable

Specified by:

iterator in interface java.util.Collection

Specified by:

iterator in class java.util.AbstractCollection

Returns:

The iterator

size

public int size()

Accessor for the size of the Collection.

Specified by:

size in interface java.util.Collection

Specified by:

size in class java.util.AbstractCollection

Returns:

The size

toArray

public java.lang.Object[] toArray()

Method to return the Collection as an array.

Specified by:

toArray in interface java.util.Collection

Overrides:

toArray in class java.util.AbstractCollection

Returns:

The array

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)

Method to return the Collection as an array.

Specified by:

toArray in interface java.util.Collection

Overrides:

toArray in class java.util.AbstractCollection

Parameters:

a - The array to write the results to

Returns:

The array

add

public boolean add(java.lang.Object element)

Method to add an element to the Collection.

Specified by:

add in interface java.util.Collection

Overrides:

add in class java.util.AbstractCollection

Parameters:

element - The element to add

Returns:

Whether it was added successfully.

addAll

public boolean addAll(java.util.Collection c)

Method to add a collection of elements.

Specified by:

addAll in interface java.util.Collection

Overrides:

addAll in class java.util.AbstractCollection

Parameters:

c - The collection of elements to add.

Returns:

Whether they were added successfully.

clear

public void clear()

Method to clear the Collection.

Specified by:

clear in interface java.util.Collection

Overrides:

clear in class java.util.AbstractCollection

remove

public boolean remove(java.lang.Object element)

Method to remove an element from the List

Specified by:

remove in interface java.util.Collection

Overrides:

remove in class java.util.AbstractCollection

Parameters:

element - The Element to remove

Returns:

Whether it was removed successfully.

remove

public boolean remove(java.lang.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.

removeAll

public boolean removeAll(java.util.Collection c)

Method to remove a Collection of elements.

Specified by:

removeAll in interface java.util.Collection

Overrides:

removeAll in class java.util.AbstractCollection

Parameters:

c - The collection to remove

Returns:

Whether they were removed successfully.

retainAll

public boolean retainAll(java.util.Collection c)

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

Specified by:

retainAll in interface java.util.Collection

Overrides:

retainAll in class java.util.AbstractCollection

Parameters:

c - The collection to retain

Returns:

Whether they were retained successfully.

writeReplace

protected java.lang.Object writeReplace()
                                 throws java.io.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:

java.io.ObjectStreamException