|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractCollection<E>
java.util.AbstractList
org.jpox.sco.List
public class List
A mutable second-class List object, representing a field in a class, and containing elements of a particular type. Uses a "delegate" as a local store for the List. Uses a "backing store" (ListStore) to represent the datastore. The "delegate" is updated with the "backing store" information at necessary intervals.
Field Summary | |
---|---|
protected boolean |
isCacheLoaded
Status flag whether the collection is loaded into the cache. |
protected boolean |
useCache
Whether to use "delegate" caching. |
Fields inherited from class java.util.AbstractList |
---|
modCount |
Constructor Summary | |
---|---|
List(StateManager ownerSM,
java.lang.String fieldName)
Constructor, using the StateManager of the "owner" and the field name. |
Method Summary | |
---|---|
void |
add(int index,
java.lang.Object element)
Method to add an element to the List at a position. |
boolean |
add(java.lang.Object element)
Method to add an element to the List |
boolean |
addAll(java.util.Collection elements)
Method to add a Collection to the ArrayList. |
boolean |
addAll(int index,
java.util.Collection elements)
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 List |
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 List. |
boolean |
containsAll(java.util.Collection c)
Accessor for whether a collection of elements are contained here. |
void |
detach(FetchPlanState state)
Method to detach the PersistenceCapable elements of this container. |
java.lang.Object |
detachCopy(FetchPlanState state)
Method to return a detached copy of the container. |
boolean |
equals(java.lang.Object o)
Equality operator. |
java.lang.Object |
get(int index)
Method to retrieve an element no. |
java.lang.Class |
getElementType()
Accessor for the element type. |
java.lang.String |
getFieldName()
Accessor for the field name. |
java.lang.Object |
getOwner()
Accessor for the owner object. |
int |
hashCode()
Hashcode operator. |
int |
indexOf(java.lang.Object element)
Method to the position of an element. |
boolean |
isEmpty()
Accessor for whether the List is empty. |
java.util.Iterator |
iterator()
Accessor for an iterator for the List |
int |
lastIndexOf(java.lang.Object element)
Method to retrieve the last position of the element. |
java.util.ListIterator |
listIterator()
Method to retrieve a List iterator for the list. |
java.util.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. |
protected void |
loadFromStore()
Method to load all elements from the "backing store" where appropriate. |
void |
makeDirty()
Utility to mark the object as dirty |
void |
makeTransient(FetchPlanState state)
Method to make transient all elements of this container. |
QueryExpression |
newQueryStatement()
Method to generate a QueryStatement for the SCO. |
QueryExpression |
newQueryStatement(java.lang.Class candidate_class)
Method to return a QueryStatement, using the specified candidate class. |
Query.ResultObjectFactory |
newResultObjectFactory(QueryExpression stmt,
boolean ignoreCache,
java.lang.Class resultClass,
boolean useFetchPlan)
Method to return a ResultObjectFactory for the SCO. |
java.lang.Object |
remove(int index)
Method to remove an element from the ArrayList. |
boolean |
remove(java.lang.Object element)
Method to remove an element from the List |
boolean |
removeAll(java.util.Collection elements)
Method to remove a collection of elements from the List. |
boolean |
retainAll(java.util.Collection c)
Method to retain a Collection of elements (and remove all others). |
void |
runReachability(java.util.Set reachables)
Method to run reachability on this SCO. |
java.lang.Object |
set(int index,
java.lang.Object element)
Method to set the element at a position in the ArrayList. |
java.lang.Object |
set(int index,
java.lang.Object element,
boolean allowDependentField)
JPOX wrapper addition that allows turning off of the dependent-field checks when doing the position setting. |
void |
setValueFrom(java.lang.Object o,
boolean forUpdate)
Mutator for setting using an object. |
int |
size()
Accessor for the size of the List |
java.util.List |
subList(int from,
int to)
Accessor for the subList of elements between from and to of the List |
java.lang.Object[] |
toArray()
Method to return the List as an array. |
java.lang.Object[] |
toArray(java.lang.Object[] a)
Method to return the List 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.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 |
---|
protected boolean useCache
protected boolean isCacheLoaded
Constructor Detail |
---|
public List(StateManager ownerSM, java.lang.String fieldName)
ownerSM
- The owner StateManagerfieldName
- The name of the field of the SCO.Method Detail |
---|
public java.lang.Class getElementType()
getElementType
in interface SCOCollection
public void load()
load
in interface SCOLazyLoading
public void updateEmbeddedElement(java.lang.Object element, int fieldNumber, java.lang.Object value)
updateEmbeddedElement
in interface SCOCollection
element
- The elementfieldNumber
- Number of field in the elementvalue
- New value for this fieldpublic void setValueFrom(java.lang.Object o, boolean forUpdate)
setValueFrom
in interface SCO
o
- The object to set fromforUpdate
- Whether to update the datastore with this valuepublic java.lang.String getFieldName()
getFieldName
in interface SCO
public java.lang.Object getOwner()
getOwner
in interface SCO
public void unsetOwner()
unsetOwner
in interface SCO
public void makeDirty()
public void runReachability(java.util.Set reachables)
runReachability
in interface SCO
reachables
- List of StateManagers reachable so farpublic void makeTransient(FetchPlanState state)
makeTransient
in interface SCO
state
- State for the fetchplan processpublic void detach(FetchPlanState state)
detach
in interface SCO
state
- State for the detachment processpublic java.lang.Object detachCopy(FetchPlanState state)
detachCopy
in interface SCO
state
- State for detachment process
public void attachCopy(java.lang.Object value)
attachCopy
in interface SCO
value
- The new (collection) valuepublic QueryExpression newQueryStatement()
newQueryStatement
in interface Queryable
public QueryExpression newQueryStatement(java.lang.Class candidate_class)
newQueryStatement
in interface Queryable
candidate_class
- The candidate class
Queryable.newQueryStatement()
public Query.ResultObjectFactory newResultObjectFactory(QueryExpression stmt, boolean ignoreCache, java.lang.Class resultClass, boolean useFetchPlan)
newResultObjectFactory
in interface Queryable
stmt
- The QueryStatementignoreCache
- Whether to ignore the cacheresultClass
- Whether to create objects of a particular classuseFetchPlan
- whether to use the fetch plan to retrieve fields in the same query
public java.lang.Object clone()
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.
clone
in interface SCO
clone
in class java.lang.Object
public boolean contains(java.lang.Object element)
contains
in interface java.util.Collection
contains
in interface java.util.List
contains
in class java.util.AbstractCollection
element
- The element
public boolean containsAll(java.util.Collection c)
containsAll
in interface java.util.Collection
containsAll
in interface java.util.List
containsAll
in class java.util.AbstractCollection
c
- The collection of elements.
public boolean equals(java.lang.Object o)
equals
in interface java.util.Collection
equals
in interface java.util.List
equals
in class java.util.AbstractList
o
- The object to compare against.
public java.lang.Object get(int index)
get
in interface java.util.List
get
in class java.util.AbstractList
index
- The item to retrieve
public int hashCode()
hashCode
in interface java.util.Collection
hashCode
in interface java.util.List
hashCode
in class java.util.AbstractList
public int indexOf(java.lang.Object element)
indexOf
in interface java.util.List
indexOf
in class java.util.AbstractList
element
- The element.
public boolean isEmpty()
isEmpty
in interface java.util.Collection
isEmpty
in interface java.util.List
isEmpty
in interface Queryable
isEmpty
in class java.util.AbstractCollection
public int lastIndexOf(java.lang.Object element)
lastIndexOf
in interface java.util.List
lastIndexOf
in class java.util.AbstractList
element
- The element
public java.util.Iterator iterator()
iterator
in interface java.lang.Iterable
iterator
in interface java.util.Collection
iterator
in interface java.util.List
iterator
in class java.util.AbstractList
public java.util.ListIterator listIterator()
listIterator
in interface java.util.List
listIterator
in class java.util.AbstractList
public java.util.ListIterator listIterator(int index)
listIterator
in interface java.util.List
listIterator
in class java.util.AbstractList
index
- The start point
public int size()
size
in interface java.util.Collection
size
in interface java.util.List
size
in class java.util.AbstractCollection
public java.util.List subList(int from, int to)
subList
in interface java.util.List
subList
in class java.util.AbstractList
from
- Start index (inclusive)to
- End index (exclusive)
public java.lang.Object[] toArray()
toArray
in interface java.util.Collection
toArray
in interface java.util.List
toArray
in class java.util.AbstractCollection
public java.lang.Object[] toArray(java.lang.Object[] a)
toArray
in interface java.util.Collection
toArray
in interface java.util.List
toArray
in class java.util.AbstractCollection
a
- The array to copy to
public boolean add(java.lang.Object element)
add
in interface java.util.Collection
add
in interface java.util.List
add
in class java.util.AbstractList
element
- The element to add
public void add(int index, java.lang.Object element)
add
in interface java.util.List
add
in class java.util.AbstractList
element
- The element to addindex
- The positionpublic boolean addAll(java.util.Collection elements)
addAll
in interface java.util.Collection
addAll
in interface java.util.List
addAll
in class java.util.AbstractCollection
elements
- The collection
public boolean addAll(int index, java.util.Collection elements)
addAll
in interface java.util.List
addAll
in class java.util.AbstractList
elements
- The collection of elements to add.index
- The position to add them
public void clear()
clear
in interface java.util.Collection
clear
in interface java.util.List
clear
in class java.util.AbstractList
public boolean remove(java.lang.Object element)
remove
in interface java.util.Collection
remove
in interface java.util.List
remove
in class java.util.AbstractCollection
element
- The Element to remove
public java.lang.Object remove(int index)
remove
in interface java.util.List
remove
in class java.util.AbstractList
index
- The element position.
public boolean removeAll(java.util.Collection elements)
removeAll
in interface java.util.Collection
removeAll
in interface java.util.List
removeAll
in class java.util.AbstractCollection
elements
- Collection of elements to remove
public boolean retainAll(java.util.Collection c)
retainAll
in interface java.util.Collection
retainAll
in interface java.util.List
retainAll
in class java.util.AbstractCollection
c
- The collection to retain
public java.lang.Object set(int index, java.lang.Object element, boolean allowDependentField)
set
in interface SCOList
index
- The positionelement
- The new elementallowDependentField
- Whether to allow dependent-field deletes
public java.lang.Object set(int index, java.lang.Object element)
set
in interface java.util.List
set
in class java.util.AbstractList
index
- The positionelement
- The new element
protected java.lang.Object writeReplace() throws java.io.ObjectStreamException
java.io.ObjectStreamException
protected void loadFromStore()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |