com.plumtree.portaluiinfrastructure.tree.sitemap
Class SiteMapTreeIterator

java.lang.Object
  com.plumtree.portaluiinfrastructure.tree.sitemap.SiteMapTreeIterator

public class SiteMapTreeIterator
extends java.lang.Object

This class allows you to iterate through a Site Map Folder hierarchy.

Author:

Bridget Frey

Field Summary

protected boolean	m_bInitialized Has the class been initialized.
protected int	m_nStyle Only 0 is recognized.
protected IPTSiteMapFolder	m_objFolder Current folder; can be NULL if we move to a folder that is inaccessible.
protected IPTObjectManager	m_objOM Site Map Folder object manager
protected IPTSiteMapFolder	m_objRoot Root of the iteration.
protected IPTSession	m_objSession User's session.

Constructor Summary

SiteMapTreeIterator()
Constructor for SiteMapTreeIterator.

Method Summary

java.lang.Object[][]	Children(int arg0, int arg1)
java.lang.Object[][]	CurrentLocInfo()
boolean	GetAtRoot()
int	GetChildCount()
java.lang.String	GetLocation()
int	GetStyle()
void	InitializeIterator(java.lang.Object arg0)
void	MoveTo(java.lang.String arg0)
void	MoveToParent()
void	MoveToRoot()
static void	printTree(IPTTreeIterator ptTreeIterator, java.lang.String strIndent) Test function.
void	RealInitializeIterator(int nSiteMapFolderID, IPTSession objSession) Use this function to initialize the Iterator.
void	SetStyle(int nStyle)

Methods inherited from class java.lang.Object

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

Field Detail

m_objOM

protected IPTObjectManager m_objOM

Site Map Folder object manager

m_objSession

protected IPTSession m_objSession

User's session.

m_objFolder

protected IPTSiteMapFolder m_objFolder

Current folder; can be NULL if we move to a folder that is inaccessible.

m_objRoot

protected IPTSiteMapFolder m_objRoot

Root of the iteration.

m_bInitialized

protected boolean m_bInitialized

Has the class been initialized.

m_nStyle

protected int m_nStyle

Only 0 is recognized.

Constructor Detail

SiteMapTreeIterator

public SiteMapTreeIterator()

Constructor for SiteMapTreeIterator.

Method Detail

Children

public java.lang.Object[][] Children(int arg0,
                                     int arg1)

See Also:

com.plumtree.server.treeiterator.IPTTreeIterator#Children(int, int)

CurrentLocInfo

public java.lang.Object[][] CurrentLocInfo()

See Also:

com.plumtree.server.treeiterator.IPTTreeIterator#CurrentLocInfo()

GetAtRoot

public boolean GetAtRoot()

See Also:

com.plumtree.server.treeiterator.IPTTreeIterator#GetAtRoot()

GetChildCount

public int GetChildCount()

See Also:

com.plumtree.server.treeiterator.IPTTreeIterator#GetChildCount()

GetLocation

public java.lang.String GetLocation()

See Also:

com.plumtree.server.treeiterator.IPTTreeIterator#GetLocation()

GetStyle

public int GetStyle()

See Also:

com.plumtree.server.treeiterator.IPTTreeIterator#GetStyle()

InitializeIterator

public void InitializeIterator(java.lang.Object arg0)

See Also:

com.plumtree.server.treeiterator.IPTTreeIterator#InitializeIterator(java.lang.Object)

MoveTo

public void MoveTo(java.lang.String arg0)

See Also:

com.plumtree.server.treeiterator.IPTTreeIterator#MoveTo(java.lang.String)

MoveToParent

public void MoveToParent()

See Also:

com.plumtree.server.treeiterator.IPTTreeIterator#MoveToParent()

MoveToRoot

public void MoveToRoot()

See Also:

com.plumtree.server.treeiterator.IPTTreeIterator#MoveToRoot()

RealInitializeIterator

public void RealInitializeIterator(int nSiteMapFolderID,
                                   IPTSession objSession)

Use this function to initialize the Iterator. Do not use InitializeIterator, which is on IPTTreeIterator, but does not meet the needs of this class.

Parameters:

nSiteMapFolderID: - ID of SiteMapFolder to iterate.

objSession: - User's session.

SetStyle

public void SetStyle(int nStyle)

See Also:

com.plumtree.server.treeiterator.IPTTreeIterator#SetStyle(int)

printTree

public static void printTree(IPTTreeIterator ptTreeIterator,
                             java.lang.String strIndent)

Test function.

Parameters:

ptTreeIterator: - IPTTreeIterator to iterate.

strIndent: - This function is called recursively, and adds spaces to strIndent for every level of recursion. Pass in "" for the first call to the function.