jet.webreport.util

Class JNode

java.lang.Object

jet.webreport.util.JNode

All Implemented Interfaces:

Serializable

public final class JNode
extends Object
implements Serializable

JNode is a lightweight tree structure.

Author:

dong.hu@china.jinfonet.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATT_PREFIX
static String	HIDE_SURFIX
static String	MAP_SURFIX
static String	NODE_DESC
static String	NODE_ID
static String	NODE_NAME
static String	NODE_PATH
static String	NODE_TYPE
static String	NODE_VALU
static String	TAG_SURFIX
static String	TYPE_ROOT

Constructor Summary

Constructors

Constructor and Description
JNode(String type) Creates a new JNode instance by the specified type.
JNode(String type, String name, String value, String desc) Creates a new JNode instance by the specified type.

Method Summary

Modifier and Type	Method and Description
void	addChild(int index, JNode node) Inserts the specified node at the specified position in this node.
void	addChild(JNode node) Appends the specified node to the end of this node.
void	clear() Removes all of the children nodes from this node.
static JNode	clone(JNode o) Initializes a newly created JNode object so that it represents the same as the argument; in other words, the newly created JNode is a copy of the argument JNode.
String	getAttribute(String name) Returns an attribute of the node with the specified attribute name.
Iterator	getAttributeNames() Returns all attribute names in an Iterator.
JNode	getChild(int index) Returns the child node at the specified position in this node.
JNode	getChild(String name) Returns the child node with the specified node name in this node.
String[]	getChildNames() Returns all children nodes' names in a string array.
Iterator	getChildren() Returns all children JNode in Iterator.
String	getDescription() Gets the description attribute of this node.
String	getID() Returns the id of the node path.
String	getName() Returns the name of the node.
JNode	getParent() Returns the parent node of the node.
String	getPath() Returns the path of the node in the node tree.
static String	getPathID(String path) Returns the path id of the node.
String	getText() Returns the text string attached to the node.
String	getType() Returns the type of the node.
String	getValue() Returns the value attribute of this node.
int	hashCode() Returns a hash code for this node. The hash code is @see getName() String object.
int	indexOfChild(String name) Returns the index of the first occurrence of the specified child node in this node, or -1 if this node does not contain a child node.
boolean	isRoot() Tests whether the node type is "root".
JNode	removeChild(int index) Removes the child node at the specified position in this node.
JNode	removeChild(String name) Removes the child node with the specified node name in this node.
void	setAttribute(String name, String value) Sets an attribute of the node with the specified attribute name.
void	setDescription(String desc) Sets the description attribute of this node.
void	setName(String name) Sets the name attribute of this node with specified name.
void	setPathPrefix(String prefix) Sets the path prefix of the node.
void	setText(String text) Sets the text string attached to the node.
void	setValue(String value) Sets the value attribute of this node with specified value.
int	size() Returns the children size of the node.
static Document	toDocument(JNode jnode, Properties props) Transfers a JNode to a W3C Document.
String	toXML(Properties props) Exports the node to XML string.
static StringBuffer	writeXML(JNode jnode, Properties props) Exports a JNode to XML in a StringBuffer.

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG_SURFIX

public static final transient String TAG_SURFIX

See Also:

Constant Field Values

ATT_PREFIX

public static final transient String ATT_PREFIX

See Also:

Constant Field Values

MAP_SURFIX

public static final transient String MAP_SURFIX

See Also:

Constant Field Values

HIDE_SURFIX

public static final transient String HIDE_SURFIX

See Also:

Constant Field Values

NODE_TYPE

public static final transient String NODE_TYPE

See Also:

Constant Field Values

NODE_NAME

public static final transient String NODE_NAME

See Also:

Constant Field Values

NODE_VALU

public static final transient String NODE_VALU

See Also:

Constant Field Values

NODE_DESC

public static final transient String NODE_DESC

See Also:

Constant Field Values

NODE_PATH

public static final transient String NODE_PATH

See Also:

Constant Field Values

NODE_ID

public static final transient String NODE_ID

See Also:

Constant Field Values

TYPE_ROOT

public static final transient String TYPE_ROOT

See Also:

Constant Field Values

Constructor Detail

JNode

public JNode(String type)

Creates a new JNode instance by the specified type.

Parameters:

type - the node type, which starts with TYPE_, and is defined in JNode, ResourceTreeBuilder, or TOCTreeBuilder, such as

JNode.TYPE_ROOT,

ResourceTreeBuilder.TYPE_DATASOURCE,

TOCTreeBuilder.TYPE_TOCNODE.

JNode

public JNode(String type,
             String name,
             String value,
             String desc)

Creates a new JNode instance by the specified type.

Parameters:

type - the node type, which starts with TYPE_, and is defined in JNode, ResourceTreeBuilder, or TOCTreeBuilder, such as

JNode.TYPE_ROOT,

ResourceTreeBuilder.TYPE_DATASOURCE,

TOCTreeBuilder.TYPE_TOCNODE.

name - the node name.

value - the node value.

desc - the node description.

Method Detail

getParent

public JNode getParent()

Returns the parent node of the node.

Returns:

the parent node.

getAttribute

public String getAttribute(String name)

Returns an attribute of the node with the specified attribute name.

Parameters:

name - the attribute name.

Returns:

the attribute in String.

setAttribute

public void setAttribute(String name,
                         String value)

Sets an attribute of the node with the specified attribute name.

Parameters:

name - the attribute name.

value - the attribute value.

getAttributeNames

public Iterator getAttributeNames()

Returns all attribute names in an Iterator.

Returns:

all attribute names.

getType

public String getType()

Returns the type of the node.

Returns:

the type.

getName

public String getName()

Returns the name of the node.

Returns:

the name.

setName

public void setName(String name)

Sets the name attribute of this node with specified name.

Parameters:

name - the name.

getValue

public String getValue()

Returns the value attribute of this node.

Returns:

the value

setValue

public void setValue(String value)

Sets the value attribute of this node with specified value.

Parameters:

value - the value.

getDescription

public String getDescription()

Gets the description attribute of this node.

Returns:

the description.

setDescription

public void setDescription(String desc)

Sets the description attribute of this node.

Parameters:

desc - the description.

getText

public String getText()

Returns the text string attached to the node.

Returns:

the text.

setText

public void setText(String text)

Sets the text string attached to the node.

Parameters:

text - the text.

getPath

public String getPath()

Returns the path of the node in the node tree.

Returns:

the path.

setPathPrefix

public void setPathPrefix(String prefix)

Sets the path prefix of the node.

Parameters:

prefix - the path prefix.

getID

public String getID()

Returns the id of the node path.

Returns:

the id.

See Also:

getPath(), getPathID(String)

getPathID

public static String getPathID(String path)

Returns the path id of the node.

Parameters:

path - the node path.

Returns:

the path id.

size

public int size()

Returns the children size of the node.

Returns:

the children size.

getChildren

public Iterator getChildren()

Returns all children JNode in Iterator.

Returns:

all children

addChild

public void addChild(JNode node)

Appends the specified node to the end of this node.

Parameters:

node - the node to be appended to this node.

addChild

public void addChild(int index,
                     JNode node)

Inserts the specified node at the specified position in this node. Shifts the node currently at that position (if any) and any subsequent node to the right (adds one to their indices).

Parameters:

index - index at which the specified node is to be inserted.

node - the node to be inserted.

getChild

public JNode getChild(int index)

Returns the child node at the specified position in this node.

Parameters:

index - index of the child node to return.

Returns:

JNode the child node at the specified position in this node.

getChild

public JNode getChild(String name)

Returns the child node with the specified node name in this node.

Parameters:

name - the specified node name.

Returns:

JNode the child node at the specified position in this nod.

removeChild

public JNode removeChild(int index)

Removes the child node at the specified position in this node. Shifts any subsequent nodes to the left (subtracts one from their indices). Returns the child node that was removed from the node.

Parameters:

index - the index of the child node to be removed.

Returns:

the child node previously at the specified position.

removeChild

public JNode removeChild(String name)

Removes the child node with the specified node name in this node.

Parameters:

name - the specified node name.

Returns:

the child node previously at the specified position.

indexOfChild

public int indexOfChild(String name)

Returns the index of the first occurrence of the specified child node in this node, or -1 if this node does not contain a child node.

Parameters:

name - the specified node name to search for.

Returns:

the index of the first occurrence of the specified child node in this node, or -1 if this node does not contain a child node.

getChildNames

public String[] getChildNames()

Returns all children nodes' names in a string array.

Returns:

the names of all children nodes.

isRoot

public boolean isRoot()

Tests whether the node type is "root".

Returns:

true if the node is root, otherwise false.

clear

public void clear()

Removes all of the children nodes from this node. And clears the attributes of this node.

hashCode

public int hashCode()

Returns a hash code for this node.
The hash code is @see getName() String object.

Overrides:

hashCode in class Object

Returns:

a hash code value for this node.

clone

public static JNode clone(JNode o)

Initializes a newly created JNode object so that it represents the same as the argument; in other words, the newly created JNode is a copy of the argument JNode.

Parameters:

o - a JNode.

toXML

public String toXML(Properties props)

Exports the node to XML string.

Parameters:

props - some output control parameters, for example,

"xml.encoding" for writing the Document to a file, if the default value is not "UTF-8".
"xml.indent" is used to control whether to indent according to the nodes hierarchy when output, if the default value is not "false".

Returns:

the node to XML string.

writeXML

public static StringBuffer writeXML(JNode jnode,
                                    Properties props)

Exports a JNode to XML in a StringBuffer.

Parameters:

jnode - The JNode object.

props - some output control parameters, @see #toXML(Properties).

Returns:

the node to XML StringBuffer.

toDocument

public static Document toDocument(JNode jnode,
                                  Properties props)

Transfers a JNode to a W3C Document.

Parameters:

jnode - The JNode object.

props - some output control parameters, @see #toXML(Properties).

Returns:

the node to Document.