Package com.microstrategy.web.app.transforms

Class IPhoneReportXMLTransform

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

All Implemented Interfaces:

Transform

public class IPhoneReportXMLTransform
extends ReportXMLTransform

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	_renderIncrementalFetchInfo	Whether to render incremental fetch info Default value: false
protected java.lang.String	COL_HEADER_CLASS
protected FormalParameter	drillRetainParent	This is the FP which tells whether to retain the parent while drilling.
protected FormalParameter	drillRetainThresholds	This is the FP which tells whether to retain the thresholds while drilling.
static java.lang.String	FP_INCLUDE_MD_PROPERTIES
static java.lang.String	FP_PAGE_BY_XML
static java.lang.String	FP_RENDER_IF_INFO
protected java.lang.String	IPHONE_METRIC_VALUE_CLASS
protected java.lang.String	ROW_HEADER_CLASS

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
IPhoneReportXMLTransform()

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 void	addVisPropsProperty(Tag prsTag)
protected void	generateDrillInfo(Tag tag, WebHeader header)
protected void	generateHyperLinkInfo(Tag tag, WebHeader header)
protected AbstractReportGridCellHeader.AxisDepth	getAxisDepth(WebHeader header)
protected java.lang.String	getParentElementIndex(WebHeader header)
protected int	getPropSetId(java.lang.String pSetName)
TagsFactory	getTagsFactory()	Convenience method for obtaining an instance of the TagsFactory class.
protected void	renderDefinition(Tag reportDataTag)
protected Tag	renderHeaderValue(Tag rowTag, WebHeader header, java.lang.String currentElementID, java.lang.String styleID)
protected void	renderProperties(Tag reportDataTag)
protected void	renderRawData(Tag reportDataTag)
protected void	renderValue(Tag rowTag, WebRowValue metricValue)
protected Tag	renderValue(Tag headersTag, java.lang.String id, java.lang.String value, java.lang.String styleID, int semantics, java.lang.String replaceValue)

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

areMetricsOnPages, doRenderSecondaryDataProviders, getDescription, getDescriptor, getDescriptor, getListOfMetricHeaders, getValidationMessage, isSubtotal, isTabular, isValidTemplate, renderHeaders, renderValue, renderValues, renderXml

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

IPHONE_METRIC_VALUE_CLASS

protected final java.lang.String IPHONE_METRIC_VALUE_CLASS

See Also:

Constant Field Values

ROW_HEADER_CLASS

protected final java.lang.String ROW_HEADER_CLASS

See Also:

Constant Field Values

COL_HEADER_CLASS

protected final java.lang.String COL_HEADER_CLASS

See Also:

Constant Field Values

drillRetainParent

protected FormalParameter drillRetainParent

This is the FP which tells whether to retain the parent while drilling.
If a value is specified here, then the drill Preference on the preference page for the same is ignored.
Allowed Values:
PreferencesDrillTransform.DRILL_OPTION_DRILL_ANYWHERE = "1";
PreferencesDrillTransform.DRILL_OPTION_DRILL_HYPERLINKS = "2";
PreferencesDrillTransform.DRILL_OPTION_SIMPLE_DRILL = "3";
PreferencesDrillTransform.DRILL_OPTION_NO_DRILL = "4";
PreferencesDrillTransform.DRILL_OPTION_REPORT_DEFINITION = "5";

drillRetainThresholds

protected FormalParameter drillRetainThresholds

This is the FP which tells whether to retain the thresholds while drilling. If a value is specified here, then the drill Preference on the preference page for the same is ignored. This value can be 1(to retain), 0(to not retain) or 2(to use the drill path for the value). If blank the drill preference is used. Allowed Values:
PreferencesDrillTransform.DRILL_OPTION_RETAIN_THRESHOLD_YES = "1";
PreferencesDrillTransform.DRILL_OPTION_RETAIN_THRESHOLD_NO = "2";
PreferencesDrillTransform.DRILL_OPTION_RETAIN_THRESHOLD_REPORT_DEFINITION = "3";

Since:

MicroStrategy Web 7.5.4

_renderIncrementalFetchInfo

public FormalParameter _renderIncrementalFetchInfo

Whether to render incremental fetch info
Default value: false

FP_RENDER_IF_INFO

public static final java.lang.String FP_RENDER_IF_INFO

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

IPhoneReportXMLTransform

public IPhoneReportXMLTransform()

Method Detail

renderProperties

protected void renderProperties(Tag reportDataTag)

Overrides:

renderProperties in class ReportXMLTransform

addVisPropsProperty

protected void addVisPropsProperty(Tag prsTag)

Overrides:

addVisPropsProperty in class ReportXMLTransform

renderDefinition

protected void renderDefinition(Tag reportDataTag)
                         throws WebObjectsException,
                                WebBeanException

Overrides:

renderDefinition in class ReportXMLTransform

Throws:

WebObjectsException

WebBeanException

renderHeaderValue

protected Tag renderHeaderValue(Tag rowTag,
                                WebHeader header,
                                java.lang.String currentElementID,
                                java.lang.String styleID)

Overrides:

renderHeaderValue in class ReportXMLTransform

generateDrillInfo

protected void generateDrillInfo(Tag tag,
                                 WebHeader header)

getAxisDepth

protected AbstractReportGridCellHeader.AxisDepth getAxisDepth(WebHeader header)

generateHyperLinkInfo

protected void generateHyperLinkInfo(Tag tag,
                                     WebHeader header)

getParentElementIndex

protected java.lang.String getParentElementIndex(WebHeader header)

renderValue

protected Tag renderValue(Tag headersTag,
                          java.lang.String id,
                          java.lang.String value,
                          java.lang.String styleID,
                          int semantics,
                          java.lang.String replaceValue)

Overrides:

renderValue in class ReportXMLTransform

renderValue

protected void renderValue(Tag rowTag,
                           WebRowValue metricValue)

Overrides:

renderValue in class ReportXMLTransform

renderRawData

protected void renderRawData(Tag reportDataTag)
                      throws WebObjectsException,
                             WebBeanException

Overrides:

renderRawData in class ReportXMLTransform

Throws:

WebObjectsException

WebBeanException

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)