org.glassfish.flashlight.datatree.impl

Class AbstractTreeNode

java.lang.Object

org.glassfish.flashlight.datatree.impl.AbstractTreeNode

All Implemented Interfaces:

Comparable<TreeNode>, TreeElement, TreeNode

Direct Known Subclasses:

AverageImpl, CounterImpl, MethodInvokerImpl, TimeStatsAbstractImpl, TreeNodeImpl

public abstract class AbstractTreeNode
extends Object
implements TreeNode, Comparable<TreeNode>

Author:

Harpreet Singh, Byron Nevins 12/18/2010 -- Added encode/decode. Note that the encoded form for a dot is NOT something like "\\." -- there is too much code around making assumptions about dots, splitting strings, etc. So we replace with ___MONDOT___

Field Summary

Fields

Modifier and Type	Field and Description
protected String	category
protected Map<String,TreeNode>	children
protected String	description
protected boolean	enabled
protected String	name

Constructor Summary

Constructors

Constructor and Description
AbstractTreeNode()

Method Summary

Modifier and Type	Method and Description
TreeNode	addChild(TreeNode newChild)
int	compareTo(TreeNode other)
boolean	equals(Object o)
String	getCategory()
TreeNode	getChild(String childName)
Collection<TreeNode>	getChildNodes() Returns a mutable view of the children
Enumeration<TreeNode>	getChildNodesImmutable()
String	getCompletePathName()
String	getDescription()
Collection<TreeNode>	getEnabledChildNodes() Returns a mutable view of the children
String	getName()
TreeNode	getNode(String completeName)
List<TreeNode>	getNodes(String pattern) Behaves as {@link #getNodes (String, boolean, boolean) with ignoreDisabled set to true and gfV2Compatible set to true Pattern is considered to be a GFV2 Compatible Pattern
List<TreeNode>	getNodes(String pattern, boolean ignoreDisabled, boolean gfv2Compatible) Returns all nodes that match the given Regex pattern as specified by the Pattern class.
TreeNode	getParent()
TreeNode	getPossibleParentNode(String pattern) Get the "parent" matching the given pattern.
Object	getValue()
boolean	hasChildNodes()
int	hashCode()
boolean	isEnabled()
void	removeChild(TreeNode oldChild)
void	setCategory(String category)
void	setDescription(String description)
void	setEnabled(boolean enabled)
void	setName(String aname)
void	setParent(TreeNode parent)
String	toString()
List<TreeNode>	traverse(boolean ignoreDisabled) Returns all the nodes under the current tree

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

children

protected Map<String,TreeNode> children

name

protected String name

category

protected String category

description

protected String description

enabled

protected boolean enabled

Constructor Detail

AbstractTreeNode

public AbstractTreeNode()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Specified by:

getName in interface TreeElement

setName

public void setName(String aname)

Specified by:

setName in interface TreeElement

getValue

public Object getValue()

Specified by:

getValue in interface TreeElement

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface TreeNode

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface TreeNode

addChild

public TreeNode addChild(TreeNode newChild)

Specified by:

addChild in interface TreeNode

getCompletePathName

public String getCompletePathName()

Specified by:

getCompletePathName in interface TreeNode

Returns:

complete dotted name to this node

setParent

public void setParent(TreeNode parent)

Specified by:

setParent in interface TreeNode

getParent

public TreeNode getParent()

Specified by:

getParent in interface TreeNode

getChildNodes

public Collection<TreeNode> getChildNodes()

Returns a mutable view of the children

Specified by:

getChildNodes in interface TreeNode

Returns:

getEnabledChildNodes

public Collection<TreeNode> getEnabledChildNodes()

Returns a mutable view of the children

Specified by:

getEnabledChildNodes in interface TreeNode

Returns:

getChildNodesImmutable

public Enumeration<TreeNode> getChildNodesImmutable()

hasChildNodes

public boolean hasChildNodes()

Specified by:

hasChildNodes in interface TreeNode

removeChild

public void removeChild(TreeNode oldChild)

Specified by:

removeChild in interface TreeNode

getCategory

public String getCategory()

Specified by:

getCategory in interface TreeNode

setCategory

public void setCategory(String category)

Specified by:

setCategory in interface TreeNode

getDescription

public String getDescription()

Specified by:

getDescription in interface TreeNode

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface TreeNode

getChild

public TreeNode getChild(String childName)

Specified by:

getChild in interface TreeNode

getNode

public TreeNode getNode(String completeName)

Specified by:

getNode in interface TreeNode

Parameters:

completeName - dotted name to the node

Returns:

TreeNode uniquely identified tree node. Null if no matching tree node.

traverse

public List<TreeNode> traverse(boolean ignoreDisabled)

Returns all the nodes under the current tree

Specified by:

traverse in interface TreeNode

Parameters:

ignoreDisabled - will ignore a disabled node and its children

Returns:

List of all nodes in the current tree

getNodes

public List<TreeNode> getNodes(String pattern,
                               boolean ignoreDisabled,
                               boolean gfv2Compatible)

Description copied from interface: TreeNode

Returns all nodes that match the given Regex pattern as specified by the Pattern class. Admin CLI in GlassFish v2 did not use Pattern's specified in java.util.Pattern. It had a simpler mechanism where * was equivalent to .* from Pattern If the V2Compatible flag is turned on, then the pattern is considered a v2 pattern.

Specified by:

getNodes in interface TreeNode

Parameters:

pattern - Find a node that matches the pattern. By default pattern should follow the conventions outlined by the java.util.regex.Pattern class.

ignoreDisabled - will ignore a disabled node and its children

gfv2Compatible - in this mode, * has the same meaning as .* in the Pattern class. The implementation should consider pattern as a v2 pattern.

Returns:

getNodes

public List<TreeNode> getNodes(String pattern)

Description copied from interface: TreeNode

Behaves as {@link #getNodes (String, boolean, boolean) with ignoreDisabled set to true and gfV2Compatible set to true Pattern is considered to be a GFV2 Compatible Pattern

Specified by:

getNodes in interface TreeNode

compareTo

public int compareTo(TreeNode other)

Specified by:

compareTo in interface Comparable<TreeNode>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getPossibleParentNode

public TreeNode getPossibleParentNode(String pattern)

Description copied from interface: TreeNode

Get the "parent" matching the given pattern. E.g "server.jvm.memory.maxheapsize-count" is the parent of "server.jvm.memory.maxheapsize-count-count" Note that in V3 the latter will NOT be found with getNodes()

Specified by:

getPossibleParentNode in interface TreeNode

Parameters:

pattern - Find a node that matches the pattern. By default pattern should follow the conventions outlined by the java.util.regex.Pattern class.

Returns:

The parent node if found otherwise null.