org.apache.cayenne.access
Class ToManyList

java.lang.Object
  extended by org.apache.cayenne.access.ToManyList
All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable, java.util.Collection, java.util.List, ValueHolder

public class ToManyList
extends java.lang.Object
implements java.util.List, java.io.Serializable, ValueHolder

A list that holds objects for to-many relationships. All operations, except for resolving the list from DB, are not synchronized. The safest way to implement custom synchronization is to synchronize on parent ObjectStore.

For more information see Cayenne User Guide.

Author:
Andrus Adamchik
See Also:
Serialized Form

Constructor Summary
ToManyList(Persistent source, java.lang.String relationship)
          Creates ToManyList.
 
Method Summary
 void add(int index, java.lang.Object element)
           
 boolean add(java.lang.Object o)
           
 boolean addAll(java.util.Collection c)
           
 boolean addAll(int index, java.util.Collection c)
           
 void clear()
           
 boolean contains(java.lang.Object o)
           
 boolean containsAll(java.util.Collection c)
           
 boolean equals(java.lang.Object o)
           
 java.lang.Object get(int index)
           
 java.lang.String getRelationship()
          Returns a name of relationship for this list.
 Persistent getRelationshipOwner()
           
 DataObject getSource()
          Deprecated. since 1.2 use 'getRelationshipOwner()'
 java.lang.Object getValue()
          Returns an object stored by this ValueHolder.
 java.lang.Object getValueDirectly()
          Retrieves ValueHolder value without triggering fault resolution.
 int hashCode()
           
 int indexOf(java.lang.Object o)
           
 void invalidate()
          Turns a ValueHolder into a fault.
 void invalidateObjectList()
          Deprecated. since 1.2 use invalidate()
 boolean isEmpty()
           
 boolean isFault()
          Returns true if the internal value is not yet resolved.
 java.util.Iterator iterator()
           
 int lastIndexOf(java.lang.Object o)
           
 java.util.ListIterator listIterator()
           
 java.util.ListIterator listIterator(int index)
           
 boolean needsFetch()
          Deprecated. since 1.2 - use 'isFault'
 java.lang.Object remove(int index)
           
 boolean remove(java.lang.Object o)
           
 boolean removeAll(java.util.Collection c)
           
 boolean retainAll(java.util.Collection c)
           
 java.lang.Object set(int index, java.lang.Object element)
           
 void setObjectList(java.util.List objectList)
           
 java.lang.Object setValue(java.lang.Object value)
          Sets an object stored by this ValueHolder.
 java.lang.Object setValueDirectly(java.lang.Object value)
          Sets ValueHolder vaue without triggering fault resolution.
 int size()
           
 java.util.List subList(int fromIndex, int toIndex)
           
 java.lang.Object[] toArray()
           
 java.lang.Object[] toArray(java.lang.Object[] a)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ToManyList

public ToManyList(Persistent source,
                  java.lang.String relationship)
Creates ToManyList.

Since:
1.1
Method Detail

getSource

public DataObject getSource()
Deprecated. since 1.2 use 'getRelationshipOwner()'

Returns a source object of this relationship.

Since:
1.1

getRelationshipOwner

public Persistent getRelationshipOwner()
Since:
1.2

getRelationship

public java.lang.String getRelationship()
Returns a name of relationship for this list.

Since:
1.1

needsFetch

public boolean needsFetch()
Deprecated. since 1.2 - use 'isFault'

Returns whether this list is not yet resolved and requires a fetch.


invalidateObjectList

public void invalidateObjectList()
Deprecated. since 1.2 use invalidate()

Will force refresh on the next access.


setObjectList

public void setObjectList(java.util.List objectList)

getValue

public java.lang.Object getValue()
                          throws CayenneRuntimeException
Description copied from interface: ValueHolder
Returns an object stored by this ValueHolder.

Specified by:
getValue in interface ValueHolder
Throws:
CayenneRuntimeException

invalidate

public void invalidate()
Description copied from interface: ValueHolder
Turns a ValueHolder into a fault.

Specified by:
invalidate in interface ValueHolder

isFault

public boolean isFault()
Description copied from interface: ValueHolder
Returns true if the internal value is not yet resolved.

Specified by:
isFault in interface ValueHolder

getValueDirectly

public java.lang.Object getValueDirectly()
                                  throws CayenneRuntimeException
Description copied from interface: ValueHolder
Retrieves ValueHolder value without triggering fault resolution.

Specified by:
getValueDirectly in interface ValueHolder
Throws:
CayenneRuntimeException

setValueDirectly

public java.lang.Object setValueDirectly(java.lang.Object value)
                                  throws CayenneRuntimeException
Description copied from interface: ValueHolder
Sets ValueHolder vaue without triggering fault resolution.

Specified by:
setValueDirectly in interface ValueHolder
Throws:
CayenneRuntimeException

setValue

public java.lang.Object setValue(java.lang.Object value)
                          throws CayenneRuntimeException
Description copied from interface: ValueHolder
Sets an object stored by this ValueHolder.

Specified by:
setValue in interface ValueHolder
Parameters:
value - a new value of the ValueHolder.
Returns:
a previous value saved in the ValueHolder.
Throws:
CayenneRuntimeException

add

public boolean add(java.lang.Object o)
Specified by:
add in interface java.util.Collection
Specified by:
add in interface java.util.List

add

public void add(int index,
                java.lang.Object element)
Specified by:
add in interface java.util.List

addAll

public boolean addAll(java.util.Collection c)
Specified by:
addAll in interface java.util.Collection
Specified by:
addAll in interface java.util.List

addAll

public boolean addAll(int index,
                      java.util.Collection c)
Specified by:
addAll in interface java.util.List

clear

public void clear()
Specified by:
clear in interface java.util.Collection
Specified by:
clear in interface java.util.List

contains

public boolean contains(java.lang.Object o)
Specified by:
contains in interface java.util.Collection
Specified by:
contains in interface java.util.List

containsAll

public boolean containsAll(java.util.Collection c)
Specified by:
containsAll in interface java.util.Collection
Specified by:
containsAll in interface java.util.List

equals

public boolean equals(java.lang.Object o)
Specified by:
equals in interface java.util.Collection
Specified by:
equals in interface java.util.List
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Specified by:
hashCode in interface java.util.Collection
Specified by:
hashCode in interface java.util.List
Overrides:
hashCode in class java.lang.Object

get

public java.lang.Object get(int index)
Specified by:
get in interface java.util.List

indexOf

public int indexOf(java.lang.Object o)
Specified by:
indexOf in interface java.util.List

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Collection
Specified by:
isEmpty in interface java.util.List

iterator

public java.util.Iterator iterator()
Specified by:
iterator in interface java.lang.Iterable
Specified by:
iterator in interface java.util.Collection
Specified by:
iterator in interface java.util.List

lastIndexOf

public int lastIndexOf(java.lang.Object o)
Specified by:
lastIndexOf in interface java.util.List

listIterator

public java.util.ListIterator listIterator()
Specified by:
listIterator in interface java.util.List

listIterator

public java.util.ListIterator listIterator(int index)
Specified by:
listIterator in interface java.util.List

remove

public java.lang.Object remove(int index)
Specified by:
remove in interface java.util.List

remove

public boolean remove(java.lang.Object o)
Specified by:
remove in interface java.util.Collection
Specified by:
remove in interface java.util.List

removeAll

public boolean removeAll(java.util.Collection c)
Specified by:
removeAll in interface java.util.Collection
Specified by:
removeAll in interface java.util.List

retainAll

public boolean retainAll(java.util.Collection c)
Specified by:
retainAll in interface java.util.Collection
Specified by:
retainAll in interface java.util.List

set

public java.lang.Object set(int index,
                            java.lang.Object element)
Specified by:
set in interface java.util.List

size

public int size()
Specified by:
size in interface java.util.Collection
Specified by:
size in interface java.util.List

subList

public java.util.List subList(int fromIndex,
                              int toIndex)
Specified by:
subList in interface java.util.List

toArray

public java.lang.Object[] toArray()
Specified by:
toArray in interface java.util.Collection
Specified by:
toArray in interface java.util.List

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)
Specified by:
toArray in interface java.util.Collection
Specified by:
toArray in interface java.util.List


Copyright © 2001-2006 Apache.org All Rights Reserved.