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

All Implemented Interfaces:

Transform

Direct Known Subclasses:

IPhoneReportInteractiveGridXMLTransform, IPhoneReportMapXMLTransform
```
public class IPhoneReportDataXMLTransform
extends ReportXMLTransform
```

Field Summary

Fields
Modifier and Type	Field	Description
`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.
`FormalParameter`	`_numberSeparator`	The separator used on the value("v") attribute of the "cols", "rows" and "values" XML nodes Default value: ^
`FormalParameter`	`_pageByXml`	Formal parameter that contains the page by information in the form of an XML.
`FormalParameter`	`_renderDateFormats`	Whether to render date formats (fmts node) Default value: false
`FormalParameter`	`_renderDrillingInfo`	Whether to render drilling info Default value: false
`FormalParameter`	`_renderIncrementalFetchInfo`	Whether to render incremental fetch info Default value: false
`FormalParameter`	`_renderMetricValuesFormatted`	Whether to render the metric values formatted on the "fv" XML attribute (i.e.
`FormalParameter`	`_renderMetricValuesUnformatted`	Whether to render the metric values unformatted on the "v" XML attribute (i.e.
`static int`	`DRILLING_TYPE_LINKED`
`static int`	`DRILLING_TYPE_NO_DRILLING`
`static int`	`DRILLING_TYPE_REGULAR`
`static java.lang.String`	`FP_INCLUDE_MD_PROPERTIES`
`static java.lang.String`	`FP_NUMBER_SEPARATOR`
`static java.lang.String`	`FP_PAGE_BY_XML`
`static java.lang.String`	`FP_RENDER_DATE_FORMATS`
`static java.lang.String`	`FP_RENDER_DRILLING_INFO`
`static java.lang.String`	`FP_RENDER_IF_INFO`
`static java.lang.String`	`FP_RENDER_METRIC_VALUES_FORMATTED`
`static java.lang.String`	`FP_RENDER_METRIC_VALUES_UNFORMATTED`
`static java.lang.String`	`XML_ATT_NAME_NUMBER_SEPARATOR`
`static java.lang.String`	`XML_ATT_NAME_SEPARATOR`

Fields inherited from class com.microstrategy.web.app.transforms.AbstractBasicReportTransform
_bean, _rb, _rwb, _vb

Constructor Summary

Constructors
Constructor Description

IPhoneReportDataXMLTransform()

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)`
`protected boolean`	`doRenderSecondaryDataProviders()`
`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.
`protected static boolean`	`hasAtLeastOneAttributeOnRows(WebTemplate template)`
`protected void`	`initGridData()`
`protected boolean`	`isValidTemplate()`
`protected void`	`renderDefinition(Tag reportDataTag)`
`protected void`	`renderDrillInformation(Tag reportDataTag)`
`protected void`	`renderHeaders(Tag tag)`
`protected void`	`renderProperties(Tag reportDataTag)`
`protected void`	`renderRawData(Tag reportDataTag)`
`protected void`	`renderValues(Tag reportDataTag)`
`void`	`transform(Transformable data, MarkupOutput out)`	Transforms the data object and appends result to the transOut.
`static boolean`	`validateTemplate(WebTemplate template, ViewBean vb, AppContext appContext)`

Methods inherited from class com.microstrategy.web.app.transforms.ReportXMLTransform
areMetricsOnPages, getDescriptor, getDescriptor, getListOfMetricHeaders, getValidationMessage, 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
  - DRILLING_TYPE_NO_DRILLING
```
public static final int DRILLING_TYPE_NO_DRILLING
```
    See Also:
    
    Constant Field Values
  - DRILLING_TYPE_REGULAR
```
public static final int DRILLING_TYPE_REGULAR
```
    See Also:
    
    Constant Field Values
  - DRILLING_TYPE_LINKED
```
public static final int DRILLING_TYPE_LINKED
```
    See Also:
    
    Constant Field Values
  - XML_ATT_NAME_NUMBER_SEPARATOR
```
public static final java.lang.String XML_ATT_NAME_NUMBER_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - XML_ATT_NAME_SEPARATOR
```
public static final java.lang.String XML_ATT_NAME_SEPARATOR
```
    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
  - _renderDrillingInfo
```
public FormalParameter _renderDrillingInfo
```
    Whether to render drilling info
    Default value: false
  - FP_RENDER_DRILLING_INFO
```
public static final java.lang.String FP_RENDER_DRILLING_INFO
```
    See Also:
    
    Constant Field Values
  - _renderDateFormats
```
public FormalParameter _renderDateFormats
```
    Whether to render date formats (fmts node)
    Default value: false
  - FP_RENDER_DATE_FORMATS
```
public static final java.lang.String FP_RENDER_DATE_FORMATS
```
    See Also:
    
    Constant Field Values
  - _renderMetricValuesUnformatted
```
public FormalParameter _renderMetricValuesUnformatted
```
    Whether to render the metric values unformatted on the "v" XML attribute (i.e. "1000")
    Default value: false
  - FP_RENDER_METRIC_VALUES_UNFORMATTED
```
public static final java.lang.String FP_RENDER_METRIC_VALUES_UNFORMATTED
```
    See Also:
    
    Constant Field Values
  - _renderMetricValuesFormatted
```
public FormalParameter _renderMetricValuesFormatted
```
    Whether to render the metric values formatted on the "fv" XML attribute (i.e. "$1,000.00")
    Default value: false
  - FP_RENDER_METRIC_VALUES_FORMATTED
```
public static final java.lang.String FP_RENDER_METRIC_VALUES_FORMATTED
```
    See Also:
    
    Constant Field Values
  - _numberSeparator
```
public FormalParameter _numberSeparator
```
    The separator used on the value("v") attribute of the "cols", "rows" and "values" XML nodes Default value: ^
  - FP_NUMBER_SEPARATOR
```
public static final java.lang.String FP_NUMBER_SEPARATOR
```
    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
  - IPhoneReportDataXMLTransform
```
public IPhoneReportDataXMLTransform()
```
- Method Detail
  - transform
```
public void transform(Transformable data,
                      MarkupOutput out)
```
    Description copied from interface: Transform
    
    Transforms the data object and appends result to the transOut.
    
    Specified by:
    
    transform in interface Transform
    
    Overrides:
    
    transform in class AbstractBasicReportTransform
    
    Parameters:
    
    data - an object to transform. It must be of proper type supported by the concrete transform this method called on, or ClassCastExcetption will be thrown
    
    out - the MarkupOutput object where the transform result will be added.
  - doRenderSecondaryDataProviders
```
protected boolean doRenderSecondaryDataProviders()
```
    Overrides:
    
    doRenderSecondaryDataProviders in class ReportXMLTransform
  - initGridData
```
protected void initGridData()
                     throws WebObjectsException,
                            WebBeanException
```
    Overrides:
    
    initGridData in class AbstractReportXMLTransform
    
    Throws:
    
    WebObjectsException
    
    WebBeanException
  - renderDefinition
```
protected void renderDefinition(Tag reportDataTag)
                         throws WebObjectsException,
                                WebBeanException
```
    Overrides:
    
    renderDefinition in class ReportXMLTransform
    
    Throws:
    
    WebObjectsException
    
    WebBeanException
  - renderDrillInformation
```
protected void renderDrillInformation(Tag reportDataTag)
```
  - renderProperties
```
protected void renderProperties(Tag reportDataTag)
```
    Overrides:
    
    renderProperties in class ReportXMLTransform
  - addVisPropsProperty
```
protected void addVisPropsProperty(Tag prsTag)
```
    Overrides:
    
    addVisPropsProperty in class ReportXMLTransform
  - renderRawData
```
protected void renderRawData(Tag reportDataTag)
                      throws WebObjectsException,
                             WebBeanException
```
    Overrides:
    
    renderRawData in class ReportXMLTransform
    
    Throws:
    
    WebObjectsException
    
    WebBeanException
  - renderHeaders
```
protected void renderHeaders(Tag tag)
```
    Overrides:
    
    renderHeaders in class ReportXMLTransform
  - renderValues
```
protected void renderValues(Tag reportDataTag)
                     throws WebObjectsException
```
    Overrides:
    
    renderValues in class ReportXMLTransform
    
    Throws:
    
    WebObjectsException
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: Transform
    
    Returns a textual description of the transform.
    
    Specified by:
    
    getDescription in interface Transform
    
    Overrides:
    
    getDescription in class ReportXMLTransform
    
    Returns:
    
    The textual description of the transform.
  - isValidTemplate
```
protected boolean isValidTemplate()
                           throws MSTRCheckedException
```
    Overrides:
    
    isValidTemplate in class ReportXMLTransform
    
    Throws:
    
    MSTRCheckedException
  - validateTemplate
```
public static boolean validateTemplate(WebTemplate template,
                                       ViewBean vb,
                                       AppContext appContext)
                                throws MSTRCheckedException
```
    Throws:
    
    MSTRCheckedException
  - hasAtLeastOneAttributeOnRows
```
protected static boolean hasAtLeastOneAttributeOnRows(WebTemplate template)
```
    Parameters:
    
    template -
    
    Returns:
    
    whether the template has at least one attribute on rows and nothing else.
  - 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)
```

Class IPhoneReportDataXMLTransform

Field Summary

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

Methods inherited from class java.lang.Object

Field Detail

DRILLING_TYPE_NO_DRILLING

DRILLING_TYPE_REGULAR

DRILLING_TYPE_LINKED

XML_ATT_NAME_NUMBER_SEPARATOR

XML_ATT_NAME_SEPARATOR

_drillRetainParent

_drillRetainThresholds

_renderIncrementalFetchInfo

FP_RENDER_IF_INFO

_renderDrillingInfo

FP_RENDER_DRILLING_INFO

_renderDateFormats

FP_RENDER_DATE_FORMATS

_renderMetricValuesUnformatted

FP_RENDER_METRIC_VALUES_UNFORMATTED

_renderMetricValuesFormatted

FP_RENDER_METRIC_VALUES_FORMATTED

_numberSeparator

FP_NUMBER_SEPARATOR

_pageByXml

FP_PAGE_BY_XML

FP_INCLUDE_MD_PROPERTIES

Constructor Detail

IPhoneReportDataXMLTransform

Method Detail

transform

doRenderSecondaryDataProviders

initGridData

renderDefinition

renderDrillInformation

renderProperties

addVisPropsProperty

renderRawData

renderHeaders

renderValues

getDescription

isValidTemplate

validateTemplate

hasAtLeastOneAttributeOnRows

addAttributeFormsToObjectsTag

addAttributeFormToObjectsTag

getTagsFactory

getPropSetId