org.jpox.sco
Class TreeMap

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.TreeMap
          org.jpox.sco.TreeMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map, java.util.SortedMap, SCO, SCOLazyLoading, SCOMap, Queryable

public class TreeMap
extends java.util.TreeMap
implements SCOMap, SCOLazyLoading, java.lang.Cloneable, Queryable

A mutable second-class TreeMap object. Backed by a MapStore object.

Version:

$Revision: 1.28 $

See Also:

Serialized Form

Field Summary

protected MapStore	backingStore The "backing store"
protected java.util.TreeMap	delegate The internal "delegate".
protected boolean	isCacheLoaded Status flag whether the collection is loaded into the cache.
protected boolean	useCache Whether to use "delegate" caching.

Constructor Summary

TreeMap(StateManager ownerSM, java.lang.String fieldName)
Constructor

Method Summary

void	attachCopy(java.lang.Object value) Method to return an attached copy of the passed (detached) value.
void	clear() Method to clear the TreeMap.
java.lang.Object	clone() Creates and returns a copy of this object.
java.util.Comparator	comparator() Accessor for the comparator.
boolean	containsKey(java.lang.Object key) Method to return if the map contains this key
boolean	containsValue(java.lang.Object value) Method to return if the map contains this value.
void	detach(FetchPlanState state) Method to detach this map and its contents.
java.lang.Object	detachCopy(FetchPlanState state) Method to return a detached copy of the container.
java.util.Set	entrySet() Accessor for the set of entries in the Map.
boolean	equals(java.lang.Object o) Method to check the equality of this map, and another.
java.lang.Object	firstKey() Accessor for the first key in the sorted map.
java.lang.Object	get(java.lang.Object key) Accessor for the value stored against a key.
java.lang.String	getFieldName() Accessor for the field name that this TreeMap relates to.
java.lang.Object	getOwner() Accessor for the owner that this TreeMap relates to.
int	hashCode() Method to generate a hashcode for this Map.
java.util.SortedMap	headMap(java.lang.Object toKey) Method to retrieve the head of the map up to the specified key.
boolean	isEmpty() Method to return if the Map is empty.
java.util.Set	keySet() Accessor for the set of keys in the Map.
java.lang.Object	lastKey() Accessor for the last key in the sorted map.
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 this map and its contents.
QueryExpression	newQueryStatement() Method to return a new Query statement for the Map.
QueryExpression	newQueryStatement(java.lang.Class candidate_class) Method to return a new Query statement for the Map given the candidate class.
Query.ResultObjectFactory	newResultObjectFactory(QueryExpression stmt, boolean ignoreCache, java.lang.Class resultClass, boolean useFetchPlan) Method to return a new result object factory for processing of Query statements.
java.lang.Object	put(java.lang.Object key, java.lang.Object value) Method to add a value against a key to the TreeMap.
void	putAll(java.util.Map m) Method to add the specified Map's values under their keys here.
java.lang.Object	remove(java.lang.Object key) Method to remove the value for a key from the TreeMap.
void	runReachability(java.util.Set reachables) Method to run reachability on this SCO.
void	setValueFrom(java.lang.Object o, boolean forUpdate) Mutator to set the value using an object.
int	size() Method to return the size of the Map.
java.util.SortedMap	subMap(java.lang.Object fromKey, java.lang.Object toKey) Method to retrieve the subset of the map between the specified keys.
java.util.SortedMap	tailMap(java.lang.Object fromKey) Method to retrieve the part of the map after the specified key.
void	unsetOwner() Method to unset the owner and field details.
void	updateEmbeddedKey(java.lang.Object key, int fieldNumber, java.lang.Object newValue) Method to update an embedded key in this map.
void	updateEmbeddedValue(java.lang.Object value, int fieldNumber, java.lang.Object newValue) Method to update an embedded value in this map.
java.util.Collection	values() Accessor for the set of values in the Map.
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.AbstractMap

toString

Methods inherited from class java.lang.Object

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

Field Detail

backingStore

protected MapStore backingStore

The "backing store"

delegate

protected java.util.TreeMap delegate

The internal "delegate".

useCache

protected boolean useCache

Whether to use "delegate" caching.

isCacheLoaded

protected boolean isCacheLoaded

Status flag whether the collection is loaded into the cache.

Constructor Detail

TreeMap

public TreeMap(StateManager ownerSM,
               java.lang.String fieldName)

Constructor

Parameters:

ownerSM - the owner StateManager

fieldName - the field name

Method Detail

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

updateEmbeddedKey

public void updateEmbeddedKey(java.lang.Object key,
                              int fieldNumber,
                              java.lang.Object newValue)

Method to update an embedded key in this map.

Specified by:

updateEmbeddedKey in interface SCOMap

Parameters:

key - The key

fieldNumber - Number of field in the key

newValue - New value for this field

updateEmbeddedValue

public void updateEmbeddedValue(java.lang.Object value,
                                int fieldNumber,
                                java.lang.Object newValue)

Method to update an embedded value in this map.

Specified by:

updateEmbeddedValue in interface SCOMap

Parameters:

value - The value

fieldNumber - Number of field in the value

newValue - New value for this field

setValueFrom

public void setValueFrom(java.lang.Object o,
                         boolean forUpdate)

Mutator to set the value using an object.

Specified by:

setValueFrom in interface SCO

Parameters:

o - Object to set value using.

forUpdate - Whether to update the datastore with this value

getFieldName

public java.lang.String getFieldName()

Accessor for the field name that this TreeMap relates to.

Specified by:

getFieldName in interface SCO

Returns:

The field name

getOwner

public java.lang.Object getOwner()

Accessor for the owner that this TreeMap relates to.

Specified by:

getOwner in interface SCO

Returns:

The owner

unsetOwner

public void unsetOwner()

Method to unset the owner and field details.

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 this map and its contents.

Specified by:

makeTransient in interface SCO

Parameters:

state - State for the fetchplan process

detach

public void detach(FetchPlanState state)

Method to detach this map and its contents.

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 keys/values 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 keys/values in the store for this owner field and removes ones no longer present, and adds new keys/values. All keys/values in the (detached) value are attached.

Specified by:

attachCopy in interface SCO

Parameters:

value - The new (collection) value

newQueryStatement

public QueryExpression newQueryStatement()

Method to return a new Query statement for the Map.

Specified by:

newQueryStatement in interface Queryable

Returns:

The Query Statement.

newQueryStatement

public QueryExpression newQueryStatement(java.lang.Class candidate_class)

Method to return a new Query statement for the Map given the candidate class.

Specified by:

newQueryStatement in interface Queryable

Parameters:

candidate_class - value class.

Returns:

The Query Statement

See Also:

Queryable.newQueryStatement()

newResultObjectFactory

public Query.ResultObjectFactory newResultObjectFactory(QueryExpression stmt,
                                                        boolean ignoreCache,
                                                        java.lang.Class resultClass,
                                                        boolean useFetchPlan)

Method to return a new result object factory for processing of Query statements.

Specified by:

newResultObjectFactory in interface Queryable

Parameters:

stmt - The Query Statement.

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 result object factory.

clone

public java.lang.Object clone()

Creates and returns a copy of this object.

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.

Specified by:

clone in interface SCO

Overrides:

clone in class java.util.TreeMap

Returns:

The cloned object

comparator

public java.util.Comparator comparator()

Accessor for the comparator.

Specified by:

comparator in interface java.util.SortedMap

Overrides:

comparator in class java.util.TreeMap

Returns:

The comparator

containsKey

public boolean containsKey(java.lang.Object key)

Method to return if the map contains this key

Specified by:

containsKey in interface java.util.Map

Overrides:

containsKey in class java.util.TreeMap

Parameters:

key - The key

Returns:

Whether it is contained

containsValue

public boolean containsValue(java.lang.Object value)

Method to return if the map contains this value.

Specified by:

containsValue in interface java.util.Map

Overrides:

containsValue in class java.util.TreeMap

Parameters:

value - The value

Returns:

Whether it is contained

entrySet

public java.util.Set entrySet()

Accessor for the set of entries in the Map.

Specified by:

entrySet in interface java.util.Map

Overrides:

entrySet in class java.util.TreeMap

Returns:

Set of entries

equals

public boolean equals(java.lang.Object o)

Method to check the equality of this map, and another.

Specified by:

equals in interface java.util.Map

Overrides:

equals in class java.util.AbstractMap

Parameters:

o - The map to compare against.

Returns:

Whether they are equal.

firstKey

public java.lang.Object firstKey()

Accessor for the first key in the sorted map.

Specified by:

firstKey in interface java.util.SortedMap

Overrides:

firstKey in class java.util.TreeMap

Returns:

The first key

lastKey

public java.lang.Object lastKey()

Accessor for the last key in the sorted map.

Specified by:

lastKey in interface java.util.SortedMap

Overrides:

lastKey in class java.util.TreeMap

Returns:

The last key

headMap

public java.util.SortedMap headMap(java.lang.Object toKey)

Method to retrieve the head of the map up to the specified key.

Specified by:

headMap in interface java.util.SortedMap

Overrides:

headMap in class java.util.TreeMap

Parameters:

toKey - the key to return up to.

Returns:

The map meeting the input

subMap

public java.util.SortedMap subMap(java.lang.Object fromKey,
                                  java.lang.Object toKey)

Method to retrieve the subset of the map between the specified keys.

Specified by:

subMap in interface java.util.SortedMap

Overrides:

subMap in class java.util.TreeMap

Parameters:

fromKey - The start key

toKey - The end key

Returns:

The map meeting the input

tailMap

public java.util.SortedMap tailMap(java.lang.Object fromKey)

Method to retrieve the part of the map after the specified key.

Specified by:

tailMap in interface java.util.SortedMap

Overrides:

tailMap in class java.util.TreeMap

Parameters:

fromKey - The start key

Returns:

The map meeting the input

get

public java.lang.Object get(java.lang.Object key)

Accessor for the value stored against a key.

Specified by:

get in interface java.util.Map

Overrides:

get in class java.util.TreeMap

Parameters:

key - The key

Returns:

The value.

hashCode

public int hashCode()

Method to generate a hashcode for this Map.

Specified by:

hashCode in interface java.util.Map

Overrides:

hashCode in class java.util.AbstractMap

Returns:

The hashcode.

isEmpty

public boolean isEmpty()

Method to return if the Map is empty.

Specified by:

isEmpty in interface java.util.Map

Specified by:

isEmpty in interface Queryable

Overrides:

isEmpty in class java.util.AbstractMap

Returns:

Whether it is empty.

keySet

public java.util.Set keySet()

Accessor for the set of keys in the Map.

Specified by:

keySet in interface java.util.Map

Overrides:

keySet in class java.util.TreeMap

Returns:

Set of keys.

size

public int size()

Method to return the size of the Map.

Specified by:

size in interface java.util.Map

Overrides:

size in class java.util.TreeMap

Returns:

The size

values

public java.util.Collection values()

Accessor for the set of values in the Map.

Specified by:

values in interface java.util.Map

Overrides:

values in class java.util.TreeMap

Returns:

Set of values.

clear

public void clear()

Method to clear the TreeMap.

Specified by:

clear in interface java.util.Map

Overrides:

clear in class java.util.TreeMap

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

Method to add a value against a key to the TreeMap.

Specified by:

put in interface java.util.Map

Overrides:

put in class java.util.TreeMap

Parameters:

key - The key

value - The value

Returns:

The previous value for the specified key.

putAll

public void putAll(java.util.Map m)

Method to add the specified Map's values under their keys here.

Specified by:

putAll in interface java.util.Map

Overrides:

putAll in class java.util.TreeMap

Parameters:

m - The map

remove

public java.lang.Object remove(java.lang.Object key)

Method to remove the value for a key from the TreeMap.

Specified by:

remove in interface java.util.Map

Overrides:

remove in class java.util.TreeMap

Parameters:

key - The key to remove

Returns:

The value that was removed from this key.

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.