public class

MobileGraphXMLTransform

extends AbstractReportXMLTransform

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

Class Overview

MobileGraphXMLTransform is a report transform that generates a simplified version of the report xml.

Summary

Constants
String	FP_INCLUDE_MD_PROPERTIES
String	FP_PAGE_BY_XML
String	FP_RENDER_PAGEBY_INFO
String	FP_RENDER_STYLES

Fields
public FormalParameter	_pageByXml	Formal parameter that contains the page by information in the form of an XML.
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.
public FormalParameter	_renderPagebyInfo	Whether to render page by info Default value: true
public FormalParameter	_renderReportDataListNode	Whether to render the root node (report_data_list) Default value: true
public FormalParameter	_renderStyles	Whether to render styles Default value: true
public FormalParameter	_renderSubtotals

[Expand]

Inherited Fields

From class com.microstrategy.web.app.transforms.AbstractBasicReportTransform

Public Constructors
	MobileGraphXMLTransform()

Public Methods
String	getDescription()
TagsFactory	getTagsFactory() Convenience method for obtaining an instance of the TagsFactory class.
void	renderXml(MarkupOutput out) Renders the report's XML.
static boolean	validateTemplate(WebTemplate template, ViewBean vb, AppContext appContext)

Protected Methods
Tag	addAttributeFormToObjectsTag(Tag parentTag, String id, String name, int rfd, String parentObjectId, int baseFormType, boolean isIDForm)
void	addAttributeFormsToObjectsTag(Tag parentTag, WebTemplateAttribute attTemplateUnit, AbstractSimplifiedReportXMLTransform.RefIDCounter rfdCounter)
void	addVisPropsProperty(Tag prsTag)
String	getDescriptor(String key) Get the descriptor for the given key.
String	getDescriptor(int key) Get the descriptor for the given key.
int	getPropSetId(String pSetName)
void	renderData(Tag reportDataTag)
void	renderDefinition(Tag reportDataTag)
void	renderProperties(Tag reportDataTag)

[Expand]

Inherited Methods

From class com.microstrategy.web.app.transforms.AbstractReportXMLTransform

From class com.microstrategy.web.app.transforms.AbstractBasicReportTransform

From class com.microstrategy.web.transform.AbstractTransform

void	addFormalParam(FormalParameterImpl formal) This method is used to add a `FormalParameterImpl` object to the transform.
boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
static List<Integer>	getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys.
FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
String	getID() Returns the unique name of the component to be used as the ID for its shell
MarkupOutput	getPreview() Produces a preview output for this transform.
boolean	isPreviewAvailable() Returns true if this transform supports preview functionality, false otherwise.
boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
FormalParameterImpl	removeFormalParam(String name) Removes the formal parameter with the given name from the formal parameters collection.
void	setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa) Used for internal housekeeping.
void	setDeprecated(FormalParameter fp, String desc) Used for internal housekeeping.
boolean	supports(Class type) Returns true if the transform supports objects of specified type.
boolean	supports(Transformable data) Returns true if the transform supports the specified data object.

From class java.lang.Object

From interface com.microstrategy.web.transform.Transform

abstract boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
abstract String	getDescription() Returns a textual description of the transform.
abstract FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
abstract String	getID() Returns the unique name of the component to be used as the ID for its shell
abstract MarkupOutput	getPreview() This method is deprecated. This feature is not used
abstract Class	getSupportedBeanType() Returns a root class/interface supported by this transform.
abstract boolean	isPreviewAvailable() This method is deprecated. This feature is not used
abstract boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
abstract boolean	supports(Class beanClass) Returns true if the transform supports objects of specified type.
abstract boolean	supports(Transformable data) Returns true if the transform supports the specified data object.
abstract void	transform(Transformable data, MarkupOutput transOut) Transforms the data object and appends result to the transOut.

Constants

public static final String FP_INCLUDE_MD_PROPERTIES

Constant Value: "includeMDProperties"

public static final String FP_PAGE_BY_XML

Constant Value: "pageByXML"

public static final String FP_RENDER_PAGEBY_INFO

Constant Value: "renderPageByInfo"

public static final String FP_RENDER_STYLES

Constant Value: "renderStyles"

Fields

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>

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

public FormalParameter _renderPagebyInfo

Whether to render page by info
Default value: true

public FormalParameter _renderReportDataListNode

Whether to render the root node (report_data_list)
Default value: true

public FormalParameter _renderStyles

Whether to render styles
Default value: true

public FormalParameter _renderSubtotals

Public Constructors

public MobileGraphXMLTransform ()

Public Methods

public String getDescription ()

public TagsFactory getTagsFactory ()

Convenience method for obtaining an instance of the TagsFactory class.

Returns

a TagsFactory instance to use for generating Tag instances

public void renderXml (MarkupOutput out)

Renders the report's XML.

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

Throws

MSTRCheckedException

Protected Methods

protected Tag addAttributeFormToObjectsTag (Tag parentTag, String id, String name, int rfd, String parentObjectId, int baseFormType, boolean isIDForm)

protected void addAttributeFormsToObjectsTag (Tag parentTag, WebTemplateAttribute attTemplateUnit, AbstractSimplifiedReportXMLTransform.RefIDCounter rfdCounter)

protected void addVisPropsProperty (Tag prsTag)

protected String getDescriptor (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 a `String`, for example, `mstrWeb.1` *

Returns

descriptor as a String corresponding to the key sent in as parameter, for example, Home.






 
    
      
        protected 
         
         
         
         
        String
      
      getDescriptor
      (int key)
    
      
        


        
  

      
    
      
  
Get the descriptor for the given key.

 By default this method appends the prefix mstrWeb. to the key
 to find the resources in the Messages bundle. To find a descriptor for a specific key
 you might use getDescriptor(String).

 If a descriptor is not found for the given key it returns [na]
  
      Parameters
      
        
          key
          input key as an int, for example, 1
        
      
  
  
      Returns
      descriptor as a String corresponding to the key sent in as parameter, for example, Home

  


    






 
    
      
        protected 
         
         
         
         
        int
      
      getPropSetId
      (String pSetName)
    
      
        


        
  

      
    
      
  

    





 
    
      
        protected 
         
         
         
         
        void
      
      renderData
      (Tag reportDataTag)
    
      
        


        
  

      
    
      
  
  
      Throws
        
        
            WebBeanException
            
          
        
            WebObjectsException
            
        
      
  

    





 
    
      
        protected 
         
         
         
         
        void
      
      renderDefinition
      (Tag reportDataTag)
    
      
        


        
  

      
    
      
  
  
      Throws
        
        
            WebBeanException
            
          
        
            WebObjectsException
            
        
      
  

    





 
    
      
        protected 
         
         
         
         
        void
      
      renderProperties
      (Tag reportDataTag)
    
      
        


        
  

      
    
      
  

    










Generated by Doclava.

Interfaces

Classes

MobileGraphXMLTransform

Class Overview

Summary

Constants

public static final String FP_INCLUDE_MD_PROPERTIES

public static final String FP_PAGE_BY_XML

public static final String FP_RENDER_PAGEBY_INFO

public static final String FP_RENDER_STYLES

Fields

public FormalParameter _pageByXml

public FormalParameter _renderMetricNumberFormattingOnly

public FormalParameter _renderPagebyInfo

public FormalParameter _renderReportDataListNode

public FormalParameter _renderStyles

public FormalParameter _renderSubtotals

Public Constructors

public MobileGraphXMLTransform ()

Public Methods

public String getDescription ()

public TagsFactory getTagsFactory ()

Returns

public void renderXml (MarkupOutput out)

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

Throws

Protected Methods

protected Tag addAttributeFormToObjectsTag (Tag parentTag, String id, String name, int rfd, String parentObjectId, int baseFormType, boolean isIDForm)

protected void addAttributeFormsToObjectsTag (Tag parentTag, WebTemplateAttribute attTemplateUnit, AbstractSimplifiedReportXMLTransform.RefIDCounter rfdCounter)

protected void addVisPropsProperty (Tag prsTag)

protected String getDescriptor (String key)

Parameters

Returns

protected String getDescriptor (int key)

Parameters

Returns

protected int getPropSetId (String pSetName)

protected void renderData (Tag reportDataTag)

Throws

protected void renderDefinition (Tag reportDataTag)

Throws

protected void renderProperties (Tag reportDataTag)