net.sf.joafip.java.util.support.tree

Class TreeSupport<E>

java.lang.Object

net.sf.joafip.java.util.support.tree.TreeSupport<E>

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, ISupportListenable<E>

Direct Known Subclasses:

TreeListSupport

@StoreNotUseStandardSerialization
@StorableClass
public class TreeSupport<E>
extends Object
implements ISupportListenable<E>, Cloneable, Iterable<E>, Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	concurrentAccess
protected IInstanceFactory	instanceFactory
protected int	modificationCount
protected RedBlackTree<E>	tree not transient for persistence

Constructor Summary

Constructors

Modifier	Constructor and Description
	TreeSupport(boolean manageNodeIndex, boolean concurrentAccess)
	TreeSupport(Comparator<? super E> comparator, boolean manageNodeIndex, boolean concurrentAccess)
protected	TreeSupport(Comparator<? super E> comparator, boolean manageNodeIndex, boolean uniqueValue, boolean concurrentAccess)
protected	TreeSupport(IInstanceFactory instanceFactory, boolean manageNodeIndex, boolean concurrentAccess)
protected	TreeSupport(IInstanceFactory instanceFactory, Comparator<? super E> comparator, boolean manageNodeIndex, boolean concurrentAccess)
protected	TreeSupport(IInstanceFactory instanceFactory, Comparator<? super E> comparator, boolean manageNodeIndex, boolean uniqueValue, boolean concurrentAccess)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(E element)
protected void	addAll(TreeSupport<E> list) protected for persistence constraint
E	addReplace(E element)
protected void	appended(TreeSupportNode<E> nodeAppended)
void	clear()
TreeSupport<E>	clone()
E	closestGreaterOrEqual(E element)
IRBTNode<E>	closestGreaterOrEqualNode(E element)
E	closestLessOrEqual(E element)
IRBTNode<E>	closestLessOrEqualNode(E element)
Comparator<? super E>	comparator()
ListIterator<E>	descendingIterator()
ListIterator<E>	descendingIterator(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive) sublist of this list descending iterator
E	elementAtIndex(int index)
protected void	fireAdded(IRBTNode<E> toAdd)
protected void	fireRemoved(IRBTNode<E> toRemove)
E	first()
TreeSupportNode<E>	firstNode()
IInstanceFactory	getInstanceFactory()
int	getModificationCount()
RedBlackTree<E>	getTree()
int	index(E element) obtains the position of an element in sorted list view of this tree of sorted element
int	indexOfNode(IRBTNode<E> node)
boolean	isConcurrentAccess()
boolean	isEmpty()
boolean	isManageNodeIndex()
boolean	isNodeAttachedToTree(IRBTNode<E> node) to know if a node is attached to the tree
ListIterator<E>	iterator()
ListIterator<E>	iterator(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive) sublist of this list iterator
ListIterator<E>	iterator(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive, int index) sublist of this list iterator starting at index
ListIterator<E>	iterator(int index)
E	last()
TreeSupportNode<E>	lastNode()
ListIterator<E>	listIterator()
ListIterator<E>	listIterator(int index)
static TreeSupport	newInstance(IInstanceFactory instanceFactory, boolean manageNodeIndex, boolean concurrentAccess)
static TreeSupport	newInstance(IInstanceFactory instanceFactory, Comparator comparator, boolean manageNodeIndex, boolean concurrentAccess)
static TreeSupport	newInstance(IInstanceFactory instanceFactory, Comparator comparator, boolean manageNodeIndex, boolean uniqueValue, boolean concurrentAccess)
protected TreeSupportNode<E>	newTreeSupportNode(E element)
TreeSupportNode<E>	nextNode(TreeSupportNode<E> node)
TreeSupportNode<E>	nodeAtIndex(int index)
E	pollFirst()
E	pollLast()
TreeSupportNode<E>	previousNode(TreeSupportNode<E> node)
E	remove(E element)
E	remove(IRBTNode<E> toRemove) remove existing node
E	removeAt(int index)
E	removeFirst()
E	removeLast()
void	removeListener()
E	search(Object element)
void	setListener(ISupportListener<E> listener)
int	size()
E	strictlyGreater(E element)
IRBTNode<E>	strictlyGreaterNode(E element)
E	strictlyLess(E element)
IRBTNode<E>	strictlyLessNode(E element)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

tree

protected final RedBlackTree<E> tree

not transient for persistence

concurrentAccess

protected final boolean concurrentAccess

modificationCount

protected int modificationCount

instanceFactory

protected final transient IInstanceFactory instanceFactory

Constructor Detail

TreeSupport

public TreeSupport(Comparator<? super E> comparator,
           boolean manageNodeIndex,
           boolean concurrentAccess)

TreeSupport

protected TreeSupport(IInstanceFactory instanceFactory,
           Comparator<? super E> comparator,
           boolean manageNodeIndex,
           boolean concurrentAccess)

TreeSupport

protected TreeSupport(Comparator<? super E> comparator,
           boolean manageNodeIndex,
           boolean uniqueValue,
           boolean concurrentAccess)

TreeSupport

protected TreeSupport(IInstanceFactory instanceFactory,
           Comparator<? super E> comparator,
           boolean manageNodeIndex,
           boolean uniqueValue,
           boolean concurrentAccess)

TreeSupport

public TreeSupport(boolean manageNodeIndex,
           boolean concurrentAccess)

TreeSupport

protected TreeSupport(IInstanceFactory instanceFactory,
           boolean manageNodeIndex,
           boolean concurrentAccess)

Method Detail

newInstance

public static TreeSupport newInstance(IInstanceFactory instanceFactory,
                      Comparator comparator,
                      boolean manageNodeIndex,
                      boolean concurrentAccess)

newInstance

public static TreeSupport newInstance(IInstanceFactory instanceFactory,
                      Comparator comparator,
                      boolean manageNodeIndex,
                      boolean uniqueValue,
                      boolean concurrentAccess)

newInstance

public static TreeSupport newInstance(IInstanceFactory instanceFactory,
                      boolean manageNodeIndex,
                      boolean concurrentAccess)

getInstanceFactory

public IInstanceFactory getInstanceFactory()

isManageNodeIndex

public boolean isManageNodeIndex()

isConcurrentAccess

public boolean isConcurrentAccess()

getModificationCount

public int getModificationCount()

setListener

public void setListener(ISupportListener<E> listener)

Specified by:

setListener in interface ISupportListenable<E>

removeListener

public void removeListener()

Specified by:

removeListener in interface ISupportListenable<E>

fireAdded

protected void fireAdded(IRBTNode<E> toAdd)
                  throws RBTException

Throws:

RBTException

fireRemoved

protected void fireRemoved(IRBTNode<E> toRemove)
                    throws RBTException

Throws:

RBTException

size

public int size()

isEmpty

public boolean isEmpty()

search

public E search(Object element)

remove

public E remove(E element)

removeAt

public E removeAt(int index)

removeFirst

public E removeFirst()

removeLast

public E removeLast()

remove

public E remove(IRBTNode<E> toRemove)

remove existing node

Parameters:

toRemove - exixting node to remove

Returns:

removed element

add

public void add(E element)

addReplace

public E addReplace(E element)

appended

protected void appended(TreeSupportNode<E> nodeAppended)

addAll

protected void addAll(TreeSupport<E> list)

protected for persistence constraint

Parameters:

list -

clear

public void clear()

comparator

public Comparator<? super E> comparator()

strictlyLess

public E strictlyLess(E element)

strictlyLessNode

public IRBTNode<E> strictlyLessNode(E element)
                             throws RBTException

Throws:

RBTException

closestLessOrEqual

public E closestLessOrEqual(E element)

closestLessOrEqualNode

public IRBTNode<E> closestLessOrEqualNode(E element)
                                   throws RBTException

Throws:

RBTException

strictlyGreater

public E strictlyGreater(E element)

strictlyGreaterNode

public IRBTNode<E> strictlyGreaterNode(E element)
                                throws RBTException

Throws:

RBTException

closestGreaterOrEqual

public E closestGreaterOrEqual(E element)

closestGreaterOrEqualNode

public IRBTNode<E> closestGreaterOrEqualNode(E element)
                                      throws RBTException

Throws:

RBTException

pollFirst

public E pollFirst()

pollLast

public E pollLast()

first

public E first()

firstNode

public TreeSupportNode<E> firstNode()

last

public E last()

lastNode

public TreeSupportNode<E> lastNode()

newTreeSupportNode

protected TreeSupportNode<E> newTreeSupportNode(E element)

Parameters:

element -

Returns:

index

public int index(E element)

obtains the position of an element in sorted list view of this tree of sorted element

Parameters:

element - the element searching its index

Returns:

index of the node in the sorted list view of this tree, or -1 if not found

indexOfNode

public int indexOfNode(IRBTNode<E> node)

elementAtIndex

public E elementAtIndex(int index)

nodeAtIndex

public TreeSupportNode<E> nodeAtIndex(int index)

nextNode

public TreeSupportNode<E> nextNode(TreeSupportNode<E> node)

previousNode

public TreeSupportNode<E> previousNode(TreeSupportNode<E> node)

iterator

public ListIterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Returns:

the iterator

iterator

public ListIterator<E> iterator(int index)

listIterator

public ListIterator<E> listIterator()

listIterator

public ListIterator<E> listIterator(int index)

iterator

public ListIterator<E> iterator(E fromElement,
                       boolean fromInclusive,
                       E toElement,
                       boolean toInclusive)

sublist of this list iterator

Parameters:

fromElement - starting element for iteration

fromInclusive - true if starting element is included in iteration

toElement - ending element for iteration

toInclusive - true if ending element is included in iteration

Returns:

iterator in sublist

iterator

public ListIterator<E> iterator(E fromElement,
                       boolean fromInclusive,
                       E toElement,
                       boolean toInclusive,
                       int index)

sublist of this list iterator starting at index

Parameters:

fromElement - starting element for iteration

fromInclusive - true if starting element is included in iteration

toElement - ending element for iteration

toInclusive - true if ending element is included in iteration

index - start index

Returns:

iterator in sublist

descendingIterator

public ListIterator<E> descendingIterator()

Returns:

the descending iterator

descendingIterator

public ListIterator<E> descendingIterator(E fromElement,
                                 boolean fromInclusive,
                                 E toElement,
                                 boolean toInclusive)

sublist of this list descending iterator

Parameters:

fromElement - ending element for iteration

fromInclusive - true if ending element is included in iteration

toElement - starting element for iteration

toInclusive - true if starting element is included in iteration

Returns:

descending iterator in sublist

clone

public TreeSupport<E> clone()

Overrides:

clone in class Object

isNodeAttachedToTree

public boolean isNodeAttachedToTree(IRBTNode<E> node)

to know if a node is attached to the tree

Parameters:

node - node to check if attached to the tree

Returns:

true if node attached to the tree

getTree

@Fortest
public RedBlackTree<E> getTree()