Package com.microstrategy.web.app.transforms

Class MobilePreambleXMLTransform

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.MobilePreambleXMLTransform

All Implemented Interfaces:

Transform

public class MobilePreambleXMLTransform
extends AbstractReportXMLTransform

Since:

MicroStrategy Web 8.1.2

Field Summary

Fields

Modifier and Type	Field	Description
FormalParameter	_compressionVersion
FormalParameter	_pageByXml	Formal parameter that contains the page by information in the form of an XML.
static java.lang.String	FP_COMPRESSION_VERSION
static java.lang.String	FP_INCLUDE_MD_PROPERTIES
static java.lang.String	FP_PAGE_BY_XML
static int	GZIP_COMPRESSION
static int	NO_COMPRESSION

Fields inherited from class com.microstrategy.web.app.transforms.AbstractBasicReportTransform

_bean, _rb, _rwb, _vb

Constructor Summary

Constructors

Constructor	Description
MobilePreambleXMLTransform()

Method Summary

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)
java.lang.String	getDescription()	Returns a textual description of the transform.
protected int	getPropSetId(java.lang.String pSetName)
TagsFactory	getTagsFactory()	Convenience method for obtaining an instance of the TagsFactory class.
void	renderXml(MarkupOutput out)	Renders the report's XML.

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_compressionVersion

public FormalParameter _compressionVersion

FP_COMPRESSION_VERSION

public static final java.lang.String FP_COMPRESSION_VERSION

See Also:

Constant Field Values

NO_COMPRESSION

public static final int NO_COMPRESSION

See Also:

Constant Field Values

GZIP_COMPRESSION

public static final int GZIP_COMPRESSION

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

Constructor Detail

MobilePreambleXMLTransform

public MobilePreambleXMLTransform()

Method Detail

renderXml

public void renderXml(MarkupOutput out)

Description copied from class: AbstractReportXMLTransform

Renders the report's XML.

Specified by:

renderXml in class AbstractReportXMLTransform

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.

addAttributeFormsToObjectsTag

protected void addAttributeFormsToObjectsTag(Tag parentTag,
                                             WebTemplateAttribute attTemplateUnit,
                                             com.microstrategy.web.app.transforms.AbstractSimplifiedReportXMLTransform.RefIDCounter rfdCounter)

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 the TagsFactory class.

Returns:

a TagsFactory instance to use for generating Tag instances

getPropSetId

protected int getPropSetId(java.lang.String pSetName)