org.jpox.sco
Class SortedSet

java.lang.Object
  extended byjava.util.AbstractCollection
      extended byjava.util.AbstractSet
          extended byorg.jpox.sco.SortedSet
All Implemented Interfaces:
java.lang.Cloneable, java.util.Collection, Queryable, SCO, SCOCollection, SCOLazyLoading, SCOMtoN, java.util.Set, java.util.SortedSet

public class SortedSet
extends java.util.AbstractSet
implements java.util.SortedSet, SCOCollection, SCOMtoN, SCOLazyLoading, java.lang.Cloneable, Queryable

A mutable second-class SortedSet object. Backed by a SetStore object. Allows caching in the delegate of the elements of the SortedSet. This can be enabled globally for the PMF, or individually for this particular SortedSet.

Version:
$Revision$

Field Summary
protected  CollectionStore backingStore
          The "backing store"
protected  java.util.TreeSet delegate
          The internal "delegate".
protected  boolean isCacheLoaded
          Status flag whether the collection is loaded into the cache.
protected  boolean useCache
          Whether to use caching.
 
Constructor Summary
SortedSet(StateManager ownerSM, java.lang.String fieldName)
          Constructor, using the StateManager of the "owner" and the field name.
 
Method Summary
 boolean add(java.lang.Object element)
          Method to add an element to the SortedSet.
 boolean addAll(java.util.Collection c)
          Method to add a collection to the SortedSet.
 void attachCopy(java.lang.Object value)
          Method to return an attached copy of the passed (detached) value.
 void clear()
          Method to clear the SortedSet
 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 this Set.
 boolean containsAll(java.util.Collection c)
          Accessor for whether a collection is contained in this Set.
 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 first()
          Accessor for the first element in the sorted set.
 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.
 java.util.SortedSet headSet(java.lang.Object toElement)
          Method to retrieve the head elements up to the specified element.
 boolean isEmpty()
          Accessor for whether the SortedSet is empty.
 java.util.Iterator iterator()
          Accessor for an iterator for the Set.
 java.lang.Object last()
          Accessor for the last element in the sorted set.
 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.
 boolean remove(java.lang.Object element)
          Method to remove an element from the SortedSet.
 boolean removeAll(java.util.Collection c)
          Method to remove all elements from the collection from the SortedSet.
 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 SortedSet.
 java.util.SortedSet subSet(java.lang.Object fromElement, java.lang.Object toElement)
          Method to retrieve the subset of elements between the specified elements.
 java.util.SortedSet tailSet(java.lang.Object fromElement)
          Method to retrieve the set of elements after the specified element.
 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.AbstractCollection
toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

backingStore

protected CollectionStore backingStore
The "backing store"


delegate

protected java.util.TreeSet delegate
The internal "delegate".


useCache

protected boolean useCache
Whether to use caching.


isCacheLoaded

protected boolean isCacheLoaded
Status flag whether the collection is loaded into the cache.

Constructor Detail

SortedSet

public SortedSet(StateManager ownerSM,
                 java.lang.String fieldName)
Constructor, using the StateManager of the "owner" and the field name.

Parameters:
ownerSM - The owner StateManager
fieldName - The name of the field of the SCO.
Method Detail

getElementType

public java.lang.Class getElementType()
Accessor for the element type.

Specified by:
getElementType in interface SCOCollection
Returns:
the element type contained in the collection

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 SCOLazyLoading

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

setValueFrom

public void setValueFrom(java.lang.Object o,
                         boolean forUpdate)
Mutator for setting using an object.

Specified by:
setValueFrom in interface SCO
Parameters:
o - The object to set from
forUpdate - Whether to update the datastore with this value

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


runReachability

public void runReachability(java.util.Set reachables)
Method to run reachability on this SCO.

Specified by:
runReachability in interface SCO
Parameters:
reachables - List of StateManagers reachable so far

makeTransient

public void makeTransient(FetchPlanState state)
Method to make transient all elements of this container. All elements that are PersistenceCapable will be made transient.

Specified by:
makeTransient in interface SCO
Parameters:
state - State for the fetchplan process

detach

public void detach(FetchPlanState state)
Method to detach the PersistenceCapable elements of this container.

Specified by:
detach in interface SCO
Parameters:
state - State for the detachment process

detachCopy

public java.lang.Object detachCopy(FetchPlanState state)
Method to return a detached copy of the container. Recurse sthrough 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

newQueryStatement

public QueryExpression newQueryStatement()
Method to generate a QueryStatement for the SCO.

Specified by:
newQueryStatement in interface Queryable
Returns:
The QueryStatement

newQueryStatement

public QueryExpression newQueryStatement(java.lang.Class candidate_class)
Method to return a QueryStatement, using the specified candidate class.

Specified by:
newQueryStatement in interface Queryable
Parameters:
candidate_class - the candidate class
Returns:
The QueryStatement
See Also:
Queryable.newQueryStatement()

newResultObjectFactory

public Query.ResultObjectFactory newResultObjectFactory(QueryExpression stmt,
                                                        boolean ignoreCache,
                                                        java.lang.Class resultClass,
                                                        boolean useFetchPlan)
Method to return a ResultObjectFactory for the SCO.

Specified by:
newResultObjectFactory in interface Queryable
Parameters:
stmt - The QueryStatement
ignoreCache - Whether to ignore the cache
resultClass - Whether to create objects of a particular class
useFetchPlan - whether to use the fetch plan to retrieve fields in the same query
Returns:
The ResultObjectFactory

clone

public java.lang.Object clone()
Creates and returns a copy of this object.

Specified by:
clone in interface SCO
Returns:
The cloned object

comparator

public java.util.Comparator comparator()
Accessor for the comparator.

Specified by:
comparator in interface java.util.SortedSet
Returns:
The comparator

contains

public boolean contains(java.lang.Object element)
Accessor for whether an element is contained in this Set.

Specified by:
contains in interface java.util.Set
Parameters:
element - The element
Returns:
Whether it is contained.

containsAll

public boolean containsAll(java.util.Collection c)
Accessor for whether a collection is contained in this Set.

Specified by:
containsAll in interface java.util.Set
Parameters:
c - The collection
Returns:
Whether it is contained.

equals

public boolean equals(java.lang.Object o)
Equality operator.

Specified by:
equals in interface java.util.Set
Parameters:
o - The object to compare against.
Returns:
Whether this object is the same.

first

public java.lang.Object first()
Accessor for the first element in the sorted set.

Specified by:
first in interface java.util.SortedSet
Returns:
The first element

hashCode

public int hashCode()
Hashcode operator.

Specified by:
hashCode in interface java.util.Set
Returns:
The Hash code.

isEmpty

public boolean isEmpty()
Accessor for whether the SortedSet is empty.

Specified by:
isEmpty in interface java.util.Set
Returns:
Whether it is empty.

iterator

public java.util.Iterator iterator()
Accessor for an iterator for the Set.

Specified by:
iterator in interface java.util.Set
Returns:
The iterator

headSet

public java.util.SortedSet headSet(java.lang.Object toElement)
Method to retrieve the head elements up to the specified element.

Specified by:
headSet in interface java.util.SortedSet
Parameters:
toElement - the element to return up to.
Returns:
The set of elements meeting the input

subSet

public java.util.SortedSet subSet(java.lang.Object fromElement,
                                  java.lang.Object toElement)
Method to retrieve the subset of elements between the specified elements.

Specified by:
subSet in interface java.util.SortedSet
Parameters:
fromElement - The start element
toElement - The end element
Returns:
The set of elements meeting the input

tailSet

public java.util.SortedSet tailSet(java.lang.Object fromElement)
Method to retrieve the set of elements after the specified element.

Specified by:
tailSet in interface java.util.SortedSet
Parameters:
fromElement - The start element
Returns:
The set of elements meeting the input

last

public java.lang.Object last()
Accessor for the last element in the sorted set.

Specified by:
last in interface java.util.SortedSet
Returns:
The last element

size

public int size()
Accessor for the size of the SortedSet.

Specified by:
size in interface java.util.Set
Returns:
The size.

toArray

public java.lang.Object[] toArray()
Method to return the list as an array.

Specified by:
toArray in interface java.util.Set
Returns:
The array

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)
Method to return the list as an array.

Specified by:
toArray in interface java.util.Set
Parameters:
a - The runtime types of the array being defined by this param
Returns:
The array

add

public boolean add(java.lang.Object element)
Method to add an element to the SortedSet.

Specified by:
add in interface java.util.Set
Parameters:
element - The new element
Returns:
Whether it was added ok.

addAll

public boolean addAll(java.util.Collection c)
Method to add a collection to the SortedSet.

Specified by:
addAll in interface java.util.Set
Parameters:
c - The collection
Returns:
Whether it was added ok.

clear

public void clear()
Method to clear the SortedSet

Specified by:
clear in interface java.util.Set

remove

public boolean remove(java.lang.Object element)
Method to remove an element from the SortedSet.

Specified by:
remove in interface java.util.Set
Parameters:
element - The element
Returns:
Whether it was removed ok.

removeAll

public boolean removeAll(java.util.Collection c)
Method to remove all elements from the collection from the SortedSet.

Specified by:
removeAll in interface java.util.Set
Parameters:
c - The collection of elements to remove
Returns:
Whether it was removed ok.

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.Set
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

loadFromStore

protected void loadFromStore()
Method to load all elements from the "backing store" where appropriate.



Copyright © -2007 . All Rights Reserved.