public interface

GraphBean

implements WebBean
com.microstrategy.web.beans.GraphBean

Class Overview

The GraphBean encapsulates the WebGraph object, which contains the binary graph data.

This bean is obtained from a ViewBean, and like any WebBean its state may be saved and restored. newGraphBean() is only useful when restored to a known state within the context of a report or report writing document. It does not have an event handler.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract void defineDataSource(String messageID, int stateID)
If the state of the GraphBean is not provided, the caller may provide the following properties to define the equivalent data source for the Graph Bean.
abstract void defineDataSource(String messageID, String nodeKey, int sliceID)
If the state of the GraphBean is not provided, the caller may provide the following properties to define the equivalent data source for the Graph Bean.
abstract WebGraph getGraphObject()

Returns the graph object.

[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebBean
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract void defineDataSource (String messageID, int stateID)

If the state of the GraphBean is not provided, the caller may provide the following properties to define the equivalent data source for the Graph Bean. In this case, the source refers to a Report.

Parameters
messageID The message ID of recently executed Report.
stateID The ID of the state.
Throws
WebObjectsException If we are unable to retrieve a Report Instance from the message ID.

public abstract void defineDataSource (String messageID, String nodeKey, int sliceID)

If the state of the GraphBean is not provided, the caller may provide the following properties to define the equivalent data source for the Graph Bean. In this case, the source refers to a Report Writer document.

Parameters
messageID The message ID of recently executed Report Writer document.
nodeKey The key of the template node that refers to the graph to retrieve.
sliceID The ID of the slice.
Throws
WebObjectsException If we are unable to retrieve a Report Writer instance from the message ID.

public abstract WebGraph getGraphObject ()

Returns the graph object.

Returns
  • the associated graph object
Throws
WebBeanException if the graph object cannot be retrieved