Package com.dassault_systemes.PPRNBbase.interfaces

   
Interface GraphWalkerIF

 
Class Hierarchy
com.dassault_systemes.PPRNBbase.interfaces.GraphWalkerIF
Class Location

Framework : PPRJNavigatorBase

Module : PPRNBbase

Class Description

public interface GraphWalkerIF

Interface defined to : - provide a unified API for external data source - enable browsing through datas organized as a graph

Field Summary

Constructor Summary

Method Summary
GraphNodeIF getRoot(CATSession session, PortalUID rootUID)
int expandCount(CATSession session, PortalUID startNodeId, int numberOflevels)
GraphNodeIF[] expand(CATSession session, PortalUID startNodeId, int numberOflevels)


Field Detail

Constructor Detail

Method Detail

getRoot

    GraphNodeIF getRoot(CATSession session, PortalUID rootUID)

Returns the node identified by the rootUID argument

Parameters:
session
- the current Jdialog session object
rootUID
- the node UID from which the browsing will start
Returns:
GraphNodeIF - the returned node
See Also:
com.dassault_systemes.catjsystem.CATSession
com.dassault_systemes.PPRNBbase.uid.PortalUID
com.dassault_systemes.PPRNBbase.interfaces.GraphNodeIF

expandCount

    int expandCount(CATSession session, PortalUID startNodeId, int numberOflevels)

Returns the number of nodes returned by calling expand

Parameters:
session
- the current Jdialog session object
startNodeId
- the UID of the expanded node
Returns:
int - the node count
See Also:
com.dassault_systemes.catjsystem.CATSession
com.dassault_systemes.PPRNBbase.uid.PortalUID

expand

    GraphNodeIF[] expand(CATSession session, PortalUID startNodeId, int numberOflevels)

Returns a list of children nodes

Parameters:
session
- the current Jdialog session object
startNodeId
- the UID of the expanded node
int
numberOflevels - number of levels to be expanded
Returns:
GraphNodeIF[] - the list of children nodes
See Also:
com.dassault_systemes.catjsystem.CATSession
com.dassault_systemes.PPRNBbase.uid.PortalUID
com.dassault_systemes.PPRNBbase.interfaces.GraphNodeIF


Copyright © 2000, Dassault Systèmes. All rights reserved