|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractCollection<E>
java.util.AbstractQueue
org.jpox.sco.PriorityQueue
public class PriorityQueue
A mutable second-class PriorityQueue object, representing a field in a class, and containing elements of a particular type. Uses a "delegate" as a local store for the PriorityQueue. 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 |
allowNulls
|
protected org.jpox.store.scostore.ListStore |
backingStore
The "backing store" (for use when not serialised). |
protected java.util.PriorityQueue |
delegate
The internal "delegate". |
protected java.lang.Class |
elementType
|
protected java.lang.String |
fieldName
|
protected int |
fieldNumber
|
protected boolean |
isCacheLoaded
Status flag whether the collection is loaded into the cache. |
protected java.lang.Object |
owner
|
protected org.jpox.StateManager |
ownerSM
|
protected boolean |
useCache
Whether to use "delegate" caching. |
Constructor Summary | |
---|---|
PriorityQueue(org.jpox.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. |
java.util.Comparator |
comparator()
Accessor for the comparator. |
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. |
void |
detach(org.jpox.state.FetchPlanState state)
Method to detach the PersistenceCapable elements of this container. |
java.lang.Object |
detachCopy(org.jpox.state.FetchPlanState state)
Method to return a detached copy of the container. |
boolean |
equals(java.lang.Object o)
Equality operator. |
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. |
protected void |
init(org.jpox.StateManager ownerSM,
java.lang.String fieldName)
Initialisation method. |
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. |
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(org.jpox.state.FetchPlanState state)
Method to make transient all elements of this container. |
org.jpox.store.expression.QueryExpression |
newQueryStatement()
Method to generate a QueryStatement for the SCO. |
org.jpox.store.expression.QueryExpression |
newQueryStatement(java.lang.Class candidate_class)
Method to return a QueryStatement, using the specified candidate class. |
org.jpox.store.query.Query.ResultObjectFactory |
newResultObjectFactory(org.jpox.store.expression.QueryExpression stmt,
boolean ignoreCache,
java.lang.Class resultClass,
boolean useFetchPlan)
Method to return a ResultObjectFactory for the SCO. |
boolean |
offer(java.lang.Object element)
Method to offer an element to the Queue. |
java.lang.Object |
peek()
Method to peek at the next element in the Queue. |
java.lang.Object |
poll()
Method to poll the next element in the Queue. |
boolean |
remove(java.lang.Object element)
Method to remove an element from the Collection. |
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). |
void |
runReachability(java.util.Set reachables)
Method to run reachability on this SCO. |
void |
setValueFrom(java.lang.Object o,
boolean forUpdate)
Mutator for setting using an object. |
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. |
java.lang.String |
toString()
Method to return the Collection as a String. |
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.AbstractQueue |
---|
element, remove |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.lang.Object owner
protected org.jpox.StateManager ownerSM
protected java.lang.String fieldName
protected int fieldNumber
protected java.lang.Class elementType
protected boolean allowNulls
protected org.jpox.store.scostore.ListStore backingStore
protected java.util.PriorityQueue delegate
protected boolean useCache
protected boolean isCacheLoaded
Constructor Detail |
---|
public PriorityQueue(org.jpox.StateManager ownerSM, java.lang.String fieldName)
ownerSM
- The State Manager for this set.fieldName
- Name of the fieldMethod Detail |
---|
protected void init(org.jpox.StateManager ownerSM, java.lang.String fieldName)
ownerSM
- The owner StateManagerfieldName
- The name of the field of the SCO.public java.lang.Class getElementType()
getElementType
in interface org.jpox.sco.SCOCollection
public void load()
load
in interface org.jpox.sco.SCOLazyLoading
public void updateEmbeddedElement(java.lang.Object element, int fieldNumber, java.lang.Object value)
updateEmbeddedElement
in interface org.jpox.sco.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 org.jpox.sco.SCO
o
- The object to set fromforUpdate
- Whether to update the datastore with this valuepublic java.lang.String getFieldName()
getFieldName
in interface org.jpox.sco.SCO
public java.lang.Object getOwner()
getOwner
in interface org.jpox.sco.SCO
public void unsetOwner()
unsetOwner
in interface org.jpox.sco.SCO
public void makeDirty()
public void runReachability(java.util.Set reachables)
runReachability
in interface org.jpox.sco.SCO
reachables
- List of StateManagers reachable so farpublic void makeTransient(org.jpox.state.FetchPlanState state)
makeTransient
in interface org.jpox.sco.SCO
state
- State for the fetchplan processpublic void detach(org.jpox.state.FetchPlanState state)
detach
in interface org.jpox.sco.SCO
state
- State for the detachment processpublic java.lang.Object detachCopy(org.jpox.state.FetchPlanState state)
detachCopy
in interface org.jpox.sco.SCO
state
- State for detachment process
public void attachCopy(java.lang.Object value)
attachCopy
in interface org.jpox.sco.SCO
value
- The new (collection) valuepublic org.jpox.store.expression.QueryExpression newQueryStatement()
newQueryStatement
in interface org.jpox.store.query.Queryable
public org.jpox.store.expression.QueryExpression newQueryStatement(java.lang.Class candidate_class)
newQueryStatement
in interface org.jpox.store.query.Queryable
candidate_class
- the candidate class
public org.jpox.store.query.Query.ResultObjectFactory newResultObjectFactory(org.jpox.store.expression.QueryExpression stmt, boolean ignoreCache, java.lang.Class resultClass, boolean useFetchPlan)
newResultObjectFactory
in interface org.jpox.store.query.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 org.jpox.sco.SCO
clone
in class java.lang.Object
public java.util.Comparator comparator()
public boolean contains(java.lang.Object element)
contains
in interface java.util.Collection
contains
in interface org.jpox.sco.SCOMtoN
contains
in class java.util.AbstractCollection
element
- The element
public boolean containsAll(java.util.Collection c)
containsAll
in interface java.util.Collection
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 class java.lang.Object
o
- The object to compare against.
public int hashCode()
hashCode
in interface java.util.Collection
hashCode
in class java.lang.Object
public boolean isEmpty()
isEmpty
in interface java.util.Collection
isEmpty
in interface org.jpox.store.query.Queryable
isEmpty
in class java.util.AbstractCollection
public java.util.Iterator iterator()
iterator
in interface java.lang.Iterable
iterator
in interface java.util.Collection
iterator
in class java.util.AbstractCollection
public int size()
size
in interface java.util.Collection
size
in class java.util.AbstractCollection
public java.lang.Object[] toArray()
toArray
in interface java.util.Collection
toArray
in class java.util.AbstractCollection
public java.lang.Object[] toArray(java.lang.Object[] a)
toArray
in interface java.util.Collection
toArray
in class java.util.AbstractCollection
a
- The array to write the results to
public java.lang.String toString()
toString
in class java.util.AbstractCollection
public boolean add(java.lang.Object element)
add
in interface java.util.Collection
add
in class java.util.AbstractQueue
element
- The element to add
public boolean addAll(java.util.Collection c)
addAll
in interface java.util.Collection
addAll
in class java.util.AbstractQueue
c
- The collection of elements to add.
public void clear()
clear
in interface java.util.Collection
clear
in class java.util.AbstractQueue
public boolean offer(java.lang.Object element)
offer
in interface java.util.Queue
element
- The element to offer
public java.lang.Object peek()
peek
in interface java.util.Queue
public java.lang.Object poll()
poll
in interface java.util.Queue
public boolean remove(java.lang.Object element)
remove
in interface java.util.Collection
remove
in class java.util.AbstractCollection
element
- The Element to remove
public boolean removeAll(java.util.Collection c)
removeAll
in interface java.util.Collection
removeAll
in class java.util.AbstractCollection
c
- The collection to remove
public boolean retainAll(java.util.Collection c)
retainAll
in interface java.util.Collection
retainAll
in class java.util.AbstractCollection
c
- The collection to retain
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 |