com.escenic.common.util.tree

Class RecursiveView<N>

java.lang.Object

com.escenic.common.util.tree.AbstractView<N>

com.escenic.common.util.tree.SimpleView<N>

com.escenic.common.util.tree.RecursiveView<N>

All Implemented Interfaces:

View<N>, Iterable<N>

public class RecursiveView<N>
extends SimpleView<N>

This is a View that contains only descendants of a spesific item. It's possible to influence the number of levels to include in this View as well as the number of siblings on a given level to include.

Use the different constructors to create a RecursiveView that suits your needs.

Field Summary

Fields inherited from class com.escenic.common.util.tree.SimpleView

objectInView

Fields inherited from class com.escenic.common.util.tree.AbstractView

mTree

Constructor Summary

Constructors

Constructor and Description
RecursiveView(Tree<N> pTree, N rootItem) Creates a RecursiveView that includes all decendants of the rootItem.
RecursiveView(Tree<N> pTree, N rootItem, boolean includeRoot) Creates a RecursiveView that includes all decendants of the rootItem, but you can remove the rootItem from the View.
RecursiveView(Tree<N> pTree, N rootItem, int depth) Creates a RecursiveView that includes the rootItem, but only down to a set depth.
RecursiveView(Tree<N> pTree, N rootItem, int depth, boolean includeRoot) Creates a RecursiveView with limitations in depth.
RecursiveView(Tree<N> pTree, N rootItem, int depth, int children) Creates a RecursiveView with limitations in: depth and children.
RecursiveView(Tree<N> pTree, N rootItem, int depth, int children, boolean includeRoot) Creates a RecursiveView with limitations in: depth, children and whether or not to include the rootItem.

Method Summary

Modifier and Type	Method and Description
boolean	isItemInView(N pItem) Returns true if the specified item is in View

Methods inherited from class com.escenic.common.util.tree.AbstractView

exclude, getTree, include, iterator, relationships, walker

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RecursiveView

public RecursiveView(Tree<N> pTree,
                     N rootItem)

Creates a RecursiveView that includes all decendants of the rootItem.

Parameters:

pTree - the Tree to get the View from.

rootItem - the item to use as the base for the View.

RecursiveView

public RecursiveView(Tree<N> pTree,
                     N rootItem,
                     boolean includeRoot)

Creates a RecursiveView that includes all decendants of the rootItem, but you can remove the rootItem from the View.

Parameters:

pTree - the Tree to get the View from.

rootItem - the item to use as the base for the View.

includeRoot - set to true to include the rootItem

RecursiveView

public RecursiveView(Tree<N> pTree,
                     N rootItem,
                     int depth)

Creates a RecursiveView that includes the rootItem, but only down to a set depth. All siblings on a given depth is included in this View.

Parameters:

pTree - the Tree to get the View from.

rootItem - the item to use as the base for the View.

depth - the number of levels to include in this view. Setting this to 1 gives you the direct siblings of the rootItem

RecursiveView

public RecursiveView(Tree<N> pTree,
                     N rootItem,
                     int depth,
                     int children)

Creates a RecursiveView with limitations in: depth and children.

Parameters:

pTree - the Tree to get the View from.

rootItem - the item to use as the base for the View.

depth - the number of levels to include in this view. Setting this to 1 gives you the direct siblings of the rootItem

children - the maximum number of children to include from each node.

RecursiveView

public RecursiveView(Tree<N> pTree,
                     N rootItem,
                     int depth,
                     boolean includeRoot)

Creates a RecursiveView with limitations in depth. You can also choose to exclude the rootItem from the View.

Parameters:

pTree - the Tree to get the View from.

rootItem - the item to use as the base for the View.

depth - the number of levels to include in this view. Setting this to 1 gives you the direct siblings of the rootItem

includeRoot - set to true to include the rootItem

RecursiveView

public RecursiveView(Tree<N> pTree,
                     N rootItem,
                     int depth,
                     int children,
                     boolean includeRoot)

Creates a RecursiveView with limitations in: depth, children and whether or not to include the rootItem.

Parameters:

pTree - the Tree to get the View from.

rootItem - the item to use as the base for the View.

depth - the number of levels to include in this view. Setting this to 1 gives you the direct siblings of the rootItem

children - the maximum number of children to include from each node.

includeRoot - set to true to include the rootItem

Method Detail

isItemInView

public boolean isItemInView(N pItem)

Description copied from interface: View

Returns true if the specified item is in View

Specified by:

isItemInView in interface View<N>

Overrides:

isItemInView in class SimpleView<N>

Parameters:

pItem - the item you want to check to see if it's in the View

Returns:

true if pItem is in View, false otherwise.