Package com.microstrategy.web.app.transforms

Class SubscriptionsPageByAttributesTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.app.transforms.SubscriptionsPageByAttributesTransform

All Implemented Interfaces:

Transform

public class SubscriptionsPageByAttributesTransform
extends AbstractTransform

Returns a JSON with the list of attributes on a report's page by axis or a report services' group by axis
Used by the File subscription's bursting feature.

Constructor Summary

Constructors

Constructor	Description
SubscriptionsPageByAttributesTransform()

Method Summary

Modifier and Type	Method	Description
protected AppContext	getAppContext()	Convenience method that returns the current AppContext.
java.lang.String	getDescription()	Returns a textual description of the transform.
java.lang.Class	getSupportedBeanType()	Returns a root class/interface supported by this transform.
protected void	render(MarkupOutput out)
void	transform(Transformable data, MarkupOutput out)	Transforms the data object and appends result to the transOut.

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

addFormalParam, canTransform, getEvents, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubscriptionsPageByAttributesTransform

public SubscriptionsPageByAttributesTransform()

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.

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.

render

protected void render(MarkupOutput out)

getAppContext

protected AppContext getAppContext()

Convenience method that returns the current AppContext. This method might return null if the Transform is used outside Microstrategy Web.

Returns:

AppContext instance related with the bean being transformed.

getDescription

public java.lang.String getDescription()

Description copied from interface: Transform

Returns a textual description of the transform.

Returns:

The textual description of the transform.

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Description copied from interface: Transform

Returns a root class/interface supported by this transform. We assume here that each transform supports only beans belonging to one class hierarchy.

Returns:

a root class/interface supported by this transform.