Package com.microstrategy.web.app.transforms

Class RWXMLTransform

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

com.microstrategy.web.app.transforms.AbstractSimplifiedRWXMLTransform

com.microstrategy.web.app.transforms.RWXMLTransform

All Implemented Interfaces:

AppTransform, RWBeanVisitor, RWBeanVisitor2, Transform

public class RWXMLTransform
extends AbstractSimplifiedRWXMLTransform
implements RWBeanVisitor2

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

The XML has the following format:

Error Text Here ...

… // attribute forms appear like this December 12 // second form value has no id 35444 … January 1 // second form value has no id 12000 … …
Internally it uses RWXMLTransform to render each grid.

Since:

MicroStrategy Web 8.0.2

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform

AbstractRWTransform.ButtonAlignmentsHelper

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

AbstractAppTransform.Context

Field Summary

Fields

Modifier and Type	Field	Description
protected FormalParameter	excludeVisualizationProperties	Whether to exclude visualization properties from the XML.
static java.lang.String	FP_EXCLUDE_VISUALIZATION_PROPERTIES
static java.lang.String	FP_GRID_TEMPLATES_STYLE	Constant specifying the name of the formal parameter for defining the grid style to use with templates.
static java.lang.String	FP_INCLUDE_MD_PROPERTIES
protected FormalParameter	gridTemplatesStyle	Indicates the grid style to use when rendering Grid objects.

Fields inherited from class com.microstrategy.web.app.transforms.AbstractSimplifiedRWXMLTransform

FP_USE_FIELDPOSITION_AS_ORDER, useFieldPositionAsOrder

Fields inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform

imgError

Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width

Constructor Summary

Constructors

Constructor	Description
RWXMLTransform()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Returns a textual description of the transform.
protected TransformInstance	getReportGridTransform(RWObject object, ViewBean vb)
void	renderGrid(MarkupOutput out, RWObject object, ViewBean grid)
void	transformForRequestSuccessful(MarkupOutput out)	Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestSuccessful.

Methods inherited from class com.microstrategy.web.app.transforms.AbstractSimplifiedRWXMLTransform

initializeTransform, onEnd, onEndSection, onEndSubsection, onObject, onObject, onObject, onStart, onStartSection, onStartSubsection, renderShell, startIteration, startIteration

Methods inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform

displayError, generateErrorForIframe, getCancelEvent, getContinueEvent, getDocumentStatus, getDocumentStatusDescriptorKey, getErrorMessage, getErrorTitle, getHistoryListEvent, getInboxSource, getJobExpiredMessage, getReexecuteButtonDescription, getRefreshEvent, getRWBean, getRWFrame, getSupportedBeanType, getViewDetailsEvent, getWebReexecuteEvent, initializeImages, isDesignMode, renderHistoryListButton, renderImage, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, renderProcessingInfoStatus, renderViewDetailsButton, setWebReexecuteEventArguments, transformForRequestInError, transformForRequestNotInited, updateVisTransform

Methods inherited from class com.microstrategy.web.app.transforms.AbstractWebBeanTransform

getReexcuteEventFromBean, getTaskProcessorBaseURL, renderJobExpiredSection

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestProcessing, transformForRequestWaitingForUserInput

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

getLayoutDefinition, setLayoutDefinition, transformUsingLayout

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

addFormalParam, canTransform, getEvents, getFormalParams, 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

Methods inherited from interface com.microstrategy.web.beans.RWBeanVisitor

onEndSection, onObject, onObject, onObject, onStartSection

Methods inherited from interface com.microstrategy.web.beans.RWBeanVisitor2

onEnd, onEndSubsection, onStart, onStartSubsection

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

canTransform, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports

Field Detail

gridTemplatesStyle

protected FormalParameter gridTemplatesStyle

Indicates the grid style to use when rendering Grid objects.

FP_GRID_TEMPLATES_STYLE

public static final java.lang.String FP_GRID_TEMPLATES_STYLE

Constant specifying the name of the formal parameter for defining the grid style to use with templates. Value is templatesStyle.

See Also:

Constant Field Values

excludeVisualizationProperties

protected FormalParameter excludeVisualizationProperties

Whether to exclude visualization properties from the XML.

Since:

MicroStrategy Web 8.1.1

FP_INCLUDE_MD_PROPERTIES

public static final java.lang.String FP_INCLUDE_MD_PROPERTIES

Since:

MicroStrategy Web 8.1.2

See Also:

Constant Field Values

FP_EXCLUDE_VISUALIZATION_PROPERTIES

public static final java.lang.String FP_EXCLUDE_VISUALIZATION_PROPERTIES

Since:

MicroStrategy Web 8.1.1

See Also:

Constant Field Values

Constructor Detail

RWXMLTransform

public RWXMLTransform()

Method Detail

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Description copied from class: AbstractAppTransform

Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestSuccessful. This is the main entry point to generate the output for those Transforms that just want to render the "regular" bean case.
This is an abstract method. All classes need to implement it.

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

out - output by this transform

See Also:

AbstractAppTransform.transformForRequestSuccessful(com.microstrategy.web.beans.MarkupOutput)

renderGrid

public void renderGrid(MarkupOutput out,
                       RWObject object,
                       ViewBean grid)

Specified by:

renderGrid in class AbstractSimplifiedRWXMLTransform

getReportGridTransform

protected TransformInstance getReportGridTransform(RWObject object,
                                                   ViewBean vb)

getDescription

public java.lang.String getDescription()

Description copied from interface: Transform

Returns a textual description of the transform.

Specified by:

getDescription in interface Transform

Returns:

The textual description of the transform.