public abstract class

AbstractReportDataVisualizationTransform

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.AbstractReportDataVisualizationTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Transform used to render a visualization on the report. Provides methods for obtaining the custom XML or a URL to obtain the report XML.
The subclasses simply need to implement renderVisualization()

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractReportDataTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter containerHeight Specifies the height (in any measure accepted by the web-browser) of the element rendered by this transform.
protected FormalParameter containerWidth Specifies the width (in any measure accepted by the web-browser) of the element rendered by this transform.
public FormalParameter documentStyle The RWBean transform's style that will transform the view bean for obtaining the custom report XML for grids in documents Allowed values: String value that corresponds to a style on the styleCatalog.
protected String mojoWidgetId
public FormalParameter renderElementListOnSelectionDataJson Whether to add a list of the elements to the selectionData JSON object.
public FormalParameter renderShell Whether to render the shell (DIV tag) that allows the visualization to have a grid bone.
public FormalParameter reportXMLPageName The name of the page on the pageConfig that returns the custom report XML.
public FormalParameter reportXMLStyle The name of the style to use to generate the custom report XML Allowed values: String value that corresponds to a style on the styleCatalog.
public FormalParameter rwPageName The name of the page on the pageConfig that returns the custom report XML for grids in documents.
public FormalParameter useAbsoluteURLs Whether to use an absolute path on the CustomURL FlashVar
[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
AbstractReportDataVisualizationTransform()
Public Methods
Map getAttributesBone()
String getDescription()
String getMojoWidgetId()
Class getSupportedBeanType()
return the bean type supported by this transform.
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.
void initializeProperties()
Extends initializeProperties by invoking initializeTranformContext
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void renderCenter(MarkupOutput out, ReportBean rb)
void renderData(MarkupOutput out, ReportBean rb)
void renderEmptyCase(MarkupOutput out, ReportBean rb)
void renderLayout(MarkupOutput out, ReportBean rb)
abstract void renderVisualization(MarkupOutput out)
Renders the visualization's content (i.e.
void setMojoWidgetId(String mojoWidgetId)
boolean supports(Transformable data)
Extends support by supporting more than one type of Transformable.
void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful".
Protected Methods
ParameterBuilder getBaseURL()
Returns a ParameterBuilder object that contains a base URL.
ParameterBuilder getBaseURL(boolean useAbsoluteURL)
Returns a ParameterBuilder object that contains a base URL.
JsonGenerator getControlLinksJson()
String getCustomReportXML()
String getGridKeys()
RWBean getRWBean()
String getResultFlags(int viewMode)
JsonGenerator getSelectionDataJSON()
ParameterBuilder getTaskBaseURL(String contentType)
Returns a ParameterBuilder object that contains a base URL which can be used to invoke a Task on the Tasks infrastructure.
ParameterBuilder getTaskBaseURL()
Returns a ParameterBuilder object that contains a base URL which can be used to invoke a Task on the Tasks infrastructure to get XML content.
String getTaskURLForCustomReportXML()
Returns a URL that can be used to obtain the report XML of the current report being transformed.
String getTaskURLForReportContent(String contentType)
Returns a URL that can be used to obtain the report data of the current report being transformed.
ParameterBuilder getTaskURLForReportData(String contentType)
Returns a URL that can be used to obtain the report data of the current report being transformed.
String getURLForCustomReportXML()
Returns a URL that can be used to obtain the report XML of the current report being transformed.
WebReportGrid getWebReportGrid()
boolean isDesignMode()
This methods allows the transform to identify if concrete subclasses are designed to work in design mode, or in execute mode.
boolean isGraphTransform()
boolean isGridTransform()
void setBoneProperties(JsonGenerator boneProps)
Add the "selectionData" property on the grid bone.
[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 FormalParameter containerHeight

Specifies the height (in any measure accepted by the web-browser) of the element rendered by this transform. Its value can be specified on the request as "containerHeight" and this will overwrite the existing value.

protected FormalParameter containerWidth

Specifies the width (in any measure accepted by the web-browser) of the element rendered by this transform. Its value can be specified on the request as "containerWidth" and this will overwrite the existing value.

public FormalParameter documentStyle

The RWBean transform's style that will transform the view bean for obtaining the custom report XML for grids in documents Allowed values: String value that corresponds to a style on the styleCatalog.

protected String mojoWidgetId

public FormalParameter renderElementListOnSelectionDataJson

Whether to add a list of the elements to the selectionData JSON object. This list can be used to map names to element IDs and obtain metric values (used for the US Map Visualization sample).

public FormalParameter renderShell

Whether to render the shell (DIV tag) that allows the visualization to have a grid bone.
This is not necessary when the visualization is displayed inside an Iframe

public FormalParameter reportXMLPageName

The name of the page on the pageConfig that returns the custom report XML.
Used to generate the URL for the custom report XML. Allowed values: String value that corresponds to a page name on the pageConfig.

public FormalParameter reportXMLStyle

The name of the style to use to generate the custom report XML Allowed values: String value that corresponds to a style on the styleCatalog.

public FormalParameter rwPageName

The name of the page on the pageConfig that returns the custom report XML for grids in documents.
Used to generate the URL for the custom report XML for grids in documents Allowed values: String value that corresponds to a page name on the pageConfig.

public FormalParameter useAbsoluteURLs

Whether to use an absolute path on the CustomURL FlashVar

Public Constructors

public AbstractReportDataVisualizationTransform ()

Public Methods

public Map getAttributesBone ()

public String getDescription ()

public String getMojoWidgetId ()

public Class getSupportedBeanType ()

return the bean type supported by this transform.

Returns
  • the bean type

public 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 void initializeProperties ()

Extends initializeProperties by invoking initializeTranformContext

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 renderCenter (MarkupOutput out, ReportBean rb)

public void renderData (MarkupOutput out, ReportBean rb)

public void renderEmptyCase (MarkupOutput out, ReportBean rb)

public void renderLayout (MarkupOutput out, ReportBean rb)

public abstract void renderVisualization (MarkupOutput out)

Renders the visualization's content (i.e. the embedded flash object)

Parameters
out The Markup output

public void setMojoWidgetId (String mojoWidgetId)

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 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 ParameterBuilder getBaseURL ()

Returns a ParameterBuilder object that contains a base URL.
This object is initialized with the TargetBase, TargetPrefix and contains the session manager state which is used in URLs as argument WebSessionManagerState to restore the session.

Returns

protected ParameterBuilder getBaseURL (boolean useAbsoluteURL)

Returns a ParameterBuilder object that contains a base URL.
This object is initialized with the TargetBase, TargetPrefix and contains the session manager state which is used in URLs as argument WebSessionManagerState to restore the session.

Parameters
useAbsoluteURL whether to use an absolute URL
Returns

protected JsonGenerator getControlLinksJson ()

protected String getCustomReportXML ()

Returns
  • the report XML specified by the formal parameter "reportXMLStyle"

protected String getGridKeys ()

protected RWBean getRWBean ()

protected String getResultFlags (int viewMode)

protected JsonGenerator getSelectionDataJSON ()

Returns
  • a JSON object that contains a list of the row headers on the grid, it has the following format:
    { "Region": { "South": { "code": "microstrategy.bone..." "metrics": "$ 3,075,727" } "Central":... } "Year": {...} } This JSON object only contains information about the first row header and first metric on the report.

protected ParameterBuilder getTaskBaseURL (String contentType)

Returns a ParameterBuilder object that contains a base URL which can be used to invoke a Task on the Tasks infrastructure.
This object is initialized with the TargetBase, TargetPrefix and contains the session manager state which is used in URLs as argument WebSessionManagerState to restore the session.

Parameters
contentType the type of data expected (xml, json, html)
Returns
  • a ParameterBuilder object that contains a base URL which can be used to invoke a Task on the Tasks infrastructure.

protected ParameterBuilder getTaskBaseURL ()

Returns a ParameterBuilder object that contains a base URL which can be used to invoke a Task on the Tasks infrastructure to get XML content.
This object is initialized with the TargetBase, TargetPrefix and contains the session manager state which is used in URLs as argument WebSessionManagerState to restore the session.

Returns
  • a ParameterBuilder object that contains a base URL which can be used to invoke a Task on the Tasks infrastructure.

protected String getTaskURLForCustomReportXML ()

Returns a URL that can be used to obtain the report XML of the current report being transformed.
The URL uses the Tasks infrastructure

Returns
  • a URL that can be used to obtain the report XML of the current report being transformed.

protected String getTaskURLForReportContent (String contentType)

Returns a URL that can be used to obtain the report data of the current report being transformed.
The URL uses the Tasks infrastructure

Parameters
contentType the type of data expected (xml, json, html)
Returns
  • a URL that can be used to obtain the report data of the current report being transformed.

protected ParameterBuilder getTaskURLForReportData (String contentType)

Returns a URL that can be used to obtain the report data of the current report being transformed.
The URL uses the Tasks infrastructure

Parameters
contentType the type of data expected (xml, json, html)
Returns
  • a URL that can be used to obtain the report data of the current report being transformed.

protected String getURLForCustomReportXML ()

Returns a URL that can be used to obtain the report XML of the current report being transformed.
To generate the XML it uses the style specified by "reportXMLStyle"

Returns
  • a URL that can be used to obtain the report XML of the current report being transformed.

protected WebReportGrid getWebReportGrid ()

protected boolean isDesignMode ()

This methods allows the transform to identify if concrete subclasses are designed to work in design mode, or in execute mode.

Returns
  • false by default. Any inherting class should override to implement its own version.

protected boolean isGraphTransform ()

protected boolean isGridTransform ()

protected void setBoneProperties (JsonGenerator boneProps)

Add the "selectionData" property on the grid bone.

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