Class TreeSet<E>

    • Constructor Detail

      • TreeSet

        public TreeSet​(DNStateManager sm,
                       AbstractMemberMetaData mmd)
        Constructor, using StateManager of the "owner" and the field name.
        Parameters:
        sm - The owner StateManager
        mmd - Metadata for the member
    • Method Detail

      • initialise

        public void initialise​(TreeSet<E> newValue,
                               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<E>
        Parameters:
        newValue - New value (to wrap)
        oldValue - Old value (to use in deciding what needs deleting etc)
      • initialise

        public void initialise​(TreeSet c)
        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<E>
        Parameters:
        c - 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<E>
      • initialiseDelegate

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

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

        public void setValue​(TreeSet<E> 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<E>
        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<E>
      • isLoaded

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

        public void updateEmbeddedElement​(E element,
                                          int fieldNumber,
                                          Object value,
                                          boolean makeDirty)
        Method to update an embedded element in this collection.
        Specified by:
        updateEmbeddedElement in interface SCOCollection<TreeSet<E>,​E>
        Parameters:
        element - The element
        fieldNumber - Number of field in the element
        value - New value for this field
        makeDirty - Whether to make the SCO field dirty.
      • getFieldName

        public String getFieldName()
        Accessor for the field name.
        Specified by:
        getFieldName in interface SCO<E>
        Returns:
        The field name
      • getOwner

        public Object getOwner()
        Accessor for the owner object.
        Specified by:
        getOwner in interface SCO<E>
        Returns:
        The owner object
      • unsetOwner

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

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

        public TreeSet 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<E>
        Parameters:
        state - State for detachment process
        Returns:
        The detached container
      • attachCopy

        public void attachCopy​(TreeSet 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<E>
        Parameters:
        value - The new (collection) value
      • clone

        public Object clone()
        Creates and returns a copy of this object.
        Specified by:
        clone in interface SCO<E>
        Overrides:
        clone in class TreeSet<E>
        Returns:
        The cloned object
      • contains

        public boolean contains​(Object element)
        Accessor for whether an element is contained in this Set.
        Specified by:
        contains in interface Collection<E>
        Specified by:
        contains in interface Set<E>
        Overrides:
        contains in class TreeSet<E>
        Parameters:
        element - The element
        Returns:
        Whether it is contained.
      • first

        public E first()
        Accessor for the first element in the sorted set.
        Specified by:
        first in interface SortedSet<E>
        Overrides:
        first in class TreeSet<E>
        Returns:
        The first element
      • isEmpty

        public boolean isEmpty()
        Accessor for whether the TreeSet is empty.
        Specified by:
        isEmpty in interface Collection<E>
        Specified by:
        isEmpty in interface Set<E>
        Overrides:
        isEmpty in class TreeSet<E>
        Returns:
        Whether it is empty.
      • headSet

        public SortedSet headSet​(E toElement)
        Method to retrieve the head elements up to the specified element.
        Specified by:
        headSet in interface NavigableSet<E>
        Specified by:
        headSet in interface SortedSet<E>
        Overrides:
        headSet in class TreeSet<E>
        Parameters:
        toElement - the element to return up to.
        Returns:
        The set of elements meeting the input
      • subSet

        public SortedSet subSet​(E fromElement,
                                E toElement)
        Method to retrieve the subset of elements between the specified elements.
        Specified by:
        subSet in interface NavigableSet<E>
        Specified by:
        subSet in interface SortedSet<E>
        Overrides:
        subSet in class TreeSet<E>
        Parameters:
        fromElement - The start element
        toElement - The end element
        Returns:
        The set of elements meeting the input
      • tailSet

        public SortedSet tailSet​(E fromElement)
        Method to retrieve the set of elements after the specified element.
        Specified by:
        tailSet in interface NavigableSet<E>
        Specified by:
        tailSet in interface SortedSet<E>
        Overrides:
        tailSet in class TreeSet<E>
        Parameters:
        fromElement - The start element
        Returns:
        The set of elements meeting the input
      • last

        public E last()
        Accessor for the last element in the sorted set.
        Specified by:
        last in interface SortedSet<E>
        Overrides:
        last in class TreeSet<E>
        Returns:
        The last element
      • size

        public int size()
        Accessor for the size of the TreeSet.
        Specified by:
        size in interface Collection<E>
        Specified by:
        size in interface Set<E>
        Overrides:
        size in class TreeSet<E>
        Returns:
        The size.
      • add

        public boolean add​(E element)
        Method to add an element to the TreeSet.
        Specified by:
        add in interface Collection<E>
        Specified by:
        add in interface Set<E>
        Overrides:
        add in class TreeSet<E>
        Parameters:
        element - The new element
        Returns:
        Whether it was added ok.
      • addAll

        public boolean addAll​(Collection elements)
        Method to add a collection to the TreeSet.
        Specified by:
        addAll in interface Collection<E>
        Specified by:
        addAll in interface Set<E>
        Overrides:
        addAll in class TreeSet<E>
        Parameters:
        elements - The collection
        Returns:
        Whether it was added ok.
      • remove

        public boolean remove​(Object element)
        Method to remove (the first occurrence of) an element from the collection
        Specified by:
        remove in interface Collection<E>
        Specified by:
        remove in interface Set<E>
        Overrides:
        remove in class TreeSet<E>
        Parameters:
        element - The Element to remove
        Returns:
        Whether it was removed successfully.
      • remove

        public boolean remove​(Object element,
                              boolean allowCascadeDelete)
        Method to remove (the first occurrence of) an element from the collection
        Specified by:
        remove in interface SCOCollection<TreeSet<E>,​E>
        Parameters:
        element - The Element to remove
        allowCascadeDelete - Whether to cascade delete
        Returns:
        Whether it was removed successfully.
      • removeAll

        public boolean removeAll​(Collection elements)
        Method to remove all elements from the collection from the TreeSet.
        Specified by:
        removeAll in interface Collection<E>
        Specified by:
        removeAll in interface Set<E>
        Overrides:
        removeAll in class AbstractSet<E>
        Parameters:
        elements - The collection of elements to remove
        Returns:
        Whether it was removed ok.
      • retainAll

        public boolean retainAll​(Collection c)
        Method to retain a Collection of elements (and remove all others).
        Specified by:
        retainAll in interface Collection<E>
        Specified by:
        retainAll in interface Set<E>
        Overrides:
        retainAll in class AbstractCollection<E>
        Parameters:
        c - The collection to retain
        Returns:
        Whether they were retained successfully.
      • 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 - if an error occurs