public abstract class

AbstractRWDataVisualizationTransform

extends RWLayoutTransform
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.AbstractRWTransform
             ↳ com.microstrategy.web.app.transforms.RWLayoutTransform
               ↳ com.microstrategy.web.app.transforms.AbstractRWDataVisualizationTransform
Known Direct Subclasses

Class Overview

Transform used to render a visualization on the document. 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.RWLayoutTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter documentXMLPageName The name of the page on the pageConfig that returns the custom document XML.
public FormalParameter documentXMLStyle The name of the style to use to generate the custom document XML Allowed values: String value that corresponds to a style on the styleCatalog.
public FormalParameter useAbsoluteURLs Whether to use an absolute path on the CustomURL FlashVar
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.RWLayoutTransform
From class com.microstrategy.web.app.transforms.AbstractRWTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractRWDataVisualizationTransform()
Public Methods
String getDescription()
Display's the description of this transform for StyleCatalog
void initializeTransform(Transformable data)
Extends initializeTransform(com.microstrategy.web.beans.Transformable) by obtaining a reference to the data
void renderGridCss(MarkupOutput out)
abstract void renderVisualization(MarkupOutput out)
Renders the visualization's content (i.e.
void startIteration(RWBeanVisitor visitor, MarkupOutput out, String key, boolean definitionOnly)
Starts iterating the data, by invoking rwi.iterate();
void startIteration(RWBeanVisitor2 visitor, MarkupOutput out, String key, boolean definitionOnly)
Starts iterating the data, by invoking rwi.iterate();
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 which can be used to access the Web application.
String getCustomDocumentXML()
ParameterBuilder getTaskBaseURL()
Returns a ParameterBuilder object that contains a base URL which can be used to invoke a Task on the Tasks infrastructure.
String getTaskURLForCustomDocumentXML()
Returns a URL that can be used to obtain the document XML of the current report being transformed.
String getURLForCustomDocumentXML()
Returns a URL that can be used to obtain the document XML of the current report being transformed.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.RWLayoutTransform
From class com.microstrategy.web.app.transforms.AbstractRWTransform
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.beans.RWBeanVisitor
From interface com.microstrategy.web.beans.RWBeanVisitor2
From interface com.microstrategy.web.transform.Transform

Fields

public FormalParameter documentXMLPageName

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

public FormalParameter documentXMLStyle

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

public FormalParameter useAbsoluteURLs

Whether to use an absolute path on the CustomURL FlashVar

Public Constructors

public AbstractRWDataVisualizationTransform ()

Public Methods

public String getDescription ()

Display's the description of this transform for StyleCatalog

Returns
  • This transform displays the data of a Report Writing Document.

public void initializeTransform (Transformable data)

Extends initializeTransform(com.microstrategy.web.beans.Transformable) by obtaining a reference to the data

Parameters
data The bean to transform.

public void renderGridCss (MarkupOutput out)

public abstract void renderVisualization (MarkupOutput out)

Renders the visualization's content (i.e. the embeded flash oject)

Parameters
out The markup output

public void startIteration (RWBeanVisitor visitor, MarkupOutput out, String key, boolean definitionOnly)

Starts iterating the data, by invoking rwi.iterate();

public void startIteration (RWBeanVisitor2 visitor, MarkupOutput out, String key, boolean definitionOnly)

Starts iterating the data, by invoking rwi.iterate();

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 which can be used to access the Web application.
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
  • a ParameterBuilder object that contains a base URL which can be used to access the Web application.

protected String getCustomDocumentXML ()

Returns
  • the document XML specified by the formal parameter "documentXMLStyle"

protected ParameterBuilder getTaskBaseURL ()

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.

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

protected String getTaskURLForCustomDocumentXML ()

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

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

protected String getURLForCustomDocumentXML ()

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

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