|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PermissionTreeView
Method Summary | |
---|---|
java.util.Iterator |
breadthFirstIterator()
Obtain a breadth-first Iterator over the whole tree starting at the root. |
java.util.Iterator |
breadthFirstIterator(PermissionNode startingPoint)
Obtain a breadth-first Iterator starting at the given node. |
java.util.List |
getChildren(PermissionNode parent)
Obtain the set of entries that are considered the children of the specified PermissionDataNode . |
java.util.List |
getDescendants(PermissionNode startingPoint)
Obtain all the PermissionDataNode s in the tree under the given
node. |
java.util.Set |
getMarked()
Obtain all the marked PermissionDataNode s in the tree. |
java.util.Set |
getMarkedDescendants(PermissionNode startingPoint)
Obtain all the marked PermissionDataNode s in the tree under the
given node. |
java.util.List |
getModified()
Obtain all the modified PermissionDataNode s in the tree.This method will get hidden nodes if showHidden == true . |
java.util.List |
getModifiedBreadthFirst()
Obtain the modified PermissionDataNode s closest to the root in the tree. |
java.util.List |
getModifiedDescendants(PermissionNode startingPoint)
Obtain all the modified PermissionDataNode s in the tree under the
given node. |
PermissionNode |
getParent(PermissionNode entry)
Determine the parent PermissionDataNode for the specified entry, or null if
the specified entry is a root. |
PermissionNode |
getRoot()
Obtain the root PermissionDataNode of the tree. |
java.util.List |
getRoots()
Obtain a list of PermissionDataNode s which are the children of the root. |
java.util.List |
getUnModifiedDescendants(PermissionNode startingPoint)
Obtain all the unmodified PermissionDataNode s in the tree under the
given node. |
boolean |
isDescendantOf(PermissionNode ancestor,
PermissionNode descendant)
Determine whether the given descendant is a descendant of the given
ancestor .This method will check all descendants of the ancester, even if they are marked hidden. |
java.util.Iterator |
iterator()
Obtain a depth-first Iterator over the whole tree starting at the root. |
java.util.Iterator |
iterator(PermissionNode startingPoint)
Obtain a depth-first Iterator starting at the given node. |
void |
resetTree()
Reset all tree nodes to their original AuthorizationActions values. |
void |
setBranchHidden(PermissionNode startingPoint)
Set the subtree rooted at this node as hidden. |
void |
setMarked(PermissionNode entry,
boolean markedState)
(Un)Mark this node. |
void |
setShowHidden(boolean showHidden)
Determines whether methods in this class return hidden nodes in results. |
Method Detail |
---|
void resetTree()
AuthorizationActions
values.
void setShowHidden(boolean showHidden)
false
(don't show hidden nodes).
showHidden
- If true
, hidden nodes will be returned in results, if
false
, they will not.void setMarked(PermissionNode entry, boolean markedState)
entry
- The node to mark or unmark.markedState
- If true
, the node will be marked, if false
,
the node will be unmarked.void setBranchHidden(PermissionNode startingPoint)
entry
- The node to mark or unmark.setShowHidden
java.util.Iterator iterator(PermissionNode startingPoint)
Iterator
starting at the given node.
java.util.Iterator iterator()
Iterator
over the whole tree starting at the root.
java.util.Iterator breadthFirstIterator(PermissionNode startingPoint)
Iterator
starting at the given node.
java.util.Iterator breadthFirstIterator()
Iterator
over the whole tree starting at the root.
PermissionNode getRoot()
PermissionDataNode
of the tree. The root of this tree is always
hidden but will always be returned even if the state of showHidden
is
false
.
java.util.List getRoots()
PermissionDataNode
s which are the children of the root. These
nodes are the real roots of the tree, since the root is just a placeholder that holds
the real roots.
PermissionDataNode
s that are the roots of the forest.PermissionNode getParent(PermissionNode entry)
PermissionDataNode
for the specified entry, or null if
the specified entry is a root.
entry
- the PermissionDataNode
instance for which the parent is to be obtained;
may not be null
java.util.List getChildren(PermissionNode parent)
PermissionDataNode
.
parent
- the PermissionDataNode
instance for which the child entries
are to be obtained; may not be null
PermissionDataNode
instances that are considered
the children of the specified entry; never null but possibly emptyboolean isDescendantOf(PermissionNode ancestor, PermissionNode descendant)
descendant
is a descendant of the given
ancestor
.
ancestor
- The node to check to see if it is an ancestor of the descendant
.descendant
- The node to check to see if it is a descendant ancestor
.
true
if ancestor
is the ancestor of descendant
.java.util.Set getMarked()
PermissionDataNode
s in the tree. Note that the
nodes are not nessesarily in tree form. They are just a collection of nodes.showHidden == true
.
Set
of all marked nodes in the tree.java.util.Set getMarkedDescendants(PermissionNode startingPoint)
PermissionDataNode
s in the tree under the
given node. Note that the nodes are not nessesarily in tree form. They are just a
collection of nodes.
showHidden == true
.
Set
of all marked nodes in the tree below startingPoint
.java.util.List getDescendants(PermissionNode startingPoint)
PermissionDataNode
s in the tree under the given
node.
showHidden == true
.
startingPoint
- The point in the tree to start the search for descendants.
List
of all nodes in the tree below startingPoint
.java.util.List getModified()
PermissionDataNode
s in the tree.showHidden == true
.
List
of all modified nodes in the tree.java.util.List getModifiedBreadthFirst()
PermissionDataNode
s closest to the root in the tree.
showHidden == true
.
List
of all top level modified nodes in the tree.java.util.List getModifiedDescendants(PermissionNode startingPoint)
PermissionDataNode
s in the tree under the
given node. Note that the nodes are not nessesarily in tree form.
showHidden == true
.
List
of all modified nodes in the tree below startingPoint
.java.util.List getUnModifiedDescendants(PermissionNode startingPoint)
PermissionDataNode
s in the tree under the
given node. Note that the nodes are not nessesarily in tree form.
showHidden == true
.
List
of all unmodified nodes in the tree below startingPoint
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |