com.avaje.ebeaninternal.server.lib.util

Class Dnode

java.lang.Object

com.avaje.ebeaninternal.server.lib.util.Dnode

public class Dnode
extends Object

A lightweight tree structure for simple XML handling.

It removes support for nodes being mixed with content. That is, a node can only contain content or a list of one or more child nodes. It does not support mixing bits of content between the child nodes.

Although designed to simplify XML in supported cases it can be used as a general tree structure with attributes of java Objects.

Constructor Summary

Constructors

Constructor and Description
Dnode() Create a node.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChild(Dnode child) Add a child.
Iterator<String>	attributeNames() The attribute names as strings.
List<Dnode>	children() List of children nodes.
Dnode	find(String nodeName) Find the first matching node using nodeName.
Dnode	find(String nodeName, String attrName, Object value) Find the first node matching nodeName and attribute value.
Dnode	find(String nodeName, String attrName, Object value, int maxLevel) Search for a single node with control over maxLevel.
List<Dnode>	findAll(String nodeName, int maxLevel) Find all the nodes that match the nodeName.
List<Dnode>	findAll(String nodeName, String attrName, Object value, int maxLevel) Find all the nodes that match the nodeName and attribute value.
StringBuilder	generate(StringBuilder sb) Generate this node as xml to the buffer.
String	getAttribute(String name) Return the attribute for a given name.
int	getChildrenCount() Return the number of children this node has.
int	getLevel() Return the level or depth of the node from the root.
String	getNodeContent() Return the node content.
String	getNodeName() Return the node name.
String	getStringAttr(String name, String defaultValue) Returns an Attribute as a String.
boolean	hasChildren() Return true if this node has children.
static Dnode	parse(String s) Parse the raw XML string.
boolean	remove(Dnode node) Remove a ancestor node.
void	setAttribute(String name, String value) Set an attribute.
void	setLevel(int level) Set the level or depth of this node from the root.
void	setNodeContent(String nodeContent) Set the node content.
void	setNodeName(String nodeName) Set the node name.
String	toString()
String	toXml() Return the node as XML.

Methods inherited from class java.lang.Object

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

Constructor Detail

Dnode

public Dnode()

Create a node.

Method Detail

parse

public static Dnode parse(String s)

Parse the raw XML string.

toXml

public String toXml()

Return the node as XML.

generate

public StringBuilder generate(StringBuilder sb)

Generate this node as xml to the buffer.

getNodeName

public String getNodeName()

Return the node name.

setNodeName

public void setNodeName(String nodeName)

Set the node name.

getNodeContent

public String getNodeContent()

Return the node content.

setNodeContent

public void setNodeContent(String nodeContent)

Set the node content.

hasChildren

public boolean hasChildren()

Return true if this node has children.

getChildrenCount

public int getChildrenCount()

Return the number of children this node has.

remove

public boolean remove(Dnode node)

Remove a ancestor node.

children

public List<Dnode> children()

List of children nodes.

addChild

public void addChild(Dnode child)

Add a child.

getLevel

public int getLevel()

Return the level or depth of the node from the root.

setLevel

public void setLevel(int level)

Set the level or depth of this node from the root.

find

public Dnode find(String nodeName)

Find the first matching node using nodeName. This is a depth first tree search.

find

public Dnode find(String nodeName,
         String attrName,
         Object value)

Find the first node matching nodeName and attribute value. This is a depth first tree search.

find

public Dnode find(String nodeName,
         String attrName,
         Object value,
         int maxLevel)

Search for a single node with control over maxLevel. Find the first node matching nodeName and attribute value. If attrName and value are null then this will just search using the nodeName. This is a depth first tree search. Once a matching node is found the search will stop.

findAll

public List<Dnode> findAll(String nodeName,
                  int maxLevel)

Find all the nodes that match the nodeName.

findAll

public List<Dnode> findAll(String nodeName,
                  String attrName,
                  Object value,
                  int maxLevel)

Find all the nodes that match the nodeName and attribute value.

attributeNames

public Iterator<String> attributeNames()

The attribute names as strings.

getAttribute

public String getAttribute(String name)

Return the attribute for a given name.

getStringAttr

public String getStringAttr(String name,
                   String defaultValue)

Returns an Attribute as a String.

Will throw a ClassCastException if the attribute is not a String.

setAttribute

public void setAttribute(String name,
                String value)

Set an attribute.

toString

public String toString()

Overrides:

toString in class Object