public class

MobilePreambleXMLTransform

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

Summary

Constants
String	FP_COMPRESSION_VERSION
String	FP_INCLUDE_MD_PROPERTIES
String	FP_PAGE_BY_XML
int	GZIP_COMPRESSION
int	NO_COMPRESSION

Fields
public FormalParameter	_compressionVersion
public FormalParameter	_pageByXml	Formal parameter that contains the page by information in the form of an XML.

[Expand]

Inherited Fields

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

Public Constructors
	MobilePreambleXMLTransform()

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.

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)
int	getPropSetId(String pSetName)

[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_COMPRESSION_VERSION

Constant Value: "compressionVersion"

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 int GZIP_COMPRESSION

Constant Value: 2 (0x00000002)

public static final int NO_COMPRESSION

Constant Value: 0 (0x00000000)

Fields

public FormalParameter _compressionVersion

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 Constructors

public MobilePreambleXMLTransform ()

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.

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)

Interfaces

Classes