Package com.microstrategy.web.beans

Interface RWBeanVisitor

All Known Subinterfaces:

RWBeanVisitor2

All Known Implementing Classes:

AbstractRWBeanVisitor, AbstractRWBeanVisitor2, AbstractRWDataVisualizationTransform, AbstractSimplifiedRWXMLTransform, MobileChunkedRWTransform, MojoIVETransform.IVELayoutContext, MojoIVETransform.IVELayoutContextDefn, MojoRWDTransform.RWLayoutContext, MojoRWDTransform.RWLayoutContextDefn, RWFlashTransform, RWLayoutTransform, RWSectionsVisitor, RWXMLTransform

public interface RWBeanVisitor

Provides a callback mechanism (invoked via RWBean.iterate(RWBeanVisitor, boolean, MarkupOutput)) to ease the handling of complex RWObject, by automatically mapping them to their respective WebBean helpers. This interface also includes MarkupOutput as a callback parameter - this is the same instance specified in the RWBean#iterate method.

This interface should be used in lieu of RWVisitor if the more specific onObject callbacks prove useful.

Since:

MicroStrategy Web 8.0.0

Method Summary

Modifier and Type	Method	Description
void	onEndSection(RWSection section, MarkupOutput mo)
void	onObject(RWBean rwBean, RWObject ob, MarkupOutput mo)	Specific case where RWObject#getDefinition().getType == EnumRWUnitTypes.RWUNIT_SUBREPORT.
void	onObject(ViewBean viewBean, RWObject ob, MarkupOutput mo)	Specific case where RWObject#getDefinition().getType == EnumRWUnitTypes.RWUNIT_GRIDGRAPH The corresponding data value is encapsulated in a ViewBean for ease of use.
void	onObject(RWObject ob, MarkupOutput mo)	This is invoked as a fallback if the more specific onObject declarations are not matched.
void	onStartSection(RWSection section, MarkupOutput mo)

Method Detail

onStartSection

void onStartSection(RWSection section,
                    MarkupOutput mo)

Parameters:

section - the report writing document section.

mo - the markup output.

See Also:

RWVisitor.onStartSection(RWSection)

onEndSection

void onEndSection(RWSection section,
                  MarkupOutput mo)

Parameters:

section - the report writing document section.

mo - the markup output.

See Also:

RWVisitor.onEndSection(RWSection)

onObject

void onObject(RWObject ob,
              MarkupOutput mo)

This is invoked as a fallback if the more specific onObject declarations are not matched.

Parameters:

ob - the report writing document object.

mo - the markup output.

See Also:

RWVisitor.onObject(RWObject)

onObject

void onObject(RWBean rwBean,
              RWObject ob,
              MarkupOutput mo)

Specific case where RWObject#getDefinition().getType == EnumRWUnitTypes.RWUNIT_SUBREPORT. The corresponding data value is encapsulated in a RWBean for ease of use.

Parameters:

rwBean - an embedded bean.

ob - the report writing document object.

mo - the markup output.

See Also:

RWVisitor.onObject(RWObject)

onObject

void onObject(ViewBean viewBean,
              RWObject ob,
              MarkupOutput mo)

Specific case where RWObject#getDefinition().getType == EnumRWUnitTypes.RWUNIT_GRIDGRAPH The corresponding data value is encapsulated in a ViewBean for ease of use.

Parameters:

viewBean - an embedded bean.

ob - the report writing document object.

mo - the markup output.

See Also:

RWVisitor.onObject(RWObject)