TreeSetByElement (Side of Software - Dated Collections Library)

Package

Class

Use

Tree

Deprecated

Index

Help

Side of Software
Dated Collections Library 2.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

sos.dated.util
Class TreeSetByElement<E,D>

java.lang.Object
  sos.dated.util.AbstractDatedObject<D>
      sos.dated.util.AbstractDatedCollection<E,D>
          sos.dated.util.AbstractDatedSet<E,D>
              sos.dated.util.TreeSetByElement<E,D>


Type Parameters:: E - the type of elements maintained by this dated set; D - the type of dates used by this dated set

All Implemented Interfaces:: java.io.Serializable, java.lang.Cloneable, DatedCollection<E,D>, DatedObject<D>, DatedSet<E,D>, DatedSortedSet<E,D>

public class TreeSetByElement<E,D>
extends AbstractDatedSet<E,D>
implements DatedSortedSet<E,D>, java.io.Serializable, java.lang.Cloneable
extends AbstractDatedSet<E,D>
implements DatedSortedSet<E,D>, java.io.Serializable, java.lang.Cloneable

An implementation of DatedSet that uses a TreeMapByKey as its underlying data structure to keep its elements in sorted order and to provide fast indexing to elements. The following illustration shows a conceptual view of a small TreeSetByElement where the "dates" are integers and the elements are characters:

In the above picture, the dated set contains the following elements for the following ranges:

   [1,2): {B,K,M}
   [3,5): {A,B,K,M}
   [5,6): {M}
   [6,9): {A,B,K}

This implementation is serializable and cloneable; however, it is not synchronized. To use it safely in a multi-threaded situation, wrap an instance of the dated set with a call to DatedCollections.synchronizedDatedSet.

Since:: 1.0
See Also:: TreeSetByDate, HashSetByElement, DatedSet, TreeMapByKey, DatedCollections.synchronizedDatedSet(DatedSet)

Constructor Summary
`TreeSetByElement()` Creates an empty `TreeSetByElement` that sorts its elements according to their natural ordering.
`TreeSetByElement(java.util.Comparator<? super E> comparator)` Creates an empty `TreeSetByElement` that uses the specified comparator to sort its elements.
`TreeSetByElement(DatedCollection<? extends E,D> datedCollection)` Creates a `TreeSetByElement` containing the elements and date ranges of the specified dated collection, sorted by the elements' natural ordering.
`TreeSetByElement(DatedSortedSet<E,D> datedSortedSet)` Creates a `TreeSetByElement` containing the elements and date ranges of the specified dated sorted set, ordered by the parameter's comparator object.

Method Summary
`Dates<D>`	`add(E value, D from, D to)` Adds the specified element to this dated collection for the specified date range.
`void`	`clear(D from, D to)` Removes all elements from this dated collection for the specified dates.
`java.lang.Object`	`clone()` Creates and returns a shallow copy of this object.
`java.util.Comparator<? super E>`	`comparator()` Returns the comparator used to sorted the elements of this dated set.
`boolean`	`contains(java.lang.Object value, D date)` Returns `true` if this dated collection contains the specified element on the specified date.
`boolean`	`containsThroughout(java.lang.Object value, D from, D to)` Returns `true` if this dated collection contains the specified element throughout the specified date range.
`DateIterator<D>`	`dateIterator(D at)` Returns an iterator of the date ranges of when this dated object has changed, starting at the range that contains the specified date.
`boolean`	`excludesThroughout(java.lang.Object value, D from, D to)` Returns `true` if this dated collection does not contain the specified element at any date within the specified date range.
`E`	`first(D at)` Returns the smallest element in this dated set at the specified date.
`boolean`	`hasSizeThroughout(int size, D from, D to)` Returns `true` if the number of elements in this dated collection is greater than or equal to the specified size throughout the specified date range.
`DatedSortedSet<E,D>`	`headSet(E toElement)` Returns a view of this dated set of all elements that precede `toElement`.
`boolean`	`isEmpty(D at)` Returns `true` if this dated collection contains no elements on the specified date.
`boolean`	`isEmptyThroughout(D from, D to)` Returns `true` if this dated collection contains no elements throughout the specified date range.
`Iterator<E,D>`	`iterator(D at)` Returns an iterator over the elements of this dated collection at the specified date.
`E`	`last(D at)` Returns the largest element in this dated set at the specified date.
`Dates<D>`	`remove(java.lang.Object value, D from, D to)` Removes an instance of the specified element from this dated collection for the specified date range.
`int`	`size(D at)` Returns the number of elements in this dated collection at the specified date.
`DatedSortedSet<E,D>`	`subSet(E fromElement, E toElement)` Returns a view of this dated set of all elements that fall between `fromElement` (inclusive) and `toElement` (exclusive).
`DatedSortedSet<E,D>`	`tailSet(E fromElement)` Returns a view of this dated set of all elements greater than or equal to `fromElement`.

Methods inherited from class sos.dated.util.AbstractDatedSet
`equals, hashCode`

Methods inherited from class sos.dated.util.AbstractDatedCollection
`addAll, containsAll, removeAll, retainAll, toArray, toArray, toString`

Methods inherited from class sos.dated.util.AbstractDatedObject
`dateIterator, equals, hashCode, toString`

Methods inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface sos.dated.util.DatedSet
`equals, hashCode`

Methods inherited from interface sos.dated.util.DatedCollection
`add, addAll, clear, contains, containsAll, containsThroughout, excludesThroughout, hasSizeThroughout, isEmpty, isEmptyThroughout, iterator, remove, removeAll, retainAll, size, toArray, toArray`

Methods inherited from interface sos.dated.util.DatedObject
`dateIterator, dateIterator, equals, hashCode, toString`

Constructor Detail

TreeSetByElement

public TreeSetByElement()

Creates an empty TreeSetByElement that sorts its elements according to their natural ordering.

TreeSetByElement

public TreeSetByElement(java.util.Comparator<? super E> comparator)

Creates an empty TreeSetByElement that uses the specified comparator to sort its elements. If the comparator is null, then the elements' natural ordering is used.

Parameters:: comparator - object to use to sort the elements (may be null)

TreeSetByElement

public TreeSetByElement(DatedCollection<? extends E,D> datedCollection)

Creates a TreeSetByElement containing the elements and date ranges of the specified dated collection, sorted by the elements' natural ordering.

Parameters:: datedCollection - elements and corresponding date ranges to store in the new TreeSetByElement
Throws:: java.lang.NullPointerException - if the parameter is null

TreeSetByElement

public TreeSetByElement(DatedSortedSet<E,D> datedSortedSet)

Creates a TreeSetByElement containing the elements and date ranges of the specified dated sorted set, ordered by the parameter's comparator object.

Parameters:: datedSortedSet - elements and corresponding date ranges to store in the new TreeSetByElement
Throws:: java.lang.NullPointerException - if the parameter is null

Method Detail

clone

public java.lang.Object clone()

Creates and returns a shallow copy of this object.

Overrides:: clone in class java.lang.Object

Returns:: a clone of this instance