com.businessobjects.rebean.wi
Interface ReportMapNode

All Superinterfaces:

TreeNode

public interface ReportMapNode
extends TreeNode

The ReportMapNode interface exposes a node in the ReportMap tree. A node can be a Report or a ection.

The first level of the ReportMap always contains Report objects.

Method Summary

java.lang.String	getDescription() Returns a description of the item.
java.lang.String	getHTMLAnchorName() Returns the HTML Anchor name of this node
java.lang.String	getName() Returns the name of this item.
java.lang.String	getPath() Returns the current position within a report.
Report	getReport() Returns the report associated to this reportMapNode.
java.lang.String	getType() Returns the current item type.

Methods inherited from interface com.businessobjects.rebean.wi.TreeNode

getChildAt, getChildCount, getIndex, getParent, isLeaf

Method Detail

getName

java.lang.String getName()

Returns the name of this item.

Returns:

The name of the item.

getDescription

java.lang.String getDescription()

Returns a description of the item.

Returns:

The description of the item

getPath

java.lang.String getPath()

Returns the current position within a report. A path is an unique identifier set using DocumentInstance.setPath, which points to a specific document location.

If a report's path is set, the document is opened to the page containing the section specified in the path.

The path completely independent of pagination.

A path is a concatenation of report index a slash followed by section indexes separated by semicolons.

Example: 0/0;0 means 1st report, 1st section, 1st sub section

Example: The paths in a document containing two reports, each report contains sections.

Report Name	Section Name			Path
Report1				0
	USA			0/0
		NY		0/0;0
			Morgan S	0/0;0;0
			Bank of NY	0/0;0;1
		SJ		0/0;1
			Bank of CA	0/0;1;0
	FR			0/1
		Levallois		0/1;0
		Paris		0/1;1
Report2				1
	Jan			1/0
	Feb			1/1
		week2		1/1;0

Returns:

The path of the item.

See Also:

DocumentInstance.setPath(java.lang.String)

getType

java.lang.String getType()

Returns the current item type. The item can be of the following types:

• Report
• Section

Returns:

The type of the item.

getReport

Report getReport()
                 throws REException

Returns the report associated to this reportMapNode. This method is equivalent to the code below :
String path = reportMapNode.getPath();
Report report = doc.setPath(path);

Returns:

The Report associated to this ReportMapNode

Throws:

REException

getHTMLAnchorName

java.lang.String getHTMLAnchorName()

Returns the HTML Anchor name of this node

Returns:

the HTML Anchor name