Package com.microstrategy.web.app.transforms

Class AbstractBasicReportTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.app.transforms.AbstractBasicReportTransform

All Implemented Interfaces:

Transform

Direct Known Subclasses:

AbstractBasicMojoVisualizationDataTransform, AbstractReportXMLTransform, OndemandContextMenusTransform

public abstract class AbstractBasicReportTransform
extends AbstractTransform

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected Transformable	_bean
protected ReportBean	_rb
protected RWBean	_rwb
protected ViewBean	_vb

Constructor Summary

Constructors

Constructor	Description
AbstractBasicReportTransform()

Method Summary

Modifier and Type	Method	Description
protected FormalParameter	addFormalParameter(java.lang.String name, int type, java.lang.Object defaultValue, java.lang.String description)	Adds a formal parameter for this transform with the given information
protected com.microstrategy.web.app.transforms.ElementsMapJsonHelper	getElemsMapHelper()
protected GraphBean	getGraphBean()
protected WebGridData	getGridData()
protected com.microstrategy.web.app.transforms.GridTransformJsonHelpers	getHyperLinkHelper()
protected ReportBean	getReportBean()
protected RWBean	getRWBean()
java.lang.Class	getSupportedBeanType()	Returns a root class/interface supported by this transform.
protected ViewBean	getViewBean()
protected WebGridData	getWebGridData()
protected WebReportGrid	getWebReportGrid()
protected WebTemplate	getWebTemplate()
protected void	initBeans(Transformable bean)
protected void	initGridData()
protected boolean	isDesignMode()
boolean	isFeatureAvailable(java.lang.String feature)	Convenience method.
protected boolean	isReport()
protected static boolean	isTrue(FormalParameter parameter)	Checks for a Boolean FormalParamter and return its booleanValue().
protected abstract void	render(MarkupOutput out)	This method is responsible for rendering the transform and is called in transform(Transformable, MarkupOutput)
boolean	supports(Transformable data)	Returns true if the transform supports the specified data object.
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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microstrategy.web.transform.Transform

getDescription

Field Detail

_rb

protected ReportBean _rb

_vb

protected ViewBean _vb

_rwb

protected RWBean _rwb

_bean

protected Transformable _bean

Constructor Detail

AbstractBasicReportTransform

public AbstractBasicReportTransform()

Method Detail

initBeans

protected void initBeans(Transformable bean)
                  throws WebBeanException

Throws:

WebBeanException

initGridData

protected void initGridData()
                     throws WebObjectsException,
                            WebBeanException

Throws:

WebObjectsException

WebBeanException

isReport

protected boolean isReport()

supports

public boolean supports(Transformable data)

Description copied from interface: Transform

Returns true if the transform supports the specified data object. The check is performed only on the object's type, no object state is taken into account.

Specified by:

supports in interface Transform

Overrides:

supports in class AbstractTransform

Parameters:

data - a transformable object

Returns:

true if the transform supports the data object, false otherwise.

See Also:

Transform.canTransform(com.microstrategy.web.beans.Transformable)

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.

getReportBean

protected ReportBean getReportBean()

getViewBean

protected ViewBean getViewBean()

getGraphBean

protected GraphBean getGraphBean()

getRWBean

protected RWBean getRWBean()

getWebReportGrid

protected WebReportGrid getWebReportGrid()

getWebGridData

protected WebGridData getWebGridData()

addFormalParameter

protected FormalParameter addFormalParameter(java.lang.String name,
                                             int type,
                                             java.lang.Object defaultValue,
                                             java.lang.String description)

Adds a formal parameter for this transform with the given information

Parameters:

name - the name of the formal parameter

type - the type of the formal parameter, as defined in the FormalParameter constants.

defaultValue - the default value

description - Description of the FP, to use by the style catalog.

Returns:

the FormalParameter created.

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 abstract void render(MarkupOutput out)

This method is responsible for rendering the transform and is called in transform(Transformable, MarkupOutput)

Parameters:

out -

isFeatureAvailable

public boolean isFeatureAvailable(java.lang.String feature)

Convenience method. Maps the isFeatureAvailable method of the Bean currently bean Transformed.

Parameters:

feature - the feature Id.

Returns:

true by default, or whatever _bean.isFeatureAvailable(feature) returns;

isTrue

protected static boolean isTrue(FormalParameter parameter)

Checks for a Boolean FormalParamter and return its booleanValue().

Parameters:

parameter - the formal parameter to check

Returns:

true if the parameter is true.

getElemsMapHelper

protected com.microstrategy.web.app.transforms.ElementsMapJsonHelper getElemsMapHelper()

getHyperLinkHelper

protected com.microstrategy.web.app.transforms.GridTransformJsonHelpers getHyperLinkHelper()

getGridData

protected WebGridData getGridData()
                           throws WebBeanException,
                                  WebObjectsException

Throws:

WebBeanException

WebObjectsException

isDesignMode

protected boolean isDesignMode()

getWebTemplate

protected WebTemplate getWebTemplate()
                              throws WebBeanException,
                                     WebObjectsException

Throws:

WebBeanException

WebObjectsException