org.datanucleus.store.types.sco.simple
Class TreeMap

java.lang.Object
  extended by java.util.AbstractMap<K,V>
      extended by java.util.TreeMap
          extended by org.datanucleus.store.types.sco.simple.TreeMap
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map, java.util.NavigableMap, java.util.SortedMap, SCO, SCOContainer, SCOMap
Direct Known Subclasses:
TreeMap

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

A mutable second-class TreeMap object. This is the simplified form that intercepts mutators and marks the field as dirty. It also handles cascade-delete triggering for persistable elements.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class java.util.AbstractMap
java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
 
Field Summary
protected  java.util.TreeMap delegate
          The internal "delegate".
protected  java.lang.String fieldName
           
protected  int fieldNumber
           
protected static Localiser LOCALISER
           
protected  java.lang.Object owner
           
protected  ObjectProvider ownerSM
           
 
Constructor Summary
TreeMap(ObjectProvider 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.
 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.
 void flush()
          Method to flush the changes to the datastore when operating in queued mode.
 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.
 java.lang.Object getValue()
          Accessor for the unwrapped value that we are wrapping.
 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.
 void initialise()
          Method to initialise the SCO for use.
 void initialise(java.lang.Object o, boolean forInsert, boolean forUpdate)
          Method to initialise the SCO from an existing value.
protected  void initialiseDelegate()
          Convenience method to set up the delegate respecting any comparator specified in MetaData.
 boolean isEmpty()
          Method to return if the Map is empty.
 boolean isLoaded()
          Method to return if the SCO has its contents loaded.
 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.
 void makeDirty()
          Utility to mark the object as dirty
 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.
 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.TreeMap
ceilingEntry, ceilingKey, descendingKeySet, descendingMap, firstEntry, floorEntry, floorKey, headMap, higherEntry, higherKey, lastEntry, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, subMap, tailMap
 
Methods inherited from class java.util.AbstractMap
toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

LOCALISER

protected static final Localiser LOCALISER

owner

protected transient java.lang.Object owner

ownerSM

protected transient ObjectProvider ownerSM

fieldName

protected transient java.lang.String fieldName

fieldNumber

protected transient int fieldNumber

delegate

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

Constructor Detail

TreeMap

public TreeMap(ObjectProvider ownerSM,
               java.lang.String fieldName)
Constructor

Parameters:
ownerSM - the owner StateManager
fieldName - the field name
Method Detail

initialise

public void initialise(java.lang.Object o,
                       boolean forInsert,
                       boolean forUpdate)
Method to initialise the SCO from an existing value.

Specified by:
initialise in interface SCO
Parameters:
o - Object to set value using.
forInsert - Whether the object needs inserting in the datastore with this value
forUpdate - Whether to update the datastore with this value

initialise

public void initialise()
Method to initialise the SCO for use.

Specified by:
initialise in interface SCO

initialiseDelegate

protected void initialiseDelegate()
Convenience method to set up the delegate respecting any comparator specified in MetaData.


getValue

public java.lang.Object getValue()
Accessor for the unwrapped value that we are wrapping.

Specified by:
getValue in interface SCO
Returns:
The unwrapped value

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 SCOContainer

isLoaded

public boolean isLoaded()
Method to return if the SCO has its contents loaded. Returns true.

Specified by:
isLoaded in interface SCOContainer
Returns:
Whether it is loaded

flush

public void flush()
Method to flush the changes to the datastore when operating in queued mode. Does nothing in "direct" mode.

Specified by:
flush in interface SCOContainer

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

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


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 (map) value

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
Specified by:
entrySet in interface java.util.SortedMap
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.NavigableMap
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.NavigableMap
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.NavigableMap
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
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
Specified by:
keySet in interface java.util.SortedMap
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
Specified by:
values in interface java.util.SortedMap
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


Copyright © 2011. All Rights Reserved.