com.revolsys.ui.web.config

Class SiteNode

java.lang.Object

com.revolsys.ui.web.config.SiteNode

All Implemented Interfaces:

Cloneable, Comparable

public final class SiteNode
extends Object
implements Comparable, Cloneable

Constructor Summary

Constructors

Constructor and Description
SiteNode() Construct a new root SiteNode.
SiteNode(SiteNode node) Construct a deep copy of the node.
SiteNode(SiteNodeController controller) Construct a new SiteNode for the controller.
SiteNode(String path) Construct a new site node with the specified path.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addNode(SiteNode node) Add the node as a child of this node.
protected Object	clone() Create a deep copy of this node.
int	compareTo(Object o) Compare this node to another node.
SiteNode	findSiteNode(String path) Find the site node matching the path.
SiteNodeController	getController() Get the controller for this node.
SiteNodeController	getController(String path) Get the controller for the node specified by the path (see findSiteNode(String) for a description how the path is processed.
String	getFullPath() Get the full path to the node, including the path's of all parents.
SiteNode	getNode(String name) Get the child site node with the specified name.
Collection	getNodes() Get the collection of child nodes.
SiteNode	getParent()
String	getPath() Get the path for the node relative to the parenr node.
boolean	hasController() Check to see if this node has a controller.
boolean	hasParent() Check to see if this node has a parent.
protected void	mergeNode(SiteNode node) Merge the values of the specified node with this node.
void	setController(SiteNodeController controller) Set the controller for this node.
void	setController(String path, SiteNodeController controller) Set the controller for the node specified by the path name.
void	setNode(String path, SiteNode node) Set the node for the specified path.
void	setNodes(Collection nodes) Set the child site nodes.
void	setParent(SiteNode parent)
void	setPath(String path)
String	toString() Get the string representation of the node.

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteNode

public SiteNode()

Construct a new root SiteNode.

SiteNode

public SiteNode(SiteNode node)

Construct a deep copy of the node. Does not retain the reference to the parent node.

Parameters:

node - The node to copy.

SiteNode

public SiteNode(SiteNodeController controller)

Construct a new SiteNode for the controller.

Parameters:

controller - The controller.

SiteNode

public SiteNode(String path)

Construct a new site node with the specified path.

Parameters:

path - The path.

Method Detail

addNode

protected void addNode(SiteNode node)

Add the node as a child of this node.

Parameters:

node - The node.

clone

protected Object clone()

Create a deep copy of this node. Does not retain the reference to the parent node.

Overrides:

clone in class Object

Returns:

The cloned node.

compareTo

public int compareTo(Object o)

Compare this node to another node. The comparison is performed on the path.

Specified by:

compareTo in interface Comparable

Parameters:

o - The object to compare.

Returns:

-1 (less than), 0 (equal) or 1 (greater than).

findSiteNode

public SiteNode findSiteNode(String path)

Find the site node matching the path.

Parameters:

path - The path.

Returns:

The site node.

getController

public SiteNodeController getController()

Get the controller for this node.

Returns:

The controller for this node.

getController

public SiteNodeController getController(String path)

Get the controller for the node specified by the path (see findSiteNode(String) for a description how the path is processed.

Parameters:

path - The path.

Returns:

The controller.

getFullPath

public String getFullPath()

Get the full path to the node, including the path's of all parents.

Returns:

The path.

getNode

public SiteNode getNode(String name)

Get the child site node with the specified name. The name cannot contain the '/' character, see (findSiteNode(String) to get a child node using a path.

Parameters:

name - The child node name.

Returns:

The site node or null if not found.

getNodes

public Collection getNodes()

Get the collection of child nodes.

Returns:

The collection of nodes.

getParent

public SiteNode getParent()

Returns:

Returns the parent.

getPath

public String getPath()

Get the path for the node relative to the parenr node.

Returns:

The path.

hasController

public boolean hasController()

Check to see if this node has a controller.

Returns:

True if the node has a controller.

hasParent

public boolean hasParent()

Check to see if this node has a parent.

Returns:

True if the node has a parent.

mergeNode

protected void mergeNode(SiteNode node)

Merge the values of the specified node with this node.

Parameters:

node - The node to merge from.

setController

public void setController(SiteNodeController controller)

Set the controller for this node.

Parameters:

controller - The controller.

setController

public void setController(String path,
                 SiteNodeController controller)

Set the controller for the node specified by the path name. If the controller's node already has a parent node, clone the controller so that changing the values on the controller on one path does not affect the other. See setNode(String, SiteNode) for details on how the controller for the node is set.

Parameters:

path - The path.

controller - The controller.

setNode

public void setNode(String path,
           SiteNode node)

Set the node for the specified path. A node will be created for each element in the path if one does not exist. If the last element does not exist the node will be set as the node for that element. If it does exist the values for the existing node will be merged from the new node. *

Parameters:

path - The path.

node - The node.

setNodes

public void setNodes(Collection nodes)

Set the child site nodes. The collection can contain SiteNode or SiteNodeController instances. If the node's path contains a '/' character a node will be created for each element of the path. For SiteNodeController instances the node from the controller will be merged with the existing node for the path if a node with that path already existed.

Parameters:

nodes - The site nodes

setParent

public void setParent(SiteNode parent)

Parameters:

parent - The parent to set.

setPath

public void setPath(String path)

Parameters:

path - The path to set.

toString

public String toString()

Get the string representation of the node.

Overrides:

toString in class Object

Returns:

The string representation.