public abstract class

AbstractReportDataTransform

extends AbstractReportTransform
implements ReportDataTransform LayoutTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractWebBeanTransform
           ↳ com.microstrategy.web.app.transforms.AbstractReportTransform
             ↳ com.microstrategy.web.app.transforms.AbstractReportDataTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This is the base class for those Report Transforms that generate some sort of representation of the report's data, either as grid, as a graph or as a grid-graph. It provides a place holder for common methods and formal parameters. In particular, the report's incremental fetch functionality links are generated in this class by the following methods:

  • renderRowsIncrementalFetch
  • renderColumnIncrementalFetchNext
  • renderColumnIncrementalFetchPrevious

This class implements ReportDataTransform, in previous versions of the product this was used to indicate how the general layout of the Transform would be generated. This usage has been deprecated, though. Now this class implements LayoutTransform which enables building the layout through an external xml configuration file. Old methods of the ReportDataTransform like:

  • renderTop
  • renderBottom
  • renderLeft
  • renderRight
  • renderCenter
have been deprecated and are called only if a layout-xml is not specified.
Incremental fetch methods can be called through the layout-xml.

Summary

Constants
String BLANK_SUBSET_REPORT_ID
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected String _blankImage This field is deprecated. This is not used anymore. You can use _imgBlank as the source for a transparent image.
protected String _cssBottom This field is deprecated. css formatting is now applied through the layout-xml.
protected String _cssCenter This field is deprecated. css formatting is now applied through the layout-xml.
protected String _cssLeft This field is deprecated. css formatting is now applied through the layout-xml.
protected String _cssRight This is the css name for the right area.
protected String _cssTop This field is deprecated. css formatting is now applied through the layout-xml.
protected String _ifLeftArrowImage This field is deprecated. This instance variable should have been private.
protected String _ifRightArrowImage This field is deprecated. This instance variable should have been private.
protected FormalParameter advancedDrillingContextMenuDisplay It is used in the transform to specify whether to show the advanced drilling options in the editor or context menu.
protected FormalParameter cssBottom This field is deprecated. css formatting is now applied through the layout-xml.
protected FormalParameter cssCenter This field is deprecated. css formatting is now applied through the layout-xml.
protected FormalParameter cssLeft This field is deprecated. css formatting is now applied through the layout-xml.
protected FormalParameter cssRight This field is deprecated. css formatting is now applied through the layout-xml.
protected FormalParameter cssTop This field is deprecated. css formatting is now applied through the layout-xml.
protected FormalParameter customJavaScriptFeatures name for the formal parameter "customJavaScriptFeatures".
protected FormalParameter drillRetainThresholds This is the FP which tells whether to retain the thresholds while drilling.
protected FormalParameter drillWithinBehavior It is used in the transform to specify the drill within behavior.
protected FormalParameter gridGraphUnitKeyContext This formal parameter indicates the unique Id of the RWGridGraphControl.
protected FormalParameter groupContextMenuDrillPathsByType Determines whether drill types (up, down, across and to template) will be displayed as read from the backend in which case the drill types may be intermingled or that we will buck the types together and show the types grouped together.
protected boolean hasIncreFetchForColumnOnLeft This field is deprecated. This variable it's not used anymore.
protected boolean hasIncreFetchForColumnOnRight This field is deprecated. This variable it's not used anymore.
protected FormalParameter id It is used to identify the outer shell for all report modes - grid, graph and gridgraph.
protected FormalParameter ifLeftArrowImage This is the name of the left arrow image to be used in this transform for incremental fetch.
protected FormalParameter ifRightArrowImage This is the name of the right arrow image to be used in this transform for incremental fetch.
protected FormalParameter incrementalFetchStyleForRow This is the name of the style used to show the incremental fetch for row.
protected FormalParameter quickSwitch This formal parameter indicates if the grid is going to have the Quick Switch functionality (client side view mode change enabler) enabled.
protected FormalParameter quickSwitchCurrent This formal parameter indicates if the grid is going to have the Quick Switch functionality and if it's the current view mode displayed.
protected FormalParameter rwbViewerID This Formal Parameter is used to indicate the bone ID for the RWB viewer.
protected FormalParameter showDrillPathSetNamesSubMenuAtTopLevel It is used in the transform to specify whether to show the set names submenu for drilling at the top level (or at a lower depth).
protected FormalParameter showIncreFetchForColumn This field is deprecated. To show/hide the incremental fetch section you should modify the corresponding xml-layout definition of the transform.
protected FormalParameter showIncreFetchForRowOnBottom This field is deprecated. To show/hide the incremental fetch section you should modify the corresponding xml-layout definition of the transform.
protected FormalParameter showIncreFetchForRowOnTop This field is deprecated. To show/hide the incremental fetch section you should modify the corresponding xml-layout definition of the transform.
protected FormalParameter showSubtitlePara Controls whether subtitles (attribute forms) are to be displayed for this grid.
protected FormalParameter sortSetNamesAndDrillPaths It is used in the transform to specify whether to show the set names and drill paths names alphabetically sorted.
protected HashMap transformContext This field is deprecated. This instance variable should have been private. You may use getTransformContext() to access it.
protected FormalParameter uniqueReportId This is the name of the HTML DIV for the report.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractReportDataTransform()
Class constructor.
Public Methods
Map getAttributesShellDiv()
Returns a Map with the list of attributes that the shell div must use.
int getDisplayMode(WebDrillPath dp)
Returns the display mode when drilling via the given drill path
String getID()
Returns the unique name of the component to be used as the ID for its shell.
HashMap getTransformContext()
Get the context object associated with the transform.
boolean hasBottom()
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
abstract boolean hasCenter()
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
boolean hasLeft()
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
boolean hasRight()
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
boolean hasTop()
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
void initializeCss()
Initialize the css classes to be used by this transform.
void initializeImages()
initialize the images for the transform.
void initializeProperties()
Extends initializeProperties by invoking initializeTranformContext
void initializeTranformContext()
Initialize the transform context object.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void initializeWebComponent(Transformable data)
This method initialize WebComponent being transformed.
boolean isGridEmpty()
Returns true if the grid contains no data.
boolean isRWBean()
void renderBottom(MarkupOutput out, ReportBean rb)
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
void renderContent(MarkupOutput out, ReportBean rb)
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
void renderIncreFetchOnColumnLeftPart(MarkupOutput out, ReportBean rb)
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use/extend the renderColumnsIncrementalFetchPrevious method.
void renderIncreFetchOnColumnRightPart(MarkupOutput out, ReportBean rb)
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use/extend the renderColumnsIncrementalFetchNext method.
void renderIncreFetchOnRow(MarkupOutput out, ReportBean rb)
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use/extend the renderRowsIncrementalFetch method.
void renderLeft(MarkupOutput out, ReportBean rb)
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
void renderRight(MarkupOutput out, ReportBean rb)
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
void renderRowsIncrementalFetch(MarkupOutput out)
Generates the rows incremental fetch portion.
void renderTop(MarkupOutput out, ReportBean rb)
This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
boolean supports(Transformable data)
Extends support by supporting more than one type of Transformable.
boolean supports(Class c)
Extends support by supporting more than one Class.
void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful".
Protected Methods
void createBlockEditorProperties()
This method is deprecated. use createBlockEditorProperties(JsonGenerator)
void createBlockEditorProperties(JsonGenerator boneProps)
This method adds all of the grid/graph Report Services properties to the client side properties collection.
JsonGenerator generatePageHistoryItems(boolean isBackList)
String getBeanPath()
Returns the path within the application of the WebBean being transformed.
String getBoneId()
Returns the id to be used for the JavaScript bone.
FrameBean getFrameBean(WebComponent parent)
WebGridData getGridData()
String getGridScriptClass()
return grid JS scriptClass name depending grid mode
WebGridWidths getGridWidths()
int getMetricAxisName()
Returns the name (see EnumDSSXMLAxisName of the axis with the metrics in it.
String getReportSetting(String propertySetName, String propertyName)
ViewBean getViewBean()
WebTemplate getWebTemplate()
boolean isCalledFromPrinting()
This method is deprecated. The logic of this method is no longer required at this level, print transforms such as ReportGridPrintTransform now handle it. This method now returns false by default.
abstract boolean isGraphTransform()
abstract boolean isGridTransform()
boolean isQuickSwitchEnabled()
void renderJavascript(MarkupOutput out)
This method renders the javascript code that needs to be generated on the server side because its content is dynamic.
void setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.
boolean shouldRenderGridInfo()
This method is used to determine if the bone's gridInfo structure needs to be included.
boolean showSubTitleOnly(int subTitleIndex)
Returns whether show only the subtitle for this grid.
boolean showSubtitle(int subTitleCount)
Returns whether subtitles are enabled for this grid.
boolean showSubtitle()
Returns whether subtitles are enabled for this grid.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.app.transforms.ReportDataTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String BLANK_SUBSET_REPORT_ID

Constant Value: "DB8D5B064BBE3C24F541DAA81A507FDC"

Fields

protected String _blankImage

This field is deprecated.
This is not used anymore. You can use _imgBlank as the source for a transparent image.

This is the image name for blank space.

protected String _cssBottom

This field is deprecated.
css formatting is now applied through the layout-xml.

This is the css name for the bottom area.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.

protected String _cssCenter

This field is deprecated.
css formatting is now applied through the layout-xml.

This is the css name for the center area.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.

protected String _cssLeft

This field is deprecated.
css formatting is now applied through the layout-xml.

This is the css name for the left area.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.

protected String _cssRight

This is the css name for the right area.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.

protected String _cssTop

This field is deprecated.
css formatting is now applied through the layout-xml.

This is the css name for the top area.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.

protected String _ifLeftArrowImage

This field is deprecated.
This instance variable should have been private.

This is the image name for the left arrow image in incremental fetch.

protected String _ifRightArrowImage

This field is deprecated.
This instance variable should have been private.

This is the image name for the right arrow image in incremental fetch.

protected FormalParameter advancedDrillingContextMenuDisplay

It is used in the transform to specify whether to show the advanced drilling options in the editor or context menu.
Allowed Values: PreferencesDrillTransform.ADVANCED_DRILLING_RMC_DISPLAY_DEFAULT = "1"
ADVANCED_DRILLING_RMC_DISPLAY_SUBMENU = "2"

protected FormalParameter cssBottom

This field is deprecated.
css formatting is now applied through the layout-xml.

This is the css name for the bottom area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.

protected FormalParameter cssCenter

This field is deprecated.
css formatting is now applied through the layout-xml.

This is the css name for the center area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.

protected FormalParameter cssLeft

This field is deprecated.
css formatting is now applied through the layout-xml.

This is the css name for the left area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.

protected FormalParameter cssRight

This field is deprecated.
css formatting is now applied through the layout-xml.

This is the css name for the right area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.

protected FormalParameter cssTop

This field is deprecated.
css formatting is now applied through the layout-xml.

This is the css name for the top area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.

protected FormalParameter customJavaScriptFeatures

name for the formal parameter "customJavaScriptFeatures".

protected FormalParameter drillRetainThresholds

This is the FP which tells whether to retain the thresholds while drilling. If a value is specified here, then the drill Preference on the preference page for the same is ignored. This value can be 1(to retain), 0(to not retain) or 2(to use the drill path for the value). If blank the drill preference is used. Allowed Values:
PreferencesDrillTransform.DRILL_OPTION_RETAIN_THRESHOLD_YES = "1";
PreferencesDrillTransform.DRILL_OPTION_RETAIN_THRESHOLD_NO = "2";
PreferencesDrillTransform.DRILL_OPTION_RETAIN_THRESHOLD_REPORT_DEFINITION = "3";

protected FormalParameter drillWithinBehavior

It is used in the transform to specify the drill within behavior. As of now this formal parameter is used only for grids in report writting documents.
Drill Within paths will typically be displayed twice on the drill context menu, once at the first submenu level, and once in the Drill Anywhere submenu(s). We can take advantage of this fact to allow the user to decide whether clicking on a path that can be resolved within the base report will in fact be resolved within the current document, or if it will generate a new report instance instead. Allowed Values: TRUE/FALSE.
Allowed Values:
EnumWebPreferences.DRILL_WITHIN_AUTOMATIC = "1" : If the path can be resolved with the base report, it will be performed as a manipulation on the current document instance; otherwise it will generate a new report instance. This option would be the default and would automatically choose what we think is the most optimized behavior.
EnumWebPreferences.DRILL_WITHIN_MENU_LOCATION = "2" : If the path is a within path and it is clicked on in the first submenu level, then it will be performed as a manipulation on the current document instance; otherwise it will generate a new report instance (within paths that are located in the drill anywhere submenu(s) will generate a new report instance). EnumWebPreferences.DRILL_WITHIN_ALWAYS_NEW_REPORT = "3" : All paths will generate a new report instance, including Within paths. This option could be selected to enforce consistent behavior on all drill paths, since non-within paths will always generate a new report instance, regardless of the user preference.

protected FormalParameter gridGraphUnitKeyContext

This formal parameter indicates the unique Id of the RWGridGraphControl. This will only apply to grids and graphs rendered inside Report Writing Documents. Allowed values:
Any String

protected FormalParameter groupContextMenuDrillPathsByType

Determines whether drill types (up, down, across and to template) will be displayed as read from the backend in which case the drill types may be intermingled or that we will buck the types together and show the types grouped together. The order will be up, down, across and to template. Default is false. Allowed Values: TRUE/FALSE.

protected boolean hasIncreFetchForColumnOnLeft

This field is deprecated.
This variable it's not used anymore.

It is used in the transform to specify whether there are incremental fetch links for column on left side of the report data.
Allowed Values: TRUE/FALSE.

protected boolean hasIncreFetchForColumnOnRight

This field is deprecated.
This variable it's not used anymore.

It is used in the transform to specify whether there are incremental fetch links for column on right side of the report data.
Allowed Values: TRUE/FALSE.

protected FormalParameter id

It is used to identify the outer shell for all report modes - grid, graph and gridgraph. (Firefox issue: 246019)

protected FormalParameter ifLeftArrowImage

This is the name of the left arrow image to be used in this transform for incremental fetch.
Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter ifRightArrowImage

This is the name of the right arrow image to be used in this transform for incremental fetch.
Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter incrementalFetchStyleForRow

This is the name of the style used to show the incremental fetch for row.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter quickSwitch

This formal parameter indicates if the grid is going to have the Quick Switch functionality (client side view mode change enabler) enabled. This will only apply to grids and graphs rendered inside Report Writing Documents. Allowed values:
True and False

protected FormalParameter quickSwitchCurrent

This formal parameter indicates if the grid is going to have the Quick Switch functionality and if it's the current view mode displayed. This will only apply to grids and graphs rendered inside Report Writing Documents. Allowed values:
True and False

protected FormalParameter rwbViewerID

This Formal Parameter is used to indicate the bone ID for the RWB viewer. Allowed Values: any String.

protected FormalParameter showDrillPathSetNamesSubMenuAtTopLevel

It is used in the transform to specify whether to show the set names submenu for drilling at the top level (or at a lower depth).
Allowed Values: TRUE/FALSE.

protected FormalParameter showIncreFetchForColumn

This field is deprecated.
To show/hide the incremental fetch section you should modify the corresponding xml-layout definition of the transform.

It is used in the transform to specify whether to show increfetch links on column.
Allowed Values: TRUE/FALSE.

protected FormalParameter showIncreFetchForRowOnBottom

This field is deprecated.
To show/hide the incremental fetch section you should modify the corresponding xml-layout definition of the transform.

It is used in the transform to specify whether to show increfetch links for rows at the bottom of the grid.
Allowed Values: TRUE/FALSE.

protected FormalParameter showIncreFetchForRowOnTop

This field is deprecated.
To show/hide the incremental fetch section you should modify the corresponding xml-layout definition of the transform.

It is used in the transform to specify whether to show increfetch links for rows on top of the grid.
Allowed Values: TRUE/FALSE.

protected FormalParameter showSubtitlePara

Controls whether subtitles (attribute forms) are to be displayed for this grid. Allowed Values:

protected FormalParameter sortSetNamesAndDrillPaths

It is used in the transform to specify whether to show the set names and drill paths names alphabetically sorted.
Allowed Values: TRUE/FALSE.

protected HashMap transformContext

This field is deprecated.
This instance variable should have been private. You may use getTransformContext() to access it.

The tranform context object represented as a hashtable.
All the items' keys are listed as constants in ReportTransformHelper.

protected FormalParameter uniqueReportId

This is the name of the HTML DIV for the report. It's used as the unique identifier of the grid's bone.
Allowed Values: String values.

Public Constructors

public AbstractReportDataTransform ()

Class constructor.

Public Methods

public Map getAttributesShellDiv ()

Returns a Map with the list of attributes that the shell div must use. The shell is the main div surrounding the Transform's output.
This method is being overridden in this subclass to prevent the scriptclass from being rendered twice.

public int getDisplayMode (WebDrillPath dp)

Returns the display mode when drilling via the given drill path

Parameters
dp Drill Path

public String getID ()

Returns the unique name of the component to be used as the ID for its shell. This id is used for updating the page using the iFrame technology, and as the id for the corresponding bone (if any).

Returns
  • the component's unique id

public HashMap getTransformContext ()

Get the context object associated with the transform.

Returns
  • the transform context object

public boolean hasBottom ()

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.

Whether the transform has the bottom area. Out of box, if the formal parameter indicates that we need to display incremental fetch links for row on the bottom of the data, it returns true, or else, it returns false.

Returns
  • Whether the transform has the bottom area

public abstract boolean hasCenter ()

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.

Whether the transform has the center area. Out of box, it returns true.

Returns
  • Whether the transform has the center area

public boolean hasLeft ()

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.

Whether the transform has the left area. Out of box, if the formal parameter indicates that we need to display incremental fetch links for column and there are data to the left of the current data, it returns true, or else, it returns false.

Returns
  • Whether the transform has the right area

public boolean hasRight ()

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.

Whether the transform has the right area. Out of box, if the formal parameter indicates that we need to display incremental fetch links for column and there are data to the right of the current data, it returns true, or else, it returns false.

Returns
  • Whether the transform has the right area

public boolean hasTop ()

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.

Whether the transform has the top area. Out of box, if the formal parameter indicates that we need to display incremental fetch links for row on the top of the data, it returns true, or else, it returns false.

Returns
  • Whether the transform has the top area

public void initializeCss ()

Initialize the css classes to be used by this transform.

public void initializeImages ()

initialize the images for the transform.

public void initializeProperties ()

Extends initializeProperties by invoking initializeTranformContext

public void initializeTranformContext ()

Initialize the transform context object. This object is later passed to the ReportGridDisplayCell instances so they have information about the transform.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform. After calling the initializeTransform on super, it calls initializeProperties if the XMLStatus of the reportBean is WebBeanRequestSuccessful

Parameters
data the bean to transform.

public void initializeWebComponent (Transformable data)

This method initialize WebComponent being transformed. This method enables the transform to support both ReportBean and ViewBean.
Internally, when a ReportBean is passed, this Transform will get its ViewBean and call super using the ViewBean. Starting with 8.0, ReportDataTransforms manipulates instances of ViewBean's.

Parameters
data object being Transformed

public boolean isGridEmpty ()

Returns true if the grid contains no data.

public boolean isRWBean ()

public void renderBottom (MarkupOutput out, ReportBean rb)

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.

Render bottom area of the transform.

Parameters
out MarkupOutput to generate the HTML.
rb ReportBean being transformed (ignored, always uses the bean passed to the initializeTransform method).

public void renderContent (MarkupOutput out, ReportBean rb)

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.

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 MarkupOutput to generate the HTML.
rb ReportBean being transformed (ignored, always uses the bean passed to the initializeTransform method).

public void renderIncreFetchOnColumnLeftPart (MarkupOutput out, ReportBean rb)

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use/extend the renderColumnsIncrementalFetchPrevious method.

Generates the arrow for the previous set of columns.

Parameters
out MarkupOutput to generate the HTML.
rb ReportBean being transformed (ignored, always uses the bean passed to the initializeTransform method).

public void renderIncreFetchOnColumnRightPart (MarkupOutput out, ReportBean rb)

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use/extend the renderColumnsIncrementalFetchNext method.

Generates the arrow for the next set of columns.

Parameters
out MarkupOutput to generate the HTML.
rb ReportBean being transformed (ignored, always uses the bean passed to the initializeTransform method).

public void renderIncreFetchOnRow (MarkupOutput out, ReportBean rb)

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use/extend the renderRowsIncrementalFetch method.

Generates the rows incremental fetch portion.

Parameters
out MarkupOutput to generate the HTML.
rb ReportBean being transformed (ignored, always uses the bean passed to the initializeTransform method).

public void renderLeft (MarkupOutput out, ReportBean rb)

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.

Render left area of the transform.

Parameters
out MarkupOutput to generate the HTML.
rb ReportBean being transformed (ignored, always uses the bean passed to the initializeTransform method).

public void renderRight (MarkupOutput out, ReportBean rb)

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.

Render right area of the transform.

Parameters
out MarkupOutput to generate the HTML.
rb ReportBean being transformed (ignored, always uses the bean passed to the initializeTransform method).

public void renderRowsIncrementalFetch (MarkupOutput out)

Generates the rows incremental fetch portion. It just delegates this to another Transform, as specified by the incrementalFetchStyleForRow formal parameter.

Parameters
out MarkupOutput to generate the HTML.

public void renderTop (MarkupOutput out, ReportBean rb)

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.

Render top area of the transform.

Parameters
out MarkupOutput to generate the HTML.
rb ReportBean being transformed (ignored, always uses the bean passed to the initializeTransform method).

public boolean supports (Transformable data)

Extends support by supporting more than one type of Transformable. ReportDataTransforms need to support both ViewBean and ReportBean

Parameters
data the object to decide if the Transforms supports it
Returns
  • true if data is a ViewBean or a ReportBean

public boolean supports (Class c)

Extends support by supporting more than one Class. ReportDataTransforms need to support both ViewBean and ReportBean

Parameters
c the Class to decide if the transforms supports it
Returns
  • true if c is ViewBean or a ReportBean

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the status is "Successful". This is the main entry point of the Transform. It will check if a layout-xml has been specified and use it, otherwise it calls renderContent.
After the content has been generated it calls renderJavascript to generate any necessary client-side information.

Parameters
out MarkupOutput to generate the HTML.

Protected Methods

protected void createBlockEditorProperties ()

This method is deprecated.
use createBlockEditorProperties(JsonGenerator)

This method adds all of the grid/graph Report Services properties to the client side properties collection.

protected void createBlockEditorProperties (JsonGenerator boneProps)

This method adds all of the grid/graph Report Services properties to the client side properties collection.

protected JsonGenerator generatePageHistoryItems (boolean isBackList)

protected String getBeanPath ()

Returns the path within the application of the WebBean being transformed.
When submitting an WebEvent, this path allows Microstrategy Web to uniquely identify the location of the bean that needs to handle the event.
This method is used by the renderRegisterBone method to inform the javascript bone the bean to whom it should send its server-side requests.

Returns
  • String

protected String getBoneId ()

Returns the id to be used for the JavaScript bone.
This method is used by the renderRegisterBone method to indicate the id of the bone html element.

Returns
  • String

protected FrameBean getFrameBean (WebComponent parent)

protected WebGridData getGridData ()

protected String getGridScriptClass ()

return grid JS scriptClass name depending grid mode

Returns
  • string scriptClass name

protected WebGridWidths getGridWidths ()

protected int getMetricAxisName ()

Returns the name (see EnumDSSXMLAxisName of the axis with the metrics in it. Will return -1 if the template contains no metrics, and -2 if there is an error.

Returns

protected String getReportSetting (String propertySetName, String propertyName)

protected ViewBean getViewBean ()

protected WebTemplate getWebTemplate ()

protected boolean isCalledFromPrinting ()

This method is deprecated.
The logic of this method is no longer required at this level, print transforms such as ReportGridPrintTransform now handle it. This method now returns false by default.

whether it's displaying for printing.

Returns
  • whether it's displaying for printing

protected abstract boolean isGraphTransform ()

protected abstract boolean isGridTransform ()

protected boolean isQuickSwitchEnabled ()

protected void renderJavascript (MarkupOutput out)

This method renders the javascript code that needs to be generated on the server side because its content is dynamic. In particular this method invokes renderRegisterBone which initializes and registers a grid's bone..

Parameters
out MarkupOutput to generate the HTML.

protected void setBoneProperties (JsonGenerator boneProps)

Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.

Parameters
boneProps the JsonGenerator object that contains the collection of bone properties.

protected boolean shouldRenderGridInfo ()

This method is used to determine if the bone's gridInfo structure needs to be included. As an optimization in the Document page, when executing a document, only the first bone registered for a given grid includes the gridInfo structure.

Returns
  • true if the grid bone properties should include the gridInfo.

protected boolean showSubTitleOnly (int subTitleIndex)

Returns whether show only the subtitle for this grid.

Parameters
subTitleIndex Index of the current subtitle (starting from 0).

protected boolean showSubtitle (int subTitleCount)

Returns whether subtitles are enabled for this grid. It will check the value of the showSubtitle formal parameter. This could be:

  • PREFERENCE_NO: subtitles are off.
  • PREFERENCE_YES: subtitles are on.
  • PREFERENCE_VALUE_FROM_REPORT: the "LongNames" report setting controls whether subtitles are on or off.
    ValueBehavior for Attributes with a single displayed form (subTitleCount = 1)Behavior for Attributes with multiple displayed forms (subTitleCount > 1)
    -1Show Attribute name onlyShow Attribute name + form name on all forms
    0Show Attribute name onlyShow Attribute name on the first form only, show nothing on subsequent forms
    1Show Attribute name + form nameShow Attribute name + form name on all forms
    2Show Attribute form name onlyShow attribute form name only for all forms
    3Show Attribute name + form nameShow Attribute name + form name on first form; Form name only on subsequent forms
    4Show Attribute name onlyShow Attribute name + form name on all forms

Parameters
subTitleCount Count of sub titles.
Returns
  • true if the subtitles are enabled.

protected boolean showSubtitle ()

Returns whether subtitles are enabled for this grid. It will check the value of the showSubtitle formal parameter. This could be:

Returns
  • true if the subtitles are enabled.