public class

MojoVisualizationSimplifiedDataTransform

extends MojoVisualizationDataTransform

java.lang.Object
↳	com.microstrategy.web.transform.AbstractTransform
	↳	com.microstrategy.web.transform.AbstractLayoutTransform
		↳	com.microstrategy.web.app.transforms.AbstractAppTransform
			↳	com.microstrategy.web.app.transforms.AbstractWebBeanTransform
				↳	com.microstrategy.web.app.transforms.AbstractReportTransform
					↳	com.microstrategy.web.app.transforms.AbstractReportDataTransform
						↳	com.microstrategy.web.app.transforms.MojoTemplateTransformImpl
							↳	com.microstrategy.web.app.transforms.MojoXtabTransformImpl
								↳	com.microstrategy.web.app.transforms.MojoVisualizationDataTransform
									↳	com.microstrategy.web.app.transforms.MojoVisualizationSimplifiedDataTransform

Known Direct Subclasses

ImageMapVisualizationDataTransform

Class Overview

This transform generates the report data needed for Mojo Visualizations. Its output format is JSON

Summary

[Expand]

Inherited Constants

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

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

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

Fields
protected LocaleInfo	valueLocaleInfo

[Expand]

Inherited Fields

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

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

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

protected String	_blankImage	This field is deprecated. This is not used anymore. You can use _imgBlank as the source for a transparent image.
protected String	_cssBottom	This field is deprecated. css formatting is now applied through the layout-xml.
protected String	_cssCenter	This field is deprecated. css formatting is now applied through the layout-xml.
protected String	_cssLeft	This field is deprecated. css formatting is now applied through the layout-xml.
protected String	_cssRight	This is the css name for the right area.
protected String	_cssTop	This field is deprecated. css formatting is now applied through the layout-xml.
protected String	_ifLeftArrowImage	This field is deprecated. This instance variable should have been private.
protected String	_ifRightArrowImage	This field is deprecated. This instance variable should have been private.
protected FormalParameter	advancedDrillingContextMenuDisplay	It is used in the transform to specify whether to show the advanced drilling options in the editor or context menu.
protected FormalParameter	cssBottom	This field is deprecated. css formatting is now applied through the layout-xml.
protected FormalParameter	cssCenter	This field is deprecated. css formatting is now applied through the layout-xml.
protected FormalParameter	cssLeft	This field is deprecated. css formatting is now applied through the layout-xml.
protected FormalParameter	cssRight	This field is deprecated. css formatting is now applied through the layout-xml.
protected FormalParameter	cssTop	This field is deprecated. css formatting is now applied through the layout-xml.
protected FormalParameter	customJavaScriptFeatures	name for the formal parameter "customJavaScriptFeatures".
protected FormalParameter	drillRetainThresholds	This is the FP which tells whether to retain the thresholds while drilling.
protected FormalParameter	drillWithinBehavior	It is used in the transform to specify the drill within behavior.
protected FormalParameter	gridGraphUnitKeyContext	This formal parameter indicates the unique Id of the RWGridGraphControl.
protected FormalParameter	groupContextMenuDrillPathsByType	Determines whether drill types (up, down, across and to template) will be displayed as read from the backend in which case the drill types may be intermingled or that we will buck the types together and show the types grouped together.
protected boolean	hasIncreFetchForColumnOnLeft	This field is deprecated. This variable it's not used anymore.
protected boolean	hasIncreFetchForColumnOnRight	This field is deprecated. This variable it's not used anymore.
protected FormalParameter	id	It is used to identify the outer shell for all report modes - grid, graph and gridgraph.
protected FormalParameter	ifLeftArrowImage	This is the name of the left arrow image to be used in this transform for incremental fetch.
protected FormalParameter	ifRightArrowImage	This is the name of the right arrow image to be used in this transform for incremental fetch.
protected FormalParameter	incrementalFetchStyleForRow	This is the name of the style used to show the incremental fetch for row.
protected FormalParameter	quickSwitch	This formal parameter indicates if the grid is going to have the Quick Switch functionality (client side view mode change enabler) enabled.
protected FormalParameter	quickSwitchCurrent	This formal parameter indicates if the grid is going to have the Quick Switch functionality and if it's the current view mode displayed.
protected FormalParameter	rwbViewerID	This Formal Parameter is used to indicate the bone ID for the RWB viewer.
protected FormalParameter	showDrillPathSetNamesSubMenuAtTopLevel	It is used in the transform to specify whether to show the set names submenu for drilling at the top level (or at a lower depth).
protected FormalParameter	showIncreFetchForColumn	This field is deprecated. To show/hide the incremental fetch section you should modify the corresponding xml-layout definition of the transform.
protected FormalParameter	showIncreFetchForRowOnBottom	This field is deprecated. To show/hide the incremental fetch section you should modify the corresponding xml-layout definition of the transform.
protected FormalParameter	showIncreFetchForRowOnTop	This field is deprecated. To show/hide the incremental fetch section you should modify the corresponding xml-layout definition of the transform.
protected FormalParameter	showSubtitlePara	Controls whether subtitles (attribute forms) are to be displayed for this grid.
protected FormalParameter	sortSetNamesAndDrillPaths	It is used in the transform to specify whether to show the set names and drill paths names alphabetically sorted.
protected HashMap	transformContext	This field is deprecated. This instance variable should have been private. You may use getTransformContext() to access it.
protected FormalParameter	uniqueReportId	This is the name of the HTML DIV for the report.

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

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

protected final String	CLASS_INPUT	This field is deprecated. This property is not used anymore by the transform.
protected final String	CLASS_MESSAGE	This field is deprecated. This property is not used anymore by the transform.
protected WebComponent	_bean	Instance of `WebComponent` being transformed.
protected ComponentBlock	_componentBlock
protected String	_cssPrefix	Property corresponding to the value of the `cssPrefix` formal parameter
protected String	_imgBlank	Field that containts the URL location of a blank image (used as the source of most <IMG> tags as the real URL is specified through css).
protected String	_imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected MarkupOutput	_selfOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
protected MarkupOutput	_subOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
public FormalParameter	appliesTo	This parameter informs the javascript the id of the bone the actions of this component applies to.
public FormalParameter	contextMenus	This formal parameter is used by the Transform to identify the context-menus definition.
public FormalParameter	cssFile	CSS file that includes the style definition.
public FormalParameter	cssPrefix	Prefix to append to all css class names.
public FormalParameter	debugErrorFlags	Indicates which extra debug information to include in case of an error.
public FormalParameter	debugFlags	Indicates which debug information to include.
public FormalParameter	dragMode	Indicates the drag mode that the component to render will have.
public FormalParameter	extraInput	Indicates any extra inputs to be included in the forms generated by the transform.
public FormalParameter	extraUrl	Indicates any extra parameters to be included in the links generated by the transform.
public FormalParameter	globalCssErrorMessage	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	globalCssErrorTitle	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	height	Indicates the default height of the component.
public FormalParameter	iframeEnabled	Indicates whether the transform supports iframe manipulations.
public FormalParameter	imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected int	indent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
public FormalParameter	initialIndent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
protected boolean	isDHTML	This field is deprecated. Use `isDhtml()`.
public FormalParameter	orientation	Indicates the orientation the dialog to render will have.
public FormalParameter	orientationsAllowed	Indicates the orientation modes allowed for the dialog to render.
public FormalParameter	partialIframeUpdate	This formal parameter specifies whether we should replace the whole contentst of the div shell (outerHTML) or the just the inner contents (innerHTML) of that shell div for the transform when the iframe update is going on.
public FormalParameter	processingButtonsFlags	Indicates which buttons to include on the wait page.
public FormalParameter	processingInfoFlags	Indicates which information to include on the wait page.
public FormalParameter	resizeLevel	Indicates whether the component can be resized vertically/horizontally or both or none.
public FormalParameter	scriptClass	Holds the name of the javaScript class (if any) to be associated with the component.
protected static final ScriptVariableJSONEncoder	scriptEndTagEncoder	reference to encoder that deals with tag encoding
public FormalParameter	type	This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is.
public FormalParameter	useDHTML	Indicates whether to use DHTML on the output.
public FormalParameter	width	Indicates the default width of the component.

Public Constructors
	MojoVisualizationSimplifiedDataTransform()

Public Methods
Block	getValueBlock(WebRowValue rowValue) DE41002: This method replaces commas or any other decimal separators to decimal points('.').

Protected Methods
Block	createGridModelBlock()
Block	createHeader(WebHeader headerSrc, boolean useTitle)

[Expand]

Inherited Methods

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

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

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

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

void	createBlockEditorProperties() This method is deprecated. use `createBlockEditorProperties(JsonGenerator)`
void	createBlockEditorProperties(JsonGenerator boneProps) This method adds all of the grid/graph Report Services properties to the client side properties collection.
JsonGenerator	generatePageHistoryItems(boolean isBackList)
Map	getAttributesShellDiv() Returns a Map with the list of attributes that the shell div must use.
String	getBeanPath() Returns the path within the application of the WebBean being transformed.
String	getBoneId() Returns the id to be used for the JavaScript bone.
int	getDisplayMode(WebDrillPath dp) Returns the display mode when drilling via the given drill path
FrameBean	getFrameBean(WebComponent parent)
WebGridData	getGridData()
String	getGridScriptClass() return grid JS scriptClass name depending grid mode
WebGridWidths	getGridWidths()
String	getID() Returns the unique name of the component to be used as the ID for its shell.
int	getMetricAxisName() Returns the name (see `EnumDSSXMLAxisName` of the axis with the metrics in it.
String	getReportSetting(String propertySetName, String propertyName)
HashMap	getTransformContext() Get the context object associated with the transform.
ViewBean	getViewBean()
WebTemplate	getWebTemplate()
boolean	hasBottom() This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
abstract boolean	hasCenter() This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
boolean	hasLeft() This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
boolean	hasRight() This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
boolean	hasTop() This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
void	initializeCss() Initialize the css classes to be used by this transform.
void	initializeImages() initialize the images for the transform.
void	initializeProperties() Extends `initializeProperties` by invoking `initializeTranformContext`
void	initializeTranformContext() Initialize the transform context object.
void	initializeTransform(Transformable data) This method initialize the private and protected fields of the transform.
void	initializeWebComponent(Transformable data) This method initialize `WebComponent` being transformed.
boolean	isCalledFromPrinting() This method is deprecated. The logic of this method is no longer required at this level, print transforms such as `ReportGridPrintTransform` now handle it. This method now returns `false` by default.
abstract boolean	isGraphTransform()
boolean	isGridEmpty() Returns `true` if the grid contains no data.
abstract boolean	isGridTransform()
boolean	isQuickSwitchEnabled()
boolean	isRWBean()
void	renderBottom(MarkupOutput out, ReportBean rb) This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
void	renderContent(MarkupOutput out, ReportBean rb) This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
void	renderIncreFetchOnColumnLeftPart(MarkupOutput out, ReportBean rb) This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use/extend the `renderColumnsIncrementalFetchPrevious` method.
void	renderIncreFetchOnColumnRightPart(MarkupOutput out, ReportBean rb) This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use/extend the `renderColumnsIncrementalFetchNext` method.
void	renderIncreFetchOnRow(MarkupOutput out, ReportBean rb) This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use/extend the `renderRowsIncrementalFetch` method.
void	renderJavascript(MarkupOutput out) This method renders the javascript code that needs to be generated on the server side because its content is dynamic.
void	renderLeft(MarkupOutput out, ReportBean rb) This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
void	renderRight(MarkupOutput out, ReportBean rb) This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
void	renderRowsIncrementalFetch(MarkupOutput out) Generates the rows incremental fetch portion.
void	renderTop(MarkupOutput out, ReportBean rb) This method is deprecated. This method has been deprecated and will be removed in future versions of the product. In its place, use a layout-xml to control the output.
void	setBoneProperties(JsonGenerator boneProps) Sets the necessary properties to the bone assigned to this transform (based on the `scriptClass` formal parameter) Usually called by `renderRegisterBone(MarkupOutput)` Can be overwritten to add or modify bone properties.
boolean	shouldRenderGridInfo() This method is used to determine if the bone's gridInfo structure needs to be included.
boolean	showSubTitleOnly(int subTitleIndex) Returns whether show only the subtitle for this grid.
boolean	showSubtitle() Returns whether subtitles are enabled for this grid.
boolean	showSubtitle(int subTitleCount) Returns whether subtitles are enabled for this grid.
boolean	supports(Transformable data) Extends support by supporting more than one type of `Transformable`.
boolean	supports(Class c) Extends support by supporting more than one `Class`.
void	transformForRequestSuccessful(MarkupOutput out) Transform when the status is "Successful".

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

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

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

From class com.microstrategy.web.transform.AbstractLayoutTransform

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.app.transforms.AppTransform

From interface com.microstrategy.web.app.transforms.ReportDataTransform

From interface com.microstrategy.web.transform.LayoutTransform

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.

Fields

protected LocaleInfo valueLocaleInfo

Public Constructors

public MojoVisualizationSimplifiedDataTransform ()

Public Methods

public Block getValueBlock (WebRowValue rowValue)

DE41002: This method replaces commas or any other decimal separators to decimal points('.'). This method resolves the issue that in German and French, comma was used as the decimal separators instead of '.', which breaks the json outputs in the custom visualizations.

Throws

Exception

Protected Methods

protected Block createGridModelBlock ()

Throws

Exception

protected Block createHeader (WebHeader headerSrc, boolean useTitle)

Parameters

useTitle	whether title can be referenced in the block model

Throws

Exception

Interfaces

Classes

MojoVisualizationSimplifiedDataTransform

Class Overview

Summary

Fields

protected LocaleInfo valueLocaleInfo

Public Constructors

public MojoVisualizationSimplifiedDataTransform ()

Public Methods

public Block getValueBlock (WebRowValue rowValue)

Throws

Protected Methods

protected Block createGridModelBlock ()

Throws

protected Block createHeader (WebHeader headerSrc, boolean useTitle)

Parameters

Throws