oracle.toplink.essentials.indirection

Class IndirectList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.Vector

oracle.toplink.essentials.indirection.IndirectList

All Implemented Interfaces:

Serializable, Cloneable, Iterable, Collection, List, RandomAccess, IndirectContainer

public class IndirectList
extends Vector
implements IndirectContainer

IndirectList allows a domain class to take advantage of TopLink indirection without having to declare its instance variable as a ValueHolderInterface.

To use an IndirectList:

• Declare the appropriate instance variable with type IndirectList (jdk1.1) or Collection/List/Vector (jdk1.2).
• Send the message #useTransparentCollection() to the appropriate CollectionMapping.

TopLink will place an IndirectList in the instance variable when the containing domain object is read from the datatabase. With the first message sent to the IndirectList, the contents are fetched from the database and normal Collection/List/Vector behavior is resumed.

Since:

TOPLink/Java 2.5

Author:

Big Country

See Also:

CollectionMapping, IndirectMap, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Vector	delegate Reduce type casting.
protected int	initialCapacity Store initial size for lazy init.
protected ValueHolderInterface	valueHolder Delegate indirection behavior to a value holder.

Fields inherited from class java.util.Vector

capacityIncrement, elementCount, elementData

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
IndirectList() PUBLIC: Construct an empty IndirectList so that its internal data array has size 10 and its standard capacity increment is zero.
IndirectList(Collection c) PUBLIC: Construct an IndirectList containing the elements of the specified collection, in the order they are returned by the collection's iterator.
IndirectList(int initialCapacity) PUBLIC: Construct an empty IndirectList with the specified initial capacity and with its capacity increment equal to zero.
IndirectList(int initialCapacity, int capacityIncrement) PUBLIC: Construct an empty IndirectList with the specified initial capacity and capacity increment.

Method Summary

Modifier and Type	Method and Description
void	add(int index, Object element)
boolean	add(Object o)
boolean	addAll(Collection c)
boolean	addAll(int index, Collection c)
void	addElement(Object obj)
protected Vector	buildDelegate() PUBLIC: Return the freshly-built delegate.
int	capacity()
void	clear()
Object	clone() PUBLIC:
boolean	contains(Object elem) PUBLIC:
boolean	containsAll(Collection c)
void	copyInto(Object[] anArray)
Object	elementAt(int index)
Enumeration	elements()
void	ensureCapacity(int minCapacity)
boolean	equals(Object o)
Object	firstElement()
Object	get(int index)
protected Vector	getDelegate() PUBLIC: Check whether the contents have been read from the database.
String	getTopLinkAttributeName() Return the mapping attribute name, used to raise change events.
ValueHolderInterface	getValueHolder() PUBLIC: Return the valueHolder.
boolean	hasBeenRegistered() INTERNAL: return whether this IndirectList has been registered with the UnitOfWork
int	hashCode() INTERNAL:
int	indexOf(Object elem)
int	indexOf(Object elem, int index)
protected void	initialize(Collection c) Initialize the instance.
protected void	initialize(int initialCapacity, int capacityIncrement) Initialize the instance.
void	insertElementAt(Object obj, int index)
boolean	isEmpty()
boolean	isInstantiated() PUBLIC: Return whether the contents have been read from the database.
Iterator	iterator()
Object	lastElement()
int	lastIndexOf(Object elem)
int	lastIndexOf(Object elem, int index)
ListIterator	listIterator()
ListIterator	listIterator(int index)
protected void	raiseAddChangeEvent(Object element) Raise the add change event and relationship maintainence.
protected void	raiseRemoveChangeEvent(Object element) Raise the remove change event.
Object	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection c)
void	removeAllElements()
boolean	removeElement(Object obj)
void	removeElementAt(int index)
boolean	retainAll(Collection c)
Object	set(int index, Object element)
void	setElementAt(Object obj, int index)
void	setSize(int newSize)
void	setTopLinkAttributeName(String attributeName) Set the mapping attribute name, used to raise change events.
void	setValueHolder(ValueHolderInterface valueHolder) PUBLIC: Set the value holder.
int	size()
List	subList(int fromIndex, int toIndex)
Object[]	toArray()
Object[]	toArray(Object[] a)
String	toString() PUBLIC: Use the java.util.Vector#toString(); but wrap it with braces to indicate there is a bit of indirection.
void	trimToSize()

Methods inherited from class java.util.Vector

forEach, removeIf, removeRange, replaceAll, sort, spliterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, stream

Field Detail

delegate

protected Vector delegate

Reduce type casting.

valueHolder

protected ValueHolderInterface valueHolder

Delegate indirection behavior to a value holder.

initialCapacity

protected int initialCapacity

Store initial size for lazy init.

Constructor Detail

IndirectList

public IndirectList()

PUBLIC: Construct an empty IndirectList so that its internal data array has size 10 and its standard capacity increment is zero.

IndirectList

public IndirectList(int initialCapacity)

PUBLIC: Construct an empty IndirectList with the specified initial capacity and with its capacity increment equal to zero.

Parameters:

initialCapacity - the initial capacity of the vector

Throws:

IllegalArgumentException - if the specified initial capacity is negative

IndirectList

public IndirectList(int initialCapacity,
                    int capacityIncrement)

PUBLIC: Construct an empty IndirectList with the specified initial capacity and capacity increment.

Parameters:

initialCapacity - the initial capacity of the vector

capacityIncrement - the amount by which the capacity is increased when the vector overflows

Throws:

IllegalArgumentException - if the specified initial capacity is negative

IndirectList

public IndirectList(Collection c)

PUBLIC: Construct an IndirectList containing the elements of the specified collection, in the order they are returned by the collection's iterator.

Parameters:

c - a collection containing the elements to construct this IndirectList with.

Method Detail

add

public void add(int index,
                Object element)

Specified by:

add in interface List

Overrides:

add in class Vector

See Also:

Vector.add(int, java.lang.Object)

raiseAddChangeEvent

protected void raiseAddChangeEvent(Object element)

Raise the add change event and relationship maintainence.

raiseRemoveChangeEvent

protected void raiseRemoveChangeEvent(Object element)

Raise the remove change event.

add

public boolean add(Object o)

Specified by:

add in interface Collection

Specified by:

add in interface List

Overrides:

add in class Vector

See Also:

Vector.add(java.lang.Object)

addAll

public boolean addAll(int index,
                      Collection c)

Specified by:

addAll in interface List

Overrides:

addAll in class Vector

See Also:

Vector.addAll(int, java.util.Collection)

addAll

public boolean addAll(Collection c)

Specified by:

addAll in interface Collection

Specified by:

addAll in interface List

Overrides:

addAll in class Vector

See Also:

Vector.addAll(java.util.Collection)

addElement

public void addElement(Object obj)

Overrides:

addElement in class Vector

See Also:

Vector.addElement(java.lang.Object)

buildDelegate

protected Vector buildDelegate()

PUBLIC: Return the freshly-built delegate.
In jdk1.1, the delegate may not be a Vector (in which case, it better be another IndirectList).
In jdk1.2, IndirectList is a subclass of Vector, so there is no need to check.

capacity

public int capacity()

Overrides:

capacity in class Vector

See Also:

Vector.capacity()

clear

public void clear()

Specified by:

clear in interface Collection

Specified by:

clear in interface List

Overrides:

clear in class Vector

See Also:

Vector.clear()

clone

public Object clone()

PUBLIC:

Overrides:

clone in class Vector

See Also:

This will result in a database query if necessary.

contains

public boolean contains(Object elem)

PUBLIC:

Specified by:

contains in interface Collection

Specified by:

contains in interface List

Overrides:

contains in class Vector

See Also:

Vector.contains(java.lang.Object)

containsAll

public boolean containsAll(Collection c)

Specified by:

containsAll in interface Collection

Specified by:

containsAll in interface List

Overrides:

containsAll in class Vector

See Also:

Vector.containsAll(java.util.Collection)

copyInto

public void copyInto(Object[] anArray)

Overrides:

copyInto in class Vector

See Also:

Vector.copyInto(java.lang.Object[])

elementAt

public Object elementAt(int index)

Overrides:

elementAt in class Vector

See Also:

Vector.elementAt(int)

elements

public Enumeration elements()

Overrides:

elements in class Vector

See Also:

Vector.elements()

ensureCapacity

public void ensureCapacity(int minCapacity)

Overrides:

ensureCapacity in class Vector

See Also:

Vector.ensureCapacity(int)

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection

Specified by:

equals in interface List

Overrides:

equals in class Vector

See Also:

Vector.equals(java.lang.Object)

firstElement

public Object firstElement()

Overrides:

firstElement in class Vector

See Also:

Vector.firstElement()

get

public Object get(int index)

Specified by:

get in interface List

Overrides:

get in class Vector

See Also:

Vector.get(int)

getDelegate

protected Vector getDelegate()

PUBLIC: Check whether the contents have been read from the database. If they have not, read them and set the delegate.

getValueHolder

public ValueHolderInterface getValueHolder()

PUBLIC: Return the valueHolder.

Specified by:

getValueHolder in interface IndirectContainer

Returns:

oracle.toplink.essentials.indirection.ValueHolderInterface A representation of the valueholder * which this container uses

hasBeenRegistered

public boolean hasBeenRegistered()

INTERNAL: return whether this IndirectList has been registered with the UnitOfWork

hashCode

public int hashCode()

INTERNAL:

Specified by:

hashCode in interface Collection

Specified by:

hashCode in interface List

Overrides:

hashCode in class Vector

See Also:

Vector.hashCode()

indexOf

public int indexOf(Object elem)

Specified by:

indexOf in interface List

Overrides:

indexOf in class Vector

See Also:

Vector.indexOf(java.lang.Object)

indexOf

public int indexOf(Object elem,
                   int index)

Overrides:

indexOf in class Vector

See Also:

Vector.indexOf(java.lang.Object, int)

initialize

protected void initialize(int initialCapacity,
                          int capacityIncrement)

Initialize the instance.

initialize

protected void initialize(Collection c)

Initialize the instance.

insertElementAt

public void insertElementAt(Object obj,
                            int index)

Overrides:

insertElementAt in class Vector

See Also:

Vector.insertElementAt(java.lang.Object, int)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection

Specified by:

isEmpty in interface List

Overrides:

isEmpty in class Vector

See Also:

Vector.isEmpty()

isInstantiated

public boolean isInstantiated()

PUBLIC: Return whether the contents have been read from the database.

Specified by:

isInstantiated in interface IndirectContainer

iterator

public Iterator iterator()

Specified by:

iterator in interface Iterable

Specified by:

iterator in interface Collection

Specified by:

iterator in interface List

Overrides:

iterator in class Vector

See Also:

AbstractList.iterator()

lastElement

public Object lastElement()

Overrides:

lastElement in class Vector

See Also:

Vector.lastElement()

lastIndexOf

public int lastIndexOf(Object elem)

Specified by:

lastIndexOf in interface List

Overrides:

lastIndexOf in class Vector

See Also:

Vector.lastIndexOf(java.lang.Object)

lastIndexOf

public int lastIndexOf(Object elem,
                       int index)

Overrides:

lastIndexOf in class Vector

See Also:

Vector.lastIndexOf(java.lang.Object, int)

listIterator

public ListIterator listIterator()

Specified by:

listIterator in interface List

Overrides:

listIterator in class Vector

See Also:

AbstractList.listIterator()

listIterator

public ListIterator listIterator(int index)

Specified by:

listIterator in interface List

Overrides:

listIterator in class Vector

See Also:

AbstractList.listIterator(int)

remove

public Object remove(int index)

Specified by:

remove in interface List

Overrides:

remove in class Vector

See Also:

Vector.remove(int)

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection

Specified by:

remove in interface List

Overrides:

remove in class Vector

See Also:

Vector.remove(java.lang.Object)

removeAll

public boolean removeAll(Collection c)

Specified by:

removeAll in interface Collection

Specified by:

removeAll in interface List

Overrides:

removeAll in class Vector

See Also:

Vector.removeAll(java.util.Collection)

removeAllElements

public void removeAllElements()

Overrides:

removeAllElements in class Vector

See Also:

Vector.removeAllElements()

removeElement

public boolean removeElement(Object obj)

Overrides:

removeElement in class Vector

See Also:

Vector.removeElement(java.lang.Object)

removeElementAt

public void removeElementAt(int index)

Overrides:

removeElementAt in class Vector

See Also:

Vector.removeElementAt(int)

retainAll

public boolean retainAll(Collection c)

Specified by:

retainAll in interface Collection

Specified by:

retainAll in interface List

Overrides:

retainAll in class Vector

See Also:

Vector.retainAll(java.util.Collection)

set

public Object set(int index,
                  Object element)

Specified by:

set in interface List

Overrides:

set in class Vector

See Also:

Vector.set(int, java.lang.Object)

setElementAt

public void setElementAt(Object obj,
                         int index)

Overrides:

setElementAt in class Vector

See Also:

Vector.setElementAt(java.lang.Object, int)

setSize

public void setSize(int newSize)

Overrides:

setSize in class Vector

See Also:

Vector.setSize(int)

setValueHolder

public void setValueHolder(ValueHolderInterface valueHolder)

PUBLIC: Set the value holder.

Specified by:

setValueHolder in interface IndirectContainer

size

public int size()

Specified by:

size in interface Collection

Specified by:

size in interface List

Overrides:

size in class Vector

See Also:

Vector.size()

subList

public List subList(int fromIndex,
                    int toIndex)

Specified by:

subList in interface List

Overrides:

subList in class Vector

See Also:

Vector.subList(int, int)

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection

Specified by:

toArray in interface List

Overrides:

toArray in class Vector

See Also:

Vector.toArray()

toArray

public Object[] toArray(Object[] a)

Specified by:

toArray in interface Collection

Specified by:

toArray in interface List

Overrides:

toArray in class Vector

See Also:

Vector.toArray(java.lang.Object[])

toString

public String toString()

PUBLIC: Use the java.util.Vector#toString(); but wrap it with braces to indicate there is a bit of indirection. Don't allow this method to trigger a database read.

Overrides:

toString in class Vector

See Also:

Vector.toString()

trimToSize

public void trimToSize()

Overrides:

trimToSize in class Vector

See Also:

Vector.trimToSize()

getTopLinkAttributeName

public String getTopLinkAttributeName()

Return the mapping attribute name, used to raise change events.

setTopLinkAttributeName

public void setTopLinkAttributeName(String attributeName)

Set the mapping attribute name, used to raise change events. This is required if the change listener is set.