Class SortedMap<K,​V>

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.util.Map<K,​V>, java.util.SortedMap<K,​V>, SCO<java.util.SortedMap<K,​V>>, SCOContainer<java.util.SortedMap<K,​V>>, SCOMap<java.util.SortedMap<K,​V>,​K,​V>
    Direct Known Subclasses:
    SortedMap

    public class SortedMap<K,​V>
    extends java.util.AbstractMap<K,​V>
    implements java.util.SortedMap<K,​V>, SCOMap<java.util.SortedMap<K,​V>,​K,​V>, java.lang.Cloneable, java.io.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

        java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>
      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void attachCopy​(java.util.SortedMap value)
      Method to return an attached copy of the passed (detached) value.
      void clear()
      Method to clear the SortedMap.
      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.util.SortedMap 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.
      K firstKey()
      Accessor for the first key in the sorted map.
      void forEach​(java.util.function.BiConsumer<? super K,​? super V> action)  
      V get​(java.lang.Object key)
      Accessor for the value stored against a key.
      java.lang.String getFieldName()
      Accessor for the field name that this SortedMap relates to.
      java.lang.Object getOwner()
      Accessor for the owner that this SortedMap relates to.
      java.util.SortedMap getValue()
      Accessor for the unwrapped value that we are wrapping.
      int hashCode()
      Method to generate a hashcode for this Map.
      java.util.SortedMap headMap​(K toKey)
      Method to retrieve the head of the map up to the specified key.
      void initialise()
      Method to initialise the SCO for use, and allowing the SCO to be loaded from the datastore (when we have a backing store).
      void initialise​(java.util.SortedMap m)
      Method to initialise the SCO for use with the provided initial value.
      void initialise​(java.util.SortedMap newValue, java.lang.Object oldValue)
      Method to initialise the SCO for use, where replacing an old value with a new value such as when calling a setter field passing in a new 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<K> keySet()
      Accessor for the set of keys in the Map.
      K 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
      V put​(K key, V value)
      Method to add a value against a key to the SortedMap.
      void putAll​(java.util.Map m)
      Method to add the specified Map's values under their keys here.
      V remove​(java.lang.Object key)
      Method to remove the value for a key from the SortedMap.
      void setValue​(java.util.SortedMap value)
      Method to change the delegate value this wraps (to save recreating the wrapper).
      int size()
      Method to return the size of the Map.
      java.util.SortedMap subMap​(K fromKey, K toKey)
      Method to retrieve the subset of the map between the specified keys.
      java.util.SortedMap tailMap​(K 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​(K key, int fieldNumber, java.lang.Object newValue, boolean makeDirty)
      Method to update an embedded key in this map.
      void updateEmbeddedValue​(V value, int fieldNumber, java.lang.Object newValue, boolean makeDirty)
      Method to update an embedded value in this map.
      java.util.Collection<V> 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
      • Methods inherited from interface java.util.Map

        compute, computeIfAbsent, computeIfPresent, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
    • Field Detail

      • delegate

        protected java.util.SortedMap<K,​V> delegate
        The internal "delegate".
    • Method Detail

      • initialise

        public void initialise​(java.util.SortedMap newValue,
                               java.lang.Object oldValue)
        Description copied from interface: SCO
        Method to initialise the SCO for use, where replacing an old value with a new value such as when calling a setter field passing in a new value. Note that oldValue is marked as Object since for cases where the member type is Collection the newValue could be, for example, ArrayList, and the oldValue of type Collection (representing null).
        Specified by:
        initialise in interface SCO<K>
        Parameters:
        newValue - New value (to wrap)
        oldValue - Old value (to use in deciding what needs deleting etc)
      • initialise

        public void initialise​(java.util.SortedMap m)
        Description copied from interface: SCO
        Method to initialise the SCO for use with the provided initial value. This is used, for example, when retrieving the field from the datastore and setting it in the persistable object.
        Specified by:
        initialise in interface SCO<K>
        Parameters:
        m - the object from which to copy the value.
      • initialise

        public void initialise()
        Description copied from interface: SCO
        Method to initialise the SCO for use, and allowing the SCO to be loaded from the datastore (when we have a backing store). This can be utilised to perform any eager loading of information from the datastore.
        Specified by:
        initialise in interface SCO<K>
      • initialiseDelegate

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

        public java.util.SortedMap getValue()
        Accessor for the unwrapped value that we are wrapping.
        Specified by:
        getValue in interface SCO<K>
        Returns:
        The unwrapped value
      • setValue

        public void setValue​(java.util.SortedMap value)
        Description copied from interface: SCOContainer
        Method to change the delegate value this wraps (to save recreating the wrapper).
        Specified by:
        setValue in interface SCOContainer<K>
        Parameters:
        value - The new 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<K>
      • isLoaded

        public boolean isLoaded()
        Method to return if the SCO has its contents loaded. Returns true.
        Specified by:
        isLoaded in interface SCOContainer<K>
        Returns:
        Whether it is loaded
      • updateEmbeddedKey

        public void updateEmbeddedKey​(K key,
                                      int fieldNumber,
                                      java.lang.Object newValue,
                                      boolean makeDirty)
        Method to update an embedded key in this map.
        Specified by:
        updateEmbeddedKey in interface SCOMap<java.util.SortedMap<K,​V>,​K,​V>
        Parameters:
        key - The key
        fieldNumber - Number of field in the key
        newValue - New value for this field
        makeDirty - Whether to make the SCO field dirty.
      • updateEmbeddedValue

        public void updateEmbeddedValue​(V value,
                                        int fieldNumber,
                                        java.lang.Object newValue,
                                        boolean makeDirty)
        Method to update an embedded value in this map.
        Specified by:
        updateEmbeddedValue in interface SCOMap<java.util.SortedMap<K,​V>,​K,​V>
        Parameters:
        value - The value
        fieldNumber - Number of field in the value
        newValue - New value for this field
        makeDirty - Whether to make the SCO field dirty.
      • getFieldName

        public java.lang.String getFieldName()
        Accessor for the field name that this SortedMap relates to.
        Specified by:
        getFieldName in interface SCO<K>
        Returns:
        The field name
      • getOwner

        public java.lang.Object getOwner()
        Accessor for the owner that this SortedMap relates to.
        Specified by:
        getOwner in interface SCO<K>
        Returns:
        The owner
      • unsetOwner

        public void unsetOwner()
        Method to unset the owner and field details.
        Specified by:
        unsetOwner in interface SCO<K>
      • makeDirty

        public void makeDirty()
        Utility to mark the object as dirty
      • detachCopy

        public java.util.SortedMap 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<K>
        Parameters:
        state - State for detachment state
        Returns:
        The detached container
      • attachCopy

        public void attachCopy​(java.util.SortedMap 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<K>
        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 persistable objects. In contrast to Object.clone(), this method must not throw a CloneNotSupportedException.

        Specified by:
        clone in interface SCO<K>
        Overrides:
        clone in class java.util.AbstractMap<K,​V>
        Returns:
        The cloned object
      • comparator

        public java.util.Comparator comparator()
        Accessor for the comparator.
        Specified by:
        comparator in interface java.util.SortedMap<K,​V>
        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<K,​V>
        Overrides:
        containsKey in class java.util.AbstractMap<K,​V>
        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<K,​V>
        Overrides:
        containsValue in class java.util.AbstractMap<K,​V>
        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<K,​V>
        Specified by:
        entrySet in interface java.util.SortedMap<K,​V>
        Specified by:
        entrySet in class java.util.AbstractMap<K,​V>
        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<K,​V>
        Overrides:
        equals in class java.util.AbstractMap<K,​V>
        Parameters:
        o - The map to compare against.
        Returns:
        Whether they are equal.
      • firstKey

        public K firstKey()
        Accessor for the first key in the sorted map.
        Specified by:
        firstKey in interface java.util.SortedMap<K,​V>
        Returns:
        The first key
      • forEach

        public void forEach​(java.util.function.BiConsumer<? super K,​? super V> action)
        Specified by:
        forEach in interface java.util.Map<K,​V>
      • lastKey

        public K lastKey()
        Accessor for the last key in the sorted map.
        Specified by:
        lastKey in interface java.util.SortedMap<K,​V>
        Returns:
        The last key
      • headMap

        public java.util.SortedMap headMap​(K toKey)
        Method to retrieve the head of the map up to the specified key.
        Specified by:
        headMap in interface java.util.SortedMap<K,​V>
        Parameters:
        toKey - the key to return up to.
        Returns:
        The map meeting the input
      • subMap

        public java.util.SortedMap subMap​(K fromKey,
                                          K toKey)
        Method to retrieve the subset of the map between the specified keys.
        Specified by:
        subMap in interface java.util.SortedMap<K,​V>
        Parameters:
        fromKey - The start key
        toKey - The end key
        Returns:
        The map meeting the input
      • tailMap

        public java.util.SortedMap tailMap​(K fromKey)
        Method to retrieve the part of the map after the specified key.
        Specified by:
        tailMap in interface java.util.SortedMap<K,​V>
        Parameters:
        fromKey - The start key
        Returns:
        The map meeting the input
      • get

        public V get​(java.lang.Object key)
        Accessor for the value stored against a key.
        Specified by:
        get in interface java.util.Map<K,​V>
        Overrides:
        get in class java.util.AbstractMap<K,​V>
        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<K,​V>
        Overrides:
        hashCode in class java.util.AbstractMap<K,​V>
        Returns:
        The hashcode.
      • isEmpty

        public boolean isEmpty()
        Method to return if the Map is empty.
        Specified by:
        isEmpty in interface java.util.Map<K,​V>
        Overrides:
        isEmpty in class java.util.AbstractMap<K,​V>
        Returns:
        Whether it is empty.
      • keySet

        public java.util.Set<K> keySet()
        Accessor for the set of keys in the Map.
        Specified by:
        keySet in interface java.util.Map<K,​V>
        Specified by:
        keySet in interface java.util.SortedMap<K,​V>
        Overrides:
        keySet in class java.util.AbstractMap<K,​V>
        Returns:
        Set of keys.
      • size

        public int size()
        Method to return the size of the Map.
        Specified by:
        size in interface java.util.Map<K,​V>
        Overrides:
        size in class java.util.AbstractMap<K,​V>
        Returns:
        The size
      • values

        public java.util.Collection<V> values()
        Accessor for the set of values in the Map.
        Specified by:
        values in interface java.util.Map<K,​V>
        Specified by:
        values in interface java.util.SortedMap<K,​V>
        Overrides:
        values in class java.util.AbstractMap<K,​V>
        Returns:
        Set of values.
      • clear

        public void clear()
        Method to clear the SortedMap.
        Specified by:
        clear in interface java.util.Map<K,​V>
        Overrides:
        clear in class java.util.AbstractMap<K,​V>
      • put

        public V put​(K key,
                     V value)
        Method to add a value against a key to the SortedMap.
        Specified by:
        put in interface java.util.Map<K,​V>
        Overrides:
        put in class java.util.AbstractMap<K,​V>
        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<K,​V>
        Overrides:
        putAll in class java.util.AbstractMap<K,​V>
        Parameters:
        m - The map
      • remove

        public V remove​(java.lang.Object key)
        Method to remove the value for a key from the SortedMap.
        Specified by:
        remove in interface java.util.Map<K,​V>
        Overrides:
        remove in class java.util.AbstractMap<K,​V>
        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 - if an error occurs