public interface

ReportDataTransform

implements Transform
com.microstrategy.web.app.transforms.ReportDataTransform
Known Indirect Subclasses

This interface is deprecated.
This interface has been deprecated and will be removed in future versions of the product.
It's main purpose was to provide the guidelines of the methods required by a data Transform in order to control its layout. With the introduction of layout-xml this is not necessary anymore.

Class Overview

The Transform interface is the base interface that is used for all report data related transforms.

Summary

Public Methods
abstract HashMap getTransformContext()
get the context object associated with the transform.
abstract void renderBottom(MarkupOutput out, ReportBean rb)
Render bottom area of the transform.
abstract void renderCenter(MarkupOutput out, ReportBean rb)
Render center area of the transform.
abstract void renderContent(MarkupOutput out, ReportBean rb)
Render content of the transform.
abstract void renderData(MarkupOutput out, ReportBean rb)
Render the report data area.
abstract void renderEmptyCase(MarkupOutput out, ReportBean rb)
Render when the report grid/graph is empty.
abstract void renderLayout(MarkupOutput out, ReportBean rb)
Render the layout for the report grid.
abstract void renderLeft(MarkupOutput out, ReportBean rb)
Render left area of the transform.
abstract void renderRight(MarkupOutput out, ReportBean rb)
Render right area of the transform.
abstract void renderTop(MarkupOutput out, ReportBean rb)
Render top area of the transform.
[Expand]
Inherited Methods
From interface com.microstrategy.web.transform.Transform

Public Methods

public abstract HashMap getTransformContext ()

get the context object associated with the transform.

Returns
  • the transform context object

public abstract void renderBottom (MarkupOutput out, ReportBean rb)

Render bottom area of the transform.

Parameters
out output by this transform
rb this report bean

public abstract void renderCenter (MarkupOutput out, ReportBean rb)

Render center area of the transform.

Parameters
out output by this transform
rb this report bean

public abstract void renderContent (MarkupOutput out, ReportBean rb)

Render content of the transform. It's only used when the report bean is in Successful status.
We divide the whole content into 5 areas: TOP/LEFT/CENTER/RIGHT/BOTTOM.
+-------------------------------+
| TOP |
+-------------------------------+
| | | |
| LEFT | |RIGHT |
| | CENTER | |
| | | |
| | | |
+-------------------------------+
| BOTTOM |
+-------------------------------+

Parameters
out output by this transform
rb this report bean

public abstract void renderData (MarkupOutput out, ReportBean rb)

Render the report data area.
The CENTER area of the transform has layout on top and data on bottom.

Parameters
out output by this transform
rb this report bean

public abstract void renderEmptyCase (MarkupOutput out, ReportBean rb)

Render when the report grid/graph is empty.
Usually some information message is displayed.

Parameters
out output by this transform
rb this report bean

public abstract void renderLayout (MarkupOutput out, ReportBean rb)

Render the layout for the report grid.
The CENTER area of the transform has layout on top and data on bottom.

Parameters
out output by this transform
rb this report bean

public abstract void renderLeft (MarkupOutput out, ReportBean rb)

Render left area of the transform.

Parameters
out output by this transform
rb this report bean

public abstract void renderRight (MarkupOutput out, ReportBean rb)

Render right area of the transform.

Parameters
out output by this transform
rb this report bean

public abstract void renderTop (MarkupOutput out, ReportBean rb)

Render top area of the transform.

Parameters
out output by this transform
rb this report bean