public interface

ReportGridCellMetricValue

implements ReportGridDisplayCell
com.microstrategy.web.app.transforms.ReportGridCellMetricValue
Known Indirect Subclasses

Class Overview

The ReportGridCellMetricValue represents a value of the report data.

Classes implementing this interface uses a WebRowValue as the underlying SDK objects to retrieve the information from.

Users can modify the HTML generated for these cells by creating a custom class that implements this interface. The easiest way to accomplish this is to extend the out-of-the-box implementation provided by Microstrateg Web, that is the ReportGridCellMetricValueImpl.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell
Public Methods
abstract WebRowValue getWebRowValue()
Returns the underlying SDK object associated with this cell.
abstract WebTemplateMetric getWebTemplateMetric()
return the WebTemplateMetric object associated with this cell
abstract void init(WebComponent wc, WebTemplateMetric metric, FormalParameters formalParas)
This method is deprecated. The Transform doesn't use this method to initialize a non-empty cell, it always uses init(TransformContext, WebRowValue).
abstract void init(TransformContext context, WebRowValue rowValue)
This method is called to initialize the cell with the corresponding WebRowValue as the underlying SDK object
abstract void init(WebComponent wc, WebRowValue rowValue, HashMap cachedObjects)
This method is deprecated. please use the interface that takes a TransformContext instance object as parameter
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell

Public Methods

public abstract WebRowValue getWebRowValue ()

Returns the underlying SDK object associated with this cell. It should always return null if the instance represents an empty cell.

Returns
  • The underlying SDK object.

public abstract WebTemplateMetric getWebTemplateMetric ()

return the WebTemplateMetric object associated with this cell

Returns
  • the WebTemplateMetric object

public abstract void init (WebComponent wc, WebTemplateMetric metric, FormalParameters formalParas)

This method is deprecated.
The Transform doesn't use this method to initialize a non-empty cell, it always uses init(TransformContext, WebRowValue).

public abstract void init (TransformContext context, WebRowValue rowValue)

This method is called to initialize the cell with the corresponding WebRowValue as the underlying SDK object

Parameters
context TransformContext instance initialized with the grid's transform information.
rowValue WebRowValue instance corresponding to the cell to be displayed.

public abstract void init (WebComponent wc, WebRowValue rowValue, HashMap cachedObjects)

This method is deprecated.
please use the interface that takes a TransformContext instance object as parameter

This method is called to initialize the cell with the corresponding WebRowValue as the underlying SDK object.

Parameters
wc The bean being transformed.
rowValue The WebRowValue corresponding to this cell.
cachedObjects A HashMap populated by the transform and used to store information shared across multiple cells.