2.8.0: 2008-09-08

net.sf.basedb.util.overview
Class Node

java.lang.Object
  extended by net.sf.basedb.util.overview.Node

public class Node
extends Object

A node in an overview. There are two types of nodes: folder nodes and item nodes. The only difference is that an item node has a link to a BasicItem (see getItem() but a folder node does not. Both node types can have child nodes.

Each node has a unique ID (getId()) which is based on the system hashcode. Each node also has a name which should be unique among the child nodes. If the name isn't unique the getChild(String) returns the first matching node.

Version:
2.2
Author:
Nicklas
Last modified
$Date: 2008-09-05 17:16:27 +0200 (Fri, 05 Sep 2008) $

Nested Class Summary
static class Node.Type
          The type of node.
 
Field Summary
private  int childErrors
           
private  List<Node> children
           
private  int childWarnings
           
private  BasicItem item
           
private  String name
           
private  int numErrors
           
private  int numWarnings
           
private  Node parent
           
private  String title
           
private  Node.Type type
           
 
Constructor Summary
  Node(String name, String title, BasicItem item)
          Create an item-type root node.
  Node(String name, String title, Node parent)
          Create a folder-type child node.
  Node(String name, String title, Node parent, BasicItem item)
          Create an item-type child node
private Node(String name, String title, Node parent, BasicItem item, Node.Type type)
           
 
Method Summary
protected  void addChild(Node child)
          Add a child node to this one.
protected  void addChildErrors(int numErrors)
          Add child errors to this node.
protected  void addChildWarnings(int numWarnings)
          Add child warnings to this node.
 void addErrors(int numErrors)
          Add more errors to this node.
 void addWarnings(int numWarnings)
          Add more warnings to this node.
 void clearFailures()
          Clear all warnings, errors on this node and on all child nodes.
 Node getChild(String name)
          Get the child node with a specific name.
 int getChildErrors()
          Get the number of errors to children of this node.
 List<Node> getChildren()
          Get all child nodes of this node.
 int getChildWarnings()
          Get the number of warnings to children of this node.
 String getId()
          Get a unique ID for this node.
 BasicItem getItem()
          Get the item that is related to this node.
 String getName()
          Get the name of this node.
 Node.Type getNodeType()
          Get the node type of this node.
 int getNumErrors()
          Get the number of errors on this node.
 int getNumWarnings()
          Get the number of warnings on this node.
 Node getParent()
          Get the parent of this node.
 String getTitle()
          Get the display title of this node.
 void setErrors(int numErrors)
          Set the number of errors that was found while validating this node.
 void setWarnings(int numWarnings)
          Set the number of warnings that was found while validating this node.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

private String name

title

private String title

item

private BasicItem item

parent

private Node parent

type

private Node.Type type

children

private List<Node> children

numWarnings

private int numWarnings

numErrors

private int numErrors

childWarnings

private int childWarnings

childErrors

private int childErrors
Constructor Detail

Node

public Node(String name,
            String title,
            BasicItem item)
Create an item-type root node.

Parameters:
name - The name of the node
title - The display title of the node
item - The item the node references
See Also:
ExperimentOverview.getRootNode()

Node

public Node(String name,
            String title,
            Node parent)
Create a folder-type child node.

Parameters:
name - The name of the child node
title - The display title of the node
parent - The parent node

Node

public Node(String name,
            String title,
            Node parent,
            BasicItem item)
Create an item-type child node

Parameters:
name - The name of the child node
title - The display title of the node
parent - The parent node
item - The item this node references

Node

private Node(String name,
             String title,
             Node parent,
             BasicItem item,
             Node.Type type)
Method Detail

getId

public String getId()
Get a unique ID for this node. The ID is based on the hashcode and should be unique for a given virtual machine.


getNodeType

public Node.Type getNodeType()
Get the node type of this node. Note that for folder-type nodes the getItem() always return null. It it returns null for an item-type node it usually means that access was denied to that particular item.


getName

public String getName()
Get the name of this node. If the name is unique among the child nodes for a parent the call getParent().getChild(this.getName()) should return this node.


getTitle

public String getTitle()
Get the display title of this node.


getItem

public BasicItem getItem()
Get the item that is related to this node. Folder-type nodes always return null. If an item-type node returns null it usually means that access was denied to the item.


getParent

public Node getParent()
Get the parent of this node. Returns null if this is the root node.


getChildren

public List<Node> getChildren()
Get all child nodes of this node. May return null or an empty list if this node has no children.


getChild

public Node getChild(String name)
Get the child node with a specific name. If more than one node has the same name only the first one found is returned.

Parameters:
name - The name of the child node.

addChild

protected void addChild(Node child)
Add a child node to this one.


setWarnings

public void setWarnings(int numWarnings)
Set the number of warnings that was found while validating this node. This method automatically updates the number of child warnings reported by parent nodes.

Parameters:
numWarnings - The number of warnings
See Also:
addWarnings(int)

addWarnings

public void addWarnings(int numWarnings)
Add more warnings to this node. This method automatically updates the number of child warnings reported by parent nodes.

Parameters:
numWarnings - The numer of warnings to add
See Also:
setWarnings(int)

addChildWarnings

protected void addChildWarnings(int numWarnings)
Add child warnings to this node. This method is called by child nodes when the warnings are updated on them.


setErrors

public void setErrors(int numErrors)
Set the number of errors that was found while validating this node. This method automatically updates the number of child errors reported by parent nodes.

Parameters:
numErrors - The number of errors
See Also:
addErrors(int)

addErrors

public void addErrors(int numErrors)
Add more errors to this node. This method automatically updates the number of child errors reported by parent nodes.

Parameters:
numErrors - The numer of errors to add
See Also:
setErrors(int)

addChildErrors

protected void addChildErrors(int numErrors)
Add child errors to this node. This method is called by child nodes when the errors are updated on them.


getNumWarnings

public int getNumWarnings()
Get the number of warnings on this node.

See Also:
getChildWarnings()

getNumErrors

public int getNumErrors()
Get the number of errors on this node.

See Also:
getChildErrors()

getChildWarnings

public int getChildWarnings()
Get the number of warnings to children of this node.

See Also:
getNumWarnings()

getChildErrors

public int getChildErrors()
Get the number of errors to children of this node.

See Also:
getNumErrors()

clearFailures

public void clearFailures()
Clear all warnings, errors on this node and on all child nodes.


2.8.0: 2008-09-08