com.businessobjects.dsws.reportengine
Interface NavigationNode

public interface NavigationNode

The NavigationNode interface exposes the document structure.
The NavigationMap of the entire document is a tree of NavigationNode. The root level contains the reports, all lower levels are associated to sections and sub sections. This model is exposed as a tree.

Example:Retrieve the NavigationNode

 RetrieveNavigationMap objRetrieveNavigationMap = RetrieveNavigationMap.Factory.newInstance();
 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 retBOData.setRetrieveNavigationMap(objRetrieveNavigationMap);
 DocumentInformation boDocInfo = boRepEng.getDocumentInformation( strDocid, null, null, null, retBOData);
 NavigationNode[] objNavigationNodes = boDocInfo.getNavigationMapArray();
 for(int i=0;i<objNavigationNodes.length;i++)
 {
    NavigationNode objNavigationNode = objNavigationNodes[i];
    String strName=objNavigationNode.getName();
    out.print(strName);
 }
 

See Also:

com.businessobjects.dsws.reportengine.DocumentInformation#getNavigationMap(), Navigate, NavigateToDataProvider, NavigateToFirstPage, NavigateToLastPage, NavigateToPage, NavigateToPath, NavigationNode, ReportEngine, BinaryView, XMLView, ViewSupport, ViewModeType, RetrieveData, RetrieveView, OutputFormatType, DocumentInformation

Nested Class Summary

static class

NavigationNode.Factory A class with methods for creating instances of the NavigationNode type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

NavigationNode	addNewChildren() Internal Use Only.
NavigationNode[]	getChildrenArray() Returns the child NavigationNode tree of the current node.
NavigationNode	getChildrenArray(int i) Returns a specific child NavigationNode.
java.lang.String	getClientPath() Returns the client path of the current node represented as an HTML Anchor.
java.lang.String	getDescription() Returns a description of the current node.
boolean	getLeaf() Returns true if the current node has no child nodes.
int	getLevel() Returns the level of the current node in the navigation tree.
java.lang.String	getName() Returns the name of the current node.
java.lang.String	getPath() Returns the path of the current node.
NavigationNode	insertNewChildren(int i) Internal Use Only.
boolean	isNilChildrenArray(int i) Checks if the Children element is nil at the specified index position.
boolean	isNilDescription() Checks if the Description element is nil.
boolean	isSetClientPath() Checks if the ClientPath attribute is set.
boolean	isSetDescription() Checks if the Description element is set.
boolean	isSetPath() Checks if the Path attribute is set.
void	removeChildren(int i) Internal Use Only.
void	setChildrenArray(int i, NavigationNode children) Internal Use Only.
void	setChildrenArray(NavigationNode[] childrenArray) Internal Use Only.
void	setClientPath(java.lang.String clientPath) p>Internal Use Only.
void	setDescription(java.lang.String description) Internal Use Only.
void	setLeaf(boolean leaf) Internal Use Only.
void	setLevel(int level) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
void	setNilChildrenArray(int i) Internal Use Only.
void	setNilDescription() Internal Use Only.
void	setPath(java.lang.String path) Sets the path of the navigation node.
int	sizeOfChildrenArray() Returns the size of the Children array.
void	unsetClientPath() Internal Use Only.
void	unsetDescription() Internal Use Only.
void	unsetPath() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetClientPath() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDescription() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetLeaf() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetLevel() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetPath() Internal Use Only.
void	xsetClientPath(org.apache.xmlbeans.XmlString clientPath) Internal Use Only.
void	xsetDescription(org.apache.xmlbeans.XmlString description) Internal Use Only.
void	xsetLeaf(org.apache.xmlbeans.XmlBoolean leaf) Internal Use Only.
void	xsetLevel(org.apache.xmlbeans.XmlInt level) Internal Use Only.
void	xsetName(org.apache.xmlbeans.XmlString name) Internal Use Only.
void	xsetPath(org.apache.xmlbeans.XmlString path) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getChildrenArray

NavigationNode[] getChildrenArray()

Returns the child NavigationNode tree of the current node.

Returns:

an array of NavigationNode.

getChildrenArray

NavigationNode getChildrenArray(int i)

Returns a specific child NavigationNode.

Parameters:

i - The index of the NavigationNode to be retrieved.

Returns:

a specific child NavigationNode

isNilChildrenArray

boolean isNilChildrenArray(int i)

Checks if the Children element is nil at the specified index position.

Parameters:

i - the index of the Children element

Returns:

true if the Children element is nil, otherwise false

sizeOfChildrenArray

int sizeOfChildrenArray()

Returns the size of the Children array.

Returns:

the size of the Children array.

setChildrenArray

void setChildrenArray(NavigationNode[] childrenArray)

Internal Use Only.

setChildrenArray

void setChildrenArray(int i,
                      NavigationNode children)

Internal Use Only.

setNilChildrenArray

void setNilChildrenArray(int i)

Internal Use Only.

insertNewChildren

NavigationNode insertNewChildren(int i)

Internal Use Only.

addNewChildren

NavigationNode addNewChildren()

Internal Use Only.

removeChildren

void removeChildren(int i)

Internal Use Only.

getDescription

java.lang.String getDescription()

Returns a description of the current node.

Returns:

a description of the current node

xgetDescription

org.apache.xmlbeans.XmlString xgetDescription()

Internal Use Only.

isNilDescription

boolean isNilDescription()

Checks if the Description element is nil.

Returns:

true if the Description element is nil, otherwise false

isSetDescription

boolean isSetDescription()

Checks if the Description element is set.

Returns:

true if the Description element is set, otherwise false

setDescription

void setDescription(java.lang.String description)

Internal Use Only.

xsetDescription

void xsetDescription(org.apache.xmlbeans.XmlString description)

Internal Use Only.

setNilDescription

void setNilDescription()

Internal Use Only.

unsetDescription

void unsetDescription()

Internal Use Only.

getName

java.lang.String getName()

Returns the name of the current node.

Returns:

the name of the current node.

xgetName

org.apache.xmlbeans.XmlString xgetName()

Internal Use Only.

setName

void setName(java.lang.String name)

Internal Use Only.

xsetName

void xsetName(org.apache.xmlbeans.XmlString name)

Internal Use Only.

getPath

java.lang.String getPath()

Returns the path of the current node.

Returns:

the path of the current node.

xgetPath

org.apache.xmlbeans.XmlString xgetPath()

Internal Use Only.

isSetPath

boolean isSetPath()

Checks if the Path attribute is set.

Returns:

true if the Path element is set, otherwise false

setPath

void setPath(java.lang.String path)

Sets the path of the navigation node.

Parameters:

path - the Path attribute

xsetPath

void xsetPath(org.apache.xmlbeans.XmlString path)

Internal Use Only.

unsetPath

void unsetPath()

Internal Use Only.

getClientPath

java.lang.String getClientPath()

Returns the client path of the current node represented as an HTML Anchor.

Returns:

the client path of the current node

xgetClientPath

org.apache.xmlbeans.XmlString xgetClientPath()

Internal Use Only.

isSetClientPath

boolean isSetClientPath()

Checks if the ClientPath attribute is set.

Returns:

true if the ClientPath element is nil, otherwise false

setClientPath

void setClientPath(java.lang.String clientPath)

p>Internal Use Only.

xsetClientPath

void xsetClientPath(org.apache.xmlbeans.XmlString clientPath)

Internal Use Only.

unsetClientPath

void unsetClientPath()

Internal Use Only.

getLevel

int getLevel()

Returns the level of the current node in the navigation tree.

Returns:

the level of the current node.

xgetLevel

org.apache.xmlbeans.XmlInt xgetLevel()

Internal Use Only.

setLevel

void setLevel(int level)

Internal Use Only.

xsetLevel

void xsetLevel(org.apache.xmlbeans.XmlInt level)

Internal Use Only.

getLeaf

boolean getLeaf()

Returns true if the current node has no child nodes.

Returns:

true if the current node has no child nodes.

xgetLeaf

org.apache.xmlbeans.XmlBoolean xgetLeaf()

Internal Use Only.

setLeaf

void setLeaf(boolean leaf)

Internal Use Only.

xsetLeaf

void xsetLeaf(org.apache.xmlbeans.XmlBoolean leaf)

Internal Use Only.