Package com.microstrategy.web.beans

Interface GraphBean

All Superinterfaces:

EnumWebPersistableState, Persistable, RequestPersistable, Transformable, WebBean, WebComponent

public interface GraphBean
extends WebBean

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. WebBeanFactory.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.

Since:

MicroStrategy Web 8.0.0

Field Summary

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

Modifier and Type	Method	Description
void	defineDataSource(java.lang.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.
void	defineDataSource(java.lang.String messageID, java.lang.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.
WebGraph	getGraphObject()	Returns the graph object.

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable

restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.beans.Transformable

addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebBean

getDocument, getErrorInfo, getSessionInfo, isStale, setSessionInfo, setStale

Methods inherited from interface com.microstrategy.web.beans.WebComponent

addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

Method Detail

getGraphObject

WebGraph getGraphObject()
                 throws WebBeanException

Returns the graph object.

Returns:

the associated graph object

Throws:

WebBeanException - if the graph object cannot be retrieved

defineDataSource

void defineDataSource(java.lang.String messageID,
                      java.lang.String nodeKey,
                      int sliceID)
               throws WebObjectsException

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.

defineDataSource

void defineDataSource(java.lang.String messageID,
                      int stateID)
               throws WebObjectsException

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.