Package com.microstrategy.web.app.transforms

Class IPhoneReportMapXMLTransform

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

com.microstrategy.web.app.transforms.IPhoneReportDataXMLTransform

com.microstrategy.web.app.transforms.IPhoneReportMapXMLTransform

All Implemented Interfaces:

Transform

public class IPhoneReportMapXMLTransform
extends IPhoneReportDataXMLTransform

Field Summary

Fields

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

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

_drillRetainParent, _drillRetainThresholds, _numberSeparator, _renderDateFormats, _renderDrillingInfo, _renderIncrementalFetchInfo, _renderMetricValuesFormatted, _renderMetricValuesUnformatted, DRILLING_TYPE_LINKED, DRILLING_TYPE_NO_DRILLING, DRILLING_TYPE_REGULAR, FP_NUMBER_SEPARATOR, FP_RENDER_DATE_FORMATS, FP_RENDER_DRILLING_INFO, FP_RENDER_IF_INFO, FP_RENDER_METRIC_VALUES_FORMATTED, FP_RENDER_METRIC_VALUES_UNFORMATTED, XML_ATT_NAME_NUMBER_SEPARATOR, XML_ATT_NAME_SEPARATOR

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

_errorMessage, _excludeVisualizationProperties, _includeMobileProperties, _optimizeMobileXML, _renderMetricNumberFormattingOnly, _renderPageByAxis, _renderPagebyInfo, _renderReportDataListNode, _renderStyles, _renderSubtotals, _rowCount, _secondaryProviderStyle, FP_EXCLUDE_VISUALIZATION_PROPERTIES, FP_INCLUDE_MOBILE_PROPERTIES, FP_OPTIMIZE_MOBILE_XML, FP_RENDER_PAGEBY_AXISE, FP_RENDER_PAGEBY_INFO, FP_RENDER_STYLES, FP_SECONDARY_PROVIDER_STYLE

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

_bean, _rb, _rwb, _vb

Constructor Summary

Constructors

Constructor	Description
IPhoneReportMapXMLTransform()

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)
protected int	getPropSetId(java.lang.String pSetName)
TagsFactory	getTagsFactory()	Convenience method for obtaining an instance of the TagsFactory class.
protected java.lang.String	getValidationMessage()
protected boolean	isValidTemplate()
static boolean	validateTemplate(WebTemplate template, AppContext appContext)
static boolean	validateTemplate(WebTemplate template, ViewBean vb, AppContext appContext)	Deprecated. use validateTemplate(WebTemplate, AppContext)

Methods inherited from class com.microstrategy.web.app.transforms.IPhoneReportDataXMLTransform

addVisPropsProperty, doRenderSecondaryDataProviders, getDescription, hasAtLeastOneAttributeOnRows, initGridData, renderDefinition, renderDrillInformation, renderHeaders, renderProperties, renderRawData, renderValues, transform

Methods inherited from class com.microstrategy.web.app.transforms.ReportXMLTransform

areMetricsOnPages, getDescriptor, getDescriptor, getListOfMetricHeaders, isSubtotal, isTabular, renderHeaderValue, renderValue, renderValue, renderValue, renderXml

Methods inherited from class com.microstrategy.web.app.transforms.AbstractReportXMLTransform

encodeXMLText, getWebTemplate, 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

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

_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

IPhoneReportMapXMLTransform

public IPhoneReportMapXMLTransform()

Method Detail

getValidationMessage

protected java.lang.String getValidationMessage()

Overrides:

getValidationMessage in class ReportXMLTransform

isValidTemplate

protected boolean isValidTemplate()
                           throws MSTRCheckedException

Overrides:

isValidTemplate in class IPhoneReportDataXMLTransform

Throws:

MSTRCheckedException

validateTemplate

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

Deprecated.

use validateTemplate(WebTemplate, AppContext)

Throws:

MSTRCheckedException

validateTemplate

public static boolean validateTemplate(WebTemplate template,
                                       AppContext appContext)
                                throws MSTRCheckedException

Throws:

MSTRCheckedException

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)