dochelper.ResultNode Class Reference

The ResultNode class holds the result of the execution of DocHelper. More...

Collaboration diagram for dochelper.ResultNode:

[legend]

List of all members.

Public Member Functions
	ResultNode (String value, HashMap params, String name)
	Creates a new instance of ResultNode.
void	addChild (ResultNode node)
	Add a child to this node.
List< ResultNode >	getChildren ()
	Return the list of children if any in this node.
String	getValue ()
	Return the value of the node if any.
HashMap	getParams ()
	Retrieve the params from the node.
ResultNode	find (String nodeName)
	Retrieve the ResultNode which _name equals to nodeName.
boolean	hasLeaf ()
	Retrieve a boolean that indicates whether this node has leafs as children.
boolean	isLeaf ()
	Retrieve a boolean that indicates whether this node is a Leaf.
String	toString ()
Public Attributes
String	_name
	Node name.
Private Attributes
HashMap	_params
	Parameters available to node.
ArrayList< ResultNode >	_children
	Node Children.
String	_value
	Node value.

---

Detailed Description

The ResultNode class holds the result of the execution of DocHelper.

A tree structure is made with the match results for a document definition execution. The tree structure is then passed to a Rendered For Output Creation. The tree may be modified by Processors before beign passed for Rendering.

Author:

gchristen

Definition at line 26 of file ResultNode.java.

---

Constructor & Destructor Documentation

dochelper.ResultNode.ResultNode	(	String	value,
		HashMap	params,
		String	name
	)

Creates a new instance of ResultNode.

Parameters:

	value
	params
	name

Definition at line 53 of file ResultNode.java.

---

Member Function Documentation

void dochelper.ResultNode.addChild

(

ResultNode

node

)

Add a child to this node.

Parameters:

node

ResultNode child to add.

Definition at line 65 of file ResultNode.java.

Here is the caller graph for this function:

List<ResultNode> dochelper.ResultNode.getChildren

(

)

Return the list of children if any in this node.

Returns:

List of children.

Definition at line 79 of file ResultNode.java.

Here is the caller graph for this function:

String dochelper.ResultNode.getValue

(

)

Return the value of the node if any.

Returns:

Node Value : A transformed match

Definition at line 89 of file ResultNode.java.

Here is the caller graph for this function:

HashMap dochelper.ResultNode.getParams

(

)

Retrieve the params from the node.

Returns:

params Paramters set for this node. For use during rendering.

Definition at line 99 of file ResultNode.java.

Here is the caller graph for this function:

ResultNode dochelper.ResultNode.find

(

String

nodeName

)

Retrieve the ResultNode which _name equals to nodeName.

Returns:

nodeName Name of the node to be looked for.

Definition at line 110 of file ResultNode.java.

Here is the call graph for this function:

Here is the caller graph for this function:

boolean dochelper.ResultNode.hasLeaf

(

)

Retrieve a boolean that indicates whether this node has leafs as children.

This method will return true if at least one of the children of this node is a leaf.

Returns:

boolean Indicates node has leafs.

Definition at line 144 of file ResultNode.java.

Here is the call graph for this function:

boolean dochelper.ResultNode.isLeaf

(

)

Retrieve a boolean that indicates whether this node is a Leaf.

Returns:

boolean Indicates node is a leaf

Definition at line 167 of file ResultNode.java.

Here is the call graph for this function:

Here is the caller graph for this function:

String dochelper.ResultNode.toString

(

)

Definition at line 172 of file ResultNode.java.

---

Member Data Documentation

HashMap dochelper.ResultNode._params [private]

Parameters available to node.

Definition at line 31 of file ResultNode.java.

ArrayList<ResultNode> dochelper.ResultNode._children [private]

Node Children.

Definition at line 36 of file ResultNode.java.

String dochelper.ResultNode._value [private]

Node value.

TODO: Default to String?

Definition at line 41 of file ResultNode.java.

String dochelper.ResultNode._name

Node name.

Definition at line 46 of file ResultNode.java.

---

The documentation for this class was generated from the following file:

• src/dochelper/ResultNode.java