Class MobileGraphXMLTransform
- 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
-
- All Implemented Interfaces:
Transform
public class MobileGraphXMLTransform extends AbstractReportXMLTransform
MobileGraphXMLTransform is a report transform that generates a simplified version of the report xml.
-
-
Field Summary
Fields Modifier and Type Field Description FormalParameter
_pageByXml
Formal parameter that contains the page by information in the form of an XML.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.FormalParameter
_renderPagebyInfo
Whether to render page by info
Default value: trueFormalParameter
_renderReportDataListNode
Whether to render the root node (report_data_list)
Default value: trueFormalParameter
_renderStyles
Whether to render styles
Default value: trueFormalParameter
_renderSubtotals
static java.lang.String
FP_INCLUDE_MD_PROPERTIES
static java.lang.String
FP_PAGE_BY_XML
static java.lang.String
FP_RENDER_PAGEBY_INFO
static java.lang.String
FP_RENDER_STYLES
-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractBasicReportTransform
_bean, _rb, _rwb, _vb
-
-
Constructor Summary
Constructors Constructor Description MobileGraphXMLTransform()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addAttributeFormsToObjectsTag(Tag parentTag, WebTemplateAttribute attTemplateUnit, com.microstrategy.web.app.transforms.AbstractSimplifiedReportXMLTransform.RefIDCounter rfdCounter)
protected Tag
addAttributeFormToObjectsTag(Tag parentTag, java.lang.String id, java.lang.String name, int rfd, java.lang.String parentObjectId, int baseFormType, boolean isIDForm)
protected void
addVisPropsProperty(Tag prsTag)
java.lang.String
getDescription()
Returns a textual description of the transform.protected java.lang.String
getDescriptor(int key)
Get the descriptor for the given key.protected java.lang.String
getDescriptor(java.lang.String key)
Get the descriptor for the given key.protected int
getPropSetId(java.lang.String pSetName)
TagsFactory
getTagsFactory()
Convenience method for obtaining an instance of theTagsFactory
class.protected void
renderData(Tag reportDataTag)
protected void
renderDefinition(Tag reportDataTag)
protected void
renderProperties(Tag reportDataTag)
void
renderXml(MarkupOutput out)
Renders the report's XML.static boolean
validateTemplate(WebTemplate template, ViewBean vb, AppContext appContext)
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractReportXMLTransform
encodeXMLText, getWebTemplate, initGridData, render
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractBasicReportTransform
addFormalParameter, getElemsMapHelper, getGraphBean, getGridData, getHyperLinkHelper, getReportBean, getRWBean, getSupportedBeanType, getViewBean, getWebGridData, getWebReportGrid, initBeans, isDesignMode, isFeatureAvailable, isReport, isTrue, supports, transform
-
Methods inherited from class com.microstrategy.web.transform.AbstractTransform
addFormalParam, canTransform, getEvents, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports
-
-
-
-
Field Detail
-
_renderReportDataListNode
public FormalParameter _renderReportDataListNode
Whether to render the root node (report_data_list)
Default value: true
-
_renderMetricNumberFormattingOnly
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
- Since:
- MicroStrategy Web 8.1.0
-
_renderSubtotals
public FormalParameter _renderSubtotals
- Since:
- MicroStrategy Web 8.1.1
-
_renderPagebyInfo
public FormalParameter _renderPagebyInfo
Whether to render page by info
Default value: true
-
FP_RENDER_PAGEBY_INFO
public static final java.lang.String FP_RENDER_PAGEBY_INFO
- See Also:
- Constant Field Values
-
_renderStyles
public FormalParameter _renderStyles
Whether to render styles
Default value: true
-
FP_RENDER_STYLES
public static final java.lang.String FP_RENDER_STYLES
- See Also:
- Constant Field Values
-
_pageByXml
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>
-
FP_PAGE_BY_XML
public static final java.lang.String FP_PAGE_BY_XML
- See Also:
- Constant Field Values
-
FP_INCLUDE_MD_PROPERTIES
public static final java.lang.String FP_INCLUDE_MD_PROPERTIES
- See Also:
- Constant Field Values
-
-
Method Detail
-
renderXml
public void renderXml(MarkupOutput out)
Description copied from class:AbstractReportXMLTransform
Renders the report's XML.- Specified by:
renderXml
in classAbstractReportXMLTransform
- Since:
- MicroStrategy Web 8.1.1
-
validateTemplate
public static boolean validateTemplate(WebTemplate template, ViewBean vb, AppContext appContext) throws MSTRCheckedException
- Throws:
MSTRCheckedException
-
getDescriptor
protected java.lang.String getDescriptor(int key)
Get the descriptor for the given key.
By default this method appends the prefix
If a descriptor is not found for the given key it returns [na]mstrWeb.
to the key to find the resources in the Messages bundle. To find a descriptor for a specific key you might usegetDescriptor(String)
.- Parameters:
key
- input key as anint
, for example,1
- Returns:
- descriptor as a
String
corresponding to the key sent in as parameter, for example,
Home
-
getDescriptor
protected java.lang.String getDescriptor(java.lang.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 aString
, for example,mstrWeb.1
*- Returns:
- descriptor as a
String
corresponding to the key sent in as parameter, for example,
Home
. - Since:
- MicroStrategy Web 8.0.0
-
renderDefinition
protected void renderDefinition(Tag reportDataTag) throws WebObjectsException, WebBeanException
- Throws:
WebObjectsException
WebBeanException
-
renderProperties
protected void renderProperties(Tag reportDataTag)
-
addVisPropsProperty
protected void addVisPropsProperty(Tag prsTag)
-
addAttributeFormsToObjectsTag
protected void addAttributeFormsToObjectsTag(Tag parentTag, WebTemplateAttribute attTemplateUnit, com.microstrategy.web.app.transforms.AbstractSimplifiedReportXMLTransform.RefIDCounter rfdCounter)
-
renderData
protected void renderData(Tag reportDataTag) throws WebObjectsException, WebBeanException
- Throws:
WebObjectsException
WebBeanException
-
getDescription
public java.lang.String getDescription()
Description copied from interface:Transform
Returns a textual description of the transform.- Returns:
- The textual description of the transform.
-
addAttributeFormToObjectsTag
protected Tag addAttributeFormToObjectsTag(Tag parentTag, java.lang.String id, java.lang.String name, int rfd, java.lang.String parentObjectId, int baseFormType, boolean isIDForm)
-
getTagsFactory
public TagsFactory getTagsFactory()
Convenience method for obtaining an instance of theTagsFactory
class.- Returns:
- a
TagsFactory
instance to use for generatingTag
instances
-
getPropSetId
protected int getPropSetId(java.lang.String pSetName)
-
-