public class

MobileGraphXMLTransform

extends AbstractReportXMLTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.app.transforms.AbstractBasicReportTransform
       ↳ com.microstrategy.web.app.transforms.AbstractReportXMLTransform
         ↳ com.microstrategy.web.app.transforms.MobileGraphXMLTransform

Class Overview

MobileGraphXMLTransform is a report transform that generates a simplified version of the report xml.

Summary

Constants
String FP_INCLUDE_MD_PROPERTIES
String FP_PAGE_BY_XML
String FP_RENDER_PAGEBY_INFO
String FP_RENDER_STYLES
Fields
public FormalParameter _pageByXml Formal parameter that contains the page by information in the form of an XML.
public FormalParameter _renderMetricNumberFormattingOnly Formal parameter that determines whether only the metric values have 'style' associated with them and only the FormattingNumber property set is included in the 'styles' section for these metric styles.
public FormalParameter _renderPagebyInfo Whether to render page by info
Default value: true
public FormalParameter _renderReportDataListNode Whether to render the root node (report_data_list)
Default value: true
public FormalParameter _renderStyles Whether to render styles
Default value: true
public FormalParameter _renderSubtotals
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractBasicReportTransform
Public Constructors
MobileGraphXMLTransform()
Public Methods
String getDescription()
TagsFactory getTagsFactory()
Convenience method for obtaining an instance of the TagsFactory class.
void renderXml(MarkupOutput out)
Renders the report's XML.
static boolean validateTemplate(WebTemplate template, ViewBean vb, AppContext appContext)
Protected Methods
Tag addAttributeFormToObjectsTag(Tag parentTag, String id, String name, int rfd, String parentObjectId, int baseFormType, boolean isIDForm)
void addAttributeFormsToObjectsTag(Tag parentTag, WebTemplateAttribute attTemplateUnit, AbstractSimplifiedReportXMLTransform.RefIDCounter rfdCounter)
void addVisPropsProperty(Tag prsTag)
String getDescriptor(int key)

Get the descriptor for the given key.

String getDescriptor(String key)

Get the descriptor for the given key.

int getPropSetId(String pSetName)
void renderData(Tag reportDataTag)
void renderDefinition(Tag reportDataTag)
void renderProperties(Tag reportDataTag)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractReportXMLTransform
From class com.microstrategy.web.app.transforms.AbstractBasicReportTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_INCLUDE_MD_PROPERTIES

Constant Value: "includeMDProperties"

public static final String FP_PAGE_BY_XML

Constant Value: "pageByXML"

public static final String FP_RENDER_PAGEBY_INFO

Constant Value: "renderPageByInfo"

public static final String FP_RENDER_STYLES

Constant Value: "renderStyles"

Fields

public FormalParameter _pageByXml

Formal parameter that contains the page by information in the form of an XML. When this formal parameter is set, this information is also included in the output of the transform. Also, the rows are re-ordered such that the rows corresponding to the current page by elements are rendered first and then the rest of the rows The XML structure is as follows
<pageby cn="2">
  <pageByUnit id="" unitName="" type="" pos="1" ceid="" cename=""/>
  <pageByUnit id="" unitName="" type="" pos="1" ceid="" cename=""/>
  ...
</pageby>

public FormalParameter _renderMetricNumberFormattingOnly

Formal parameter that determines whether only the metric values have 'style' associated with them and only the FormattingNumber property set is included in the 'styles' section for these metric styles. Default value : true

public FormalParameter _renderPagebyInfo

Whether to render page by info
Default value: true

public FormalParameter _renderReportDataListNode

Whether to render the root node (report_data_list)
Default value: true

public FormalParameter _renderStyles

Whether to render styles
Default value: true

public FormalParameter _renderSubtotals

Public Constructors

public MobileGraphXMLTransform ()

Public Methods

public String getDescription ()

public TagsFactory getTagsFactory ()

Convenience method for obtaining an instance of the TagsFactory class.

Returns
  • a TagsFactory instance to use for generating Tag instances

public void renderXml (MarkupOutput out)

Renders the report's XML.

public static boolean validateTemplate (WebTemplate template, ViewBean vb, AppContext appContext)

Protected Methods

protected Tag addAttributeFormToObjectsTag (Tag parentTag, String id, String name, int rfd, String parentObjectId, int baseFormType, boolean isIDForm)

protected void addAttributeFormsToObjectsTag (Tag parentTag, WebTemplateAttribute attTemplateUnit, AbstractSimplifiedReportXMLTransform.RefIDCounter rfdCounter)

protected void addVisPropsProperty (Tag prsTag)

protected String getDescriptor (int key)

Get the descriptor for the given key.

By default this method appends the prefix mstrWeb. to the key to find the resources in the Messages bundle. To find a descriptor for a specific key you might use getDescriptor(String).

If a descriptor is not found for the given key it returns [na]

Parameters
key input key as an int, for example, 1
Returns
  • descriptor as a String corresponding to the key sent in as parameter, for example, Home

protected String getDescriptor (String key)

Get the descriptor for the given key.

The key is searched exactly as given in the Messages bundle.

If a descriptor is not found for the given key it returns [na]

Parameters
key input key as a String, for example, mstrWeb.1 *
Returns
  • descriptor as a String corresponding to the key sent in as parameter, for example, Home.

protected int getPropSetId (String pSetName)

protected void renderData (Tag reportDataTag)

protected void renderDefinition (Tag reportDataTag)

protected void renderProperties (Tag reportDataTag)