org.datanucleus.store.types.simple

Class SortedMap

java.lang.Object

java.util.AbstractMap

org.datanucleus.store.types.simple.SortedMap

All Implemented Interfaces:

Serializable, Cloneable, Map, SortedMap, SCO, SCOContainer, SCOMap

Direct Known Subclasses:

SortedMap

public class SortedMap
extends AbstractMap
implements SortedMap, SCOMap, Cloneable, Serializable

A mutable second-class SortedMap 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

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected TreeMap	delegate The internal "delegate".
protected static Localiser	LOCALISER
protected AbstractMemberMetaData	ownerMmd
protected ObjectProvider	ownerOP

Constructor Summary

Constructors

Constructor and Description
SortedMap(ObjectProvider ownerOP, AbstractMemberMetaData mmd) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	attachCopy(Object value) Method to return an attached copy of the passed (detached) value.
void	clear() Method to clear the SortedMap.
Object	clone() Creates and returns a copy of this object.
Comparator	comparator() Accessor for the comparator.
boolean	containsKey(Object key) Method to return if the map contains this key
boolean	containsValue(Object value) Method to return if the map contains this value.
Object	detachCopy(FetchPlanState state) Method to return a detached copy of the container.
Set	entrySet() Accessor for the set of entries in the Map.
boolean	equals(Object o) Method to check the equality of this map, and another.
Object	firstKey() Accessor for the first key in the sorted map.
Object	get(Object key) Accessor for the value stored against a key.
String	getFieldName() Accessor for the field name that this SortedMap relates to.
Object	getOwner() Accessor for the owner that this SortedMap relates to.
Object	getValue() Accessor for the unwrapped value that we are wrapping.
int	hashCode() Method to generate a hashcode for this Map.
SortedMap	headMap(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(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.
Set	keySet() Accessor for the set of keys in the Map.
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
Object	put(Object key, Object value) Method to add a value against a key to the SortedMap.
void	putAll(Map m) Method to add the specified Map's values under their keys here.
Object	remove(Object key) Method to remove the value for a key from the SortedMap.
int	size() Method to return the size of the Map.
SortedMap	subMap(Object fromKey, Object toKey) Method to retrieve the subset of the map between the specified keys.
SortedMap	tailMap(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(Object key, int fieldNumber, Object newValue) Method to update an embedded key in this map.
void	updateEmbeddedValue(Object value, int fieldNumber, Object newValue) Method to update an embedded value in this map.
Collection	values() Accessor for the set of values in the Map.
protected 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

LOCALISER

protected static final Localiser LOCALISER

ownerOP

protected transient ObjectProvider ownerOP

ownerMmd

protected transient AbstractMemberMetaData ownerMmd

delegate

protected TreeMap delegate

The internal "delegate".

Constructor Detail

SortedMap

public SortedMap(ObjectProvider ownerOP,
         AbstractMemberMetaData mmd)

Constructor

Parameters:

ownerOP - the owner ObjectProvider

mmd - Metadata for the member

Method Detail

initialise

public void initialise(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 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

updateEmbeddedKey

public void updateEmbeddedKey(Object key,
                     int fieldNumber,
                     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(Object value,
                       int fieldNumber,
                       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 String getFieldName()

Accessor for the field name that this SortedMap relates to.

Specified by:

getFieldName in interface SCO

Returns:

The field name

getOwner

public Object getOwner()

Accessor for the owner that this SortedMap 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 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 state

Returns:

The detached container

attachCopy

public void attachCopy(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 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 AbstractMap

Returns:

The cloned object

comparator

public Comparator comparator()

Accessor for the comparator.

Specified by:

comparator in interface SortedMap

Returns:

The comparator

containsKey

public boolean containsKey(Object key)

Method to return if the map contains this key

Specified by:

containsKey in interface Map

Overrides:

containsKey in class AbstractMap

Parameters:

key - The key

Returns:

Whether it is contained

containsValue

public boolean containsValue(Object value)

Method to return if the map contains this value.

Specified by:

containsValue in interface Map

Overrides:

containsValue in class AbstractMap

Parameters:

value - The value

Returns:

Whether it is contained

entrySet

public Set entrySet()

Accessor for the set of entries in the Map.

Specified by:

entrySet in interface Map

Specified by:

entrySet in interface SortedMap

Specified by:

entrySet in class AbstractMap

Returns:

Set of entries

equals

public boolean equals(Object o)

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

Specified by:

equals in interface Map

Overrides:

equals in class AbstractMap

Parameters:

o - The map to compare against.

Returns:

Whether they are equal.

firstKey

public Object firstKey()

Accessor for the first key in the sorted map.

Specified by:

firstKey in interface SortedMap

Returns:

The first key

lastKey

public Object lastKey()

Accessor for the last key in the sorted map.

Specified by:

lastKey in interface SortedMap

Returns:

The last key

headMap

public SortedMap headMap(Object toKey)

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

Specified by:

headMap in interface SortedMap

Parameters:

toKey - the key to return up to.

Returns:

The map meeting the input

subMap

public SortedMap subMap(Object fromKey,
               Object toKey)

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

Specified by:

subMap in interface SortedMap

Parameters:

fromKey - The start key

toKey - The end key

Returns:

The map meeting the input

tailMap

public SortedMap tailMap(Object fromKey)

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

Specified by:

tailMap in interface SortedMap

Parameters:

fromKey - The start key

Returns:

The map meeting the input

get

public Object get(Object key)

Accessor for the value stored against a key.

Specified by:

get in interface Map

Overrides:

get in class AbstractMap

Parameters:

key - The key

Returns:

The value.

hashCode

public int hashCode()

Method to generate a hashcode for this Map.

Specified by:

hashCode in interface Map

Overrides:

hashCode in class AbstractMap

Returns:

The hashcode.

isEmpty

public boolean isEmpty()

Method to return if the Map is empty.

Specified by:

isEmpty in interface Map

Overrides:

isEmpty in class AbstractMap

Returns:

Whether it is empty.

keySet

public Set keySet()

Accessor for the set of keys in the Map.

Specified by:

keySet in interface Map

Specified by:

keySet in interface SortedMap

Overrides:

keySet in class AbstractMap

Returns:

Set of keys.

size

public int size()

Method to return the size of the Map.

Specified by:

size in interface Map

Overrides:

size in class AbstractMap

Returns:

The size

values

public Collection values()

Accessor for the set of values in the Map.

Specified by:

values in interface Map

Specified by:

values in interface SortedMap

Overrides:

values in class AbstractMap

Returns:

Set of values.

clear

public void clear()

Method to clear the SortedMap.

Specified by:

clear in interface Map

Overrides:

clear in class AbstractMap

put

public Object put(Object key,
         Object value)

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

Specified by:

put in interface Map

Overrides:

put in class AbstractMap

Parameters:

key - The key

value - The value

Returns:

The previous value for the specified key.

putAll

public void putAll(Map m)

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

Specified by:

putAll in interface Map

Overrides:

putAll in class AbstractMap

Parameters:

m - The map

remove

public Object remove(Object key)

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

Specified by:

remove in interface Map

Overrides:

remove in class AbstractMap

Parameters:

key - The key to remove

Returns:

The value that was removed from this key.

writeReplace

protected Object writeReplace()
                       throws 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:

ObjectStreamException