public abstract class

AbstractReportGridTransform

extends AbstractReportDataTransform
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
               ↳ com.microstrategy.web.app.transforms.AbstractReportGridTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

The AbstractReportGridTransform is an base class for those transform that generate a grid visualization of the data returned by a Report.

It serves two main purposes a)to hold an initialize common formal parameters, and b)as a factory for ReportGridDisplayCell classes.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected final String COL_HEADER
protected final String COL_HEADER_CLASS
protected final String COL_TITLE
protected final String COL_TITLE_CLASS
protected final String DISPLAY_CELL
protected final String DISPLAY_CELL_CLASS
protected final String METRIC_VALUE
protected final String METRIC_VALUE_CLASS
protected final String REUSE_FLAG Note: for the purpose of cell reuse.
protected final String ROW_HEADER
protected final String ROW_HEADER_CLASS
protected final String ROW_TITLE
protected final String ROW_TITLE_CLASS
protected ContextMenuManager _contextMenuManager
protected HashMap _gridCellClasses
protected String _imgRemove The full image name for remove button.
protected String _imgShiftDown The full image name for shift-to-down pivot button.
protected String _imgShiftLeft The full image name for shift-to-left pivot button.
protected String _imgShiftLeftDown The full image name for shift-left-down pivot button.
protected String _imgShiftRight The full image name for shift-to-right pivot button.
protected String _imgShiftRightDown This field is deprecated. This parameter has been deprecated as it was only used by the ReportPageByTransform.
protected String _imgShiftRightUp The full image name for shift-right-up pivot button.
protected String _imgShiftUp The full image name for shift-to-up pivot button.
protected String _imgToPageBy The full image name for shift-to-pageby pivot button.
protected ReportDisplayCellsFactory _rdcFactory This factory object is used to generate a cell instance for a particular type if necessary.
protected boolean _reuseFlag This flag is used to indicate reuse the cell instances from the above cell factory or not.
protected FormalParameter addNumberFormatting Whether to add the number formatting on metric values.
protected FormalParameter contextMenuName This is the parameter to define the name of the context menu to use.
protected FormalParameter gridClassesConfFile It is used to indicate the name and location of the properties file containing the definition of the grid classes to use.
protected FormalParameter imgRemove This is the image name for remove image used in the transform.
protected FormalParameter imgShiftDown This is the image name for shift down arrow used in the transform.
protected FormalParameter imgShiftLeft This is the image name for shift left arrow used in the transform.
protected FormalParameter imgShiftLeftDown This is the image name for shift left down arrow (pivot to row) used in the transform.
protected FormalParameter imgShiftRight This is the image name for shift right arrow used in the transform.
protected FormalParameter imgShiftRightDown This field is deprecated. This parameter has been deprecated as it was only used by the ReportPageByTransform.
protected FormalParameter imgShiftRightUp This is the image name for shift right up arrow (pivot to column) used in the transform.
protected FormalParameter imgShiftUp This is the image name for shift up arrow used in the transform.
protected FormalParameter imgToPageBy This is the image name for to-page-by image used in the transform.
protected FormalParameter isContextMenuEnabled This field is deprecated. To customize context-menus use the xml-definition specified by contextMenus
protected FormalParameter isDragAndDropEnabled This is the flag used in the transform to specify whether to enable drag and drop functionality.
protected FormalParameter postTextForMetricValue This is the post text for the metric value cell content.
protected FormalParameter postTextForNonMetricValue This is the post text for the non-metric value cell content.
protected FormalParameter preTextForMetricValue This is the pre text for the metric value cell content.
protected FormalParameter preTextForNonMetricValue This is the pre text for the non-metric value cell content.
protected FormalParameter reportDesignModePara This is the report mode flag used in the transform.
protected FormalParameter returnReplacement This is the substring that when found in the cell will be replaced by a break (<br>) tag.
protected FormalParameter showContextMenus This field is deprecated. use isContextMenuEnabled instead.
protected FormalParameter showDescriptionAsTooltip It is used in the transform to specify whether to show the descriptions in the tooltip for the row or column titles.
protected FormalParameter showExtraRemoveRMC This is the flag used in the transform to specify whether to show a second Right Mouse Click menu for removing option.
protected FormalParameter showFormattingRMC This is the flag used in the transform to specify whether to show Right Mouse Click menu for formatting.
protected FormalParameter showGridInFullWidth This field is deprecated. Previously used only in design mode of the report. Deprecated because now the layout of the grid will be dictated by the column width setting, i.e. whether it is set to Fit to Contents or Fit to Window.
protected FormalParameter showPivotPara This is the flag used in the transform to specify whether to show pivot buttons.
protected FormalParameter showPivotRMC This is the flag used in the transform to specify whether to show Right Mouse Click menu for pivoting.
protected FormalParameter showRemovePara This is the flag used in the transform to specify whether to show remove buttons.
protected FormalParameter showRemoveRMC This is the flag used in the transform to specify whether to show Right Mouse Click menu for removing.
protected FormalParameter showRenameRMC This is the flag used in the transform to specify whether to show Right Mouse Click menu for renaming.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractReportTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractReportGridTransform()
default no-args constructor.
Public Methods
void initializeImages()
initialize the images for the transform.
void initializeProperties()
Extends initializeProperties by invoking initializeTranformContext
void initializeTransform(Transformable data)
Extends initializeTransform by initiliazing the grid cell classes by calling initializeCellClasses
Protected Methods
void generateJavaScriptForDragAndDrop(MarkupOutput out, ReportBean rb)
This method is deprecated. This method has been deprecated and will be removed in future versions of the product.
String getCssPrefix()
Get the prefix for the css class name.
int getDesignMode()
This method is deprecated. - use isDesignMode instead
ReportGridDisplayCell getGridCell(String className)
Get the cell instance for the given cell class name.
ReportGridCellColHeader getGridCellColHeader()
ReportGridCellColTitle getGridCellColTitle()
ReportGridCellMetricValue getGridCellMetricValue()
ReportGridCellRowHeader getGridCellRowHeader()
ReportGridCellRowTitle getGridCellRowTitle()
ReportGridCell getGridGenericCell()
void initGridCellClasses()
This method is deprecated. This method is deprecated and will be removed in future versions of the product.
It's not invoked anymore by the Transform, and calling it has no effect.
void initializeCellClasses()
Reads the configuration with the cell classes and caches its content, then it calls setGridCellClass for each different cell type.
boolean isContextMenuEnabled()
This method is deprecated. Please query directly the isContextMenuEnabled formal parameter instead
boolean isDragAndDropEnabled()
This method is deprecated. Please query directly the isDragAndDropEnabled formal parameter instead
boolean isGraphTransform()
boolean isGridTransform()
void setGridCellClass(Properties properties, String classKey, String defaultClassName)
This method initializes the classes used to render headers, titles and metric values by using a property file.
void setGridCellClass(String classKey, String className)
This method initializes the classes used to render headers, titles and metric values.
boolean showFormattingRMC()
This method is deprecated. Please query directly the showFormattingRMC formal parameter instead
boolean showPivot()
This method is deprecated. Please query directly the showPivotPara formal parameter instead
boolean showPivotRMC()
This method is deprecated. Please query directly the showPivotRMC formal parameter instead
boolean showRemove()
This method is deprecated. Please query directly the showRemovePara formal parameter instead
boolean showRemoveRMC()
This method is deprecated. Please query directly the showRemoveRMC formal parameter instead
boolean showRenameRMC()
This method is deprecated. Please query directly the showRenameRMC formal parameter instead
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
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

Fields

protected final String COL_HEADER

Constant Value: "colHeader"

protected final String COL_HEADER_CLASS

Constant Value: "com.microstrategy.web.app.transforms.ReportGridCellColHeaderImpl"

protected final String COL_TITLE

Constant Value: "colTitle"

protected final String COL_TITLE_CLASS

Constant Value: "com.microstrategy.web.app.transforms.ReportGridCellColTitleImpl"

protected final String DISPLAY_CELL

Constant Value: "displayCell"

protected final String DISPLAY_CELL_CLASS

Constant Value: "com.microstrategy.web.app.transforms.ReportGridCellImpl"

protected final String METRIC_VALUE

Constant Value: "metricValue"

protected final String METRIC_VALUE_CLASS

Constant Value: "com.microstrategy.web.app.transforms.ReportGridCellMetricValueImpl"

protected final String REUSE_FLAG

Note: for the purpose of cell reuse.

Constant Value: "reuseFlag"

protected final String ROW_HEADER

Constant Value: "rowHeader"

protected final String ROW_HEADER_CLASS

Constant Value: "com.microstrategy.web.app.transforms.ReportGridCellRowHeaderImpl"

protected final String ROW_TITLE

Constant Value: "rowTitle"

protected final String ROW_TITLE_CLASS

Constant Value: "com.microstrategy.web.app.transforms.ReportGridCellRowTitleImpl"

protected ContextMenuManager _contextMenuManager

protected HashMap _gridCellClasses

protected String _imgRemove

The full image name for remove button.
It includeds the image folder path.

protected String _imgShiftDown

The full image name for shift-to-down pivot button.
It includeds the image folder path.

protected String _imgShiftLeft

The full image name for shift-to-left pivot button.
It includeds the image folder path.

protected String _imgShiftLeftDown

The full image name for shift-left-down pivot button.
It's for pivot from column axis to row axis, and for pivot from page axis to row axis.
It includeds the image folder path.

protected String _imgShiftRight

The full image name for shift-to-right pivot button.
It includeds the image folder path.

protected String _imgShiftRightDown

This field is deprecated.
This parameter has been deprecated as it was only used by the ReportPageByTransform.

The full image name for shift-to-left pivot button.
It's for pivot from page axis to row axis.
It includeds the image folder path.

protected String _imgShiftRightUp

The full image name for shift-right-up pivot button.
It's for pivot from row axis to column axis.
It includeds the image folder path.

protected String _imgShiftUp

The full image name for shift-to-up pivot button.
It includeds the image folder path.

protected String _imgToPageBy

The full image name for shift-to-pageby pivot button.
It includeds the image folder path.

protected ReportDisplayCellsFactory _rdcFactory

This factory object is used to generate a cell instance for a particular type if necessary. One cell class has only one cell instance. Note: for the purpose of cell reuse.

protected boolean _reuseFlag

This flag is used to indicate reuse the cell instances from the above cell factory or not. By default, it is set to true. Or, it can be read from the property file defined by #gridClassesConfFile. NOte: for the purpose of cell reuse.

protected FormalParameter addNumberFormatting

Whether to add the number formatting on metric values.

protected FormalParameter contextMenuName

This is the parameter to define the name of the context menu to use.
Allowed Values: String values.

protected FormalParameter gridClassesConfFile

It is used to indicate the name and location of the properties file containing the definition of the grid classes to use.

protected FormalParameter imgRemove

This is the image name for remove image used in the transform.
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 imgShiftDown

This is the image name for shift down arrow used in the transform.
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 imgShiftLeft

This is the image name for shift left arrow used in the transform.
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 imgShiftLeftDown

This is the image name for shift left down arrow (pivot to row) used in the transform.
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 imgShiftRight

This is the image name for shift right arrow used in the transform.
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 imgShiftRightDown

This field is deprecated.
This parameter has been deprecated as it was only used by the ReportPageByTransform.

This is the image name for pivot-to-cols image used in the transform.
Allowed values: a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

protected FormalParameter imgShiftRightUp

This is the image name for shift right up arrow (pivot to column) used in the transform.
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 imgShiftUp

This is the image name for shift up arrow used in the transform.
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 imgToPageBy

This is the image name for to-page-by image used in the transform.
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 isContextMenuEnabled

This field is deprecated.
To customize context-menus use the xml-definition specified by contextMenus

This is the flag used in the transform to specify whether to enable context menu functionality.
Allowed Values: TRUE/FALSE.

protected FormalParameter isDragAndDropEnabled

This is the flag used in the transform to specify whether to enable drag and drop functionality.
Allowed Values: TRUE/FALSE.

protected FormalParameter postTextForMetricValue

This is the post text for the metric value cell content. Most likely used with exporting feature.
Allowed Values: String values.

protected FormalParameter postTextForNonMetricValue

This is the post text for the non-metric value cell content. Most likely used with exporting feature.
Allowed Values: String values.

protected FormalParameter preTextForMetricValue

This is the pre text for the metric value cell content. Most likely used with exporting feature.
Allowed Values: String values.

protected FormalParameter preTextForNonMetricValue

This is the pre text for the non-metric value cell content. Most likely used with exporting feature.
Allowed Values: String values.

protected FormalParameter reportDesignModePara

This is the report mode flag used in the transform.
not needed any more because we have two seperate transforms for execute mode and design mode: ReportGridTransformImpl and ReportDesignModeTransformImpl
Allowed Values: integer values from enumeration EnumReportViewModes.

protected FormalParameter returnReplacement

This is the substring that when found in the cell will be replaced by a break (<br>) tag.
Allowed Values: String values.

protected FormalParameter showContextMenus

This field is deprecated.
use isContextMenuEnabled instead.

It is used in the transform to specify whether to enable context menu functionality.
Allowed Values: TRUE/FALSE.

protected FormalParameter showDescriptionAsTooltip

It is used in the transform to specify whether to show the descriptions in the tooltip for the row or column titles.
It should be of BOOLEAN type.
Allowed Values: "1" means TRUE, "0" means FALSE.

protected FormalParameter showExtraRemoveRMC

This is the flag used in the transform to specify whether to show a second Right Mouse Click menu for removing option.
This second option will allow the Remove From Report manipulation only if Remove From Grid is granted to the user and showRemoveRMC is enabled. Allowed Values: TRUE/FALSE.

protected FormalParameter showFormattingRMC

This is the flag used in the transform to specify whether to show Right Mouse Click menu for formatting.
Allowed Values: TRUE/FALSE.

protected FormalParameter showGridInFullWidth

This field is deprecated.
Previously used only in design mode of the report. Deprecated because now the layout of the grid will be dictated by the column width setting, i.e. whether it is set to Fit to Contents or Fit to Window.

It is used in the transform to specify whether to show the grid in full width.
If TRUE, the grid will expand to the complete browser window; If FALSE, the grid will fit to the content in each cell. Allowed Values: TRUE/FALSE.

protected FormalParameter showPivotPara

This is the flag used in the transform to specify whether to show pivot buttons.
Allowed Values: TRUE/FALSE.

protected FormalParameter showPivotRMC

This is the flag used in the transform to specify whether to show Right Mouse Click menu for pivoting.
Allowed Values: TRUE/FALSE.

protected FormalParameter showRemovePara

This is the flag used in the transform to specify whether to show remove buttons.
Allowed Values: TRUE/FALSE.

protected FormalParameter showRemoveRMC

This is the flag used in the transform to specify whether to show Right Mouse Click menu for removing.
Allowed Values: TRUE/FALSE.

protected FormalParameter showRenameRMC

This is the flag used in the transform to specify whether to show Right Mouse Click menu for renaming.
Allowed Values: TRUE/FALSE.

Public Constructors

public AbstractReportGridTransform ()

default no-args constructor.

Public Methods

public void initializeImages ()

initialize the images for the transform.

public void initializeProperties ()

Extends initializeProperties by invoking initializeTranformContext

public void initializeTransform (Transformable data)

Extends initializeTransform by initiliazing the grid cell classes by calling initializeCellClasses

Parameters
data the bean to transform.

Protected Methods

protected void generateJavaScriptForDragAndDrop (MarkupOutput out, ReportBean rb)

This method is deprecated.
This method has been deprecated and will be removed in future versions of the product.

Generates the javascript used to initialize the drilling when using incremental fetch.

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

protected String getCssPrefix ()

Get the prefix for the css class name.

Returns
  • the prefix for the css class name

protected int getDesignMode ()

This method is deprecated.
- use isDesignMode instead

get the design mode of the report.

Returns

protected ReportGridDisplayCell getGridCell (String className)

Get the cell instance for the given cell class name. Note: This method has been refactored since 9.0.1 for the purpose of cell reuse.

protected ReportGridCellColHeader getGridCellColHeader ()

protected ReportGridCellColTitle getGridCellColTitle ()

protected ReportGridCellMetricValue getGridCellMetricValue ()

protected ReportGridCellRowHeader getGridCellRowHeader ()

protected ReportGridCellRowTitle getGridCellRowTitle ()

protected ReportGridCell getGridGenericCell ()

protected void initGridCellClasses ()

This method is deprecated.
This method is deprecated and will be removed in future versions of the product.
It's not invoked anymore by the Transform, and calling it has no effect.

protected void initializeCellClasses ()

Reads the configuration with the cell classes and caches its content, then it calls setGridCellClass for each different cell type.

protected boolean isContextMenuEnabled ()

This method is deprecated.
Please query directly the isContextMenuEnabled formal parameter instead

whether context menu feature is enabled.

Returns
  • whether context menu feature is enabled

protected boolean isDragAndDropEnabled ()

This method is deprecated.
Please query directly the isDragAndDropEnabled formal parameter instead

whether drag and drop feature is enabled.

Returns
  • whether drag and drop feature is enabled

protected boolean isGraphTransform ()

protected boolean isGridTransform ()

protected void setGridCellClass (Properties properties, String classKey, String defaultClassName)

This method initializes the classes used to render headers, titles and metric values by using a property file. These classes are defined under WEB-INF\classes\resources\gridClasses.properties By default, this file contains the following values:

    colHeader=com.microstrategy.web.app.transforms.ReportGridCellColHeaderImpl
    rowHeader=com.microstrategy.web.app.transforms.ReportGridCellRowHeaderImpl
    colTitle=com.microstrategy.web.app.transforms.ReportGridCellColTitleImpl
    rowTitle=com.microstrategy.web.app.transforms.ReportGridCellRowTitleImpl
    metricValue=com.microstrategy.web.app.transforms.ReportGridCellMetricValueImpl
    displayCell=com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
 

protected void setGridCellClass (String classKey, String className)

This method initializes the classes used to render headers, titles and metric values.
These classes are defined under WEB-INF\classes\resources\gridClasses.properties By default, this file contains the following values:

    colHeader=com.microstrategy.web.app.transforms.ReportGridCellColHeaderImpl
    rowHeader=com.microstrategy.web.app.transforms.ReportGridCellRowHeaderImpl
    colTitle=com.microstrategy.web.app.transforms.ReportGridCellColTitleImpl
    rowTitle=com.microstrategy.web.app.transforms.ReportGridCellRowTitleImpl
    metricValue=com.microstrategy.web.app.transforms.ReportGridCellMetricValueImpl
    displayCell=com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
 
 
This method is used as shown below:
    setGridCellClass(properties, COL_HEADER, COL_HEADER_CLASS);
 
where COL_HEADER is a constant that defines a column header and COL_HEADER_CLASS defines the actual name of the implementation class (com.microstrategy.web.app.transforms.ReportGridCellColHeaderImpl) Developers can use this method to set their own implementation classes. For example:
    //Initialize the HashMap with the name of the classes.
    initGridCellClasses();
    //Set the class to be used for the different elements of a grid
    setGridCellClass(COL_HEADER, "com.microstrategy.web.app.transforms.MyReportGridCellColHeaderImpl");
    setGridCellClass(ROW_HEADER, "com.microstrategy.web.app.transforms.MyReportGridCellRowHeaderImpl");
    setGridCellClass(COL_TITLE, "com.microstrategy.web.app.transforms.MyReportGridCellColTitleImpl");
    setGridCellClass(ROW_TITLE, "com.microstrategy.web.app.transforms.MyReportGridCellRowTitleImpl");
    setGridCellClass(METRIC_VALUE, "com.microstrategy.web.app.transforms.MyReportGridCellMetricValueImpl");
    setGridCellClass(DISPLAY_CELL, "com.microstrategy.web.app.transforms.MyReportGridCellDisplayCellImpl");
 

Parameters
classKey one of the following:
  • COL_HEADER
  • ROW_HEADER
  • COL_TITLE
  • ROW_TITLE
  • METRIC_VALUE
  • DISPLAY_CELL
className a fully qualified class name.

protected boolean showFormattingRMC ()

This method is deprecated.
Please query directly the showFormattingRMC formal parameter instead

whether to display the formatting RMC (right mouse click context menu).

Returns
  • whether to display the formatting RMC (right mouse click context menu)

protected boolean showPivot ()

This method is deprecated.
Please query directly the showPivotPara formal parameter instead

whether to display the pivot buttons.

Returns
  • whether to display the pivot buttons

protected boolean showPivotRMC ()

This method is deprecated.
Please query directly the showPivotRMC formal parameter instead

whether to display the pivot RMC (right mouse click context menu).

Returns
  • whether to display the pivot RMC (right mouse click context menu)

protected boolean showRemove ()

This method is deprecated.
Please query directly the showRemovePara formal parameter instead

whether to display the remove buttons.

Returns
  • whether to display the remove buttons

protected boolean showRemoveRMC ()

This method is deprecated.
Please query directly the showRemoveRMC formal parameter instead

whether to display the remove RMC (right mouse click context menu).

Returns
  • whether to display the remove RMC (right mouse click context menu)

protected boolean showRenameRMC ()

This method is deprecated.
Please query directly the showRenameRMC formal parameter instead

whether to display the rename RMC (right mouse click context menu).

Returns
  • whether to display the rename RMC (right mouse click context menu)