Class AbstractReportDataTransform
- 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
-
- All Implemented Interfaces:
AppTransform
,ReportDataTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
AbstractReportDataVisualizationTransform
,AbstractReportGridTransform
,MojoTemplateTransformImpl
,ReportGraphTransformImpl
,ReportGridGraphTransformImpl
public abstract class AbstractReportDataTransform extends AbstractReportTransform implements ReportDataTransform, LayoutTransform
This is the base class for those Report Transforms that generate some sort of representation of the report's data, either as grid, as a graph or as a grid-graph. It provides a place holder for common methods and formal parameters. In particular, the report's incremental fetch functionality links are generated in this class by the following methods:renderRowsIncrementalFetch
renderColumnIncrementalFetchNext
renderColumnIncrementalFetchPrevious
This class implements
ReportDataTransform
, in previous versions of the product this was used to indicate how the general layout of the Transform would be generated. This usage has been deprecated, though. Now this class implementsLayoutTransform
which enables building the layout through an external xml configuration file. Old methods of theReportDataTransform
like:renderTop
renderBottom
renderLeft
renderRight
renderCenter
Incremental fetch methods can be called through the layout-xml.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
_blankImage
Deprecated.This is not used anymore.protected java.lang.String
_cssBottom
Deprecated.css formatting is now applied through the layout-xml.protected java.lang.String
_cssCenter
Deprecated.css formatting is now applied through the layout-xml.protected java.lang.String
_cssLeft
Deprecated.css formatting is now applied through the layout-xml.protected java.lang.String
_cssRight
This is the css name for the right area.protected java.lang.String
_cssTop
Deprecated.css formatting is now applied through the layout-xml.protected java.lang.String
_ifLeftArrowImage
Deprecated.This instance variable should have been private.protected java.lang.String
_ifRightArrowImage
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.static java.lang.String
BLANK_SUBSET_REPORT_ID
protected FormalParameter
cssBottom
Deprecated.css formatting is now applied through the layout-xml.protected FormalParameter
cssCenter
Deprecated.css formatting is now applied through the layout-xml.protected FormalParameter
cssLeft
Deprecated.css formatting is now applied through the layout-xml.protected FormalParameter
cssRight
Deprecated.css formatting is now applied through the layout-xml.protected FormalParameter
cssTop
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
Deprecated.This variable it's not used anymore.protected boolean
hasIncreFetchForColumnOnRight
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
Deprecated.To show/hide the incremental fetch section you should modify the corresponding xml-layout definition of the transform.protected FormalParameter
showIncreFetchForRowOnBottom
Deprecated.To show/hide the incremental fetch section you should modify the corresponding xml-layout definition of the transform.protected FormalParameter
showIncreFetchForRowOnTop
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 java.util.HashMap
transformContext
Deprecated.This instance variable should have been private.protected FormalParameter
uniqueReportId
This is the name of the HTML DIV for the report.-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractReportTransform
BLANK_XDA_REPORT_ID, cssErrorMessage, cssErrorTitle, cssUseFileContent, generateJSForDrillCheckBoxesForIncFetch, iFramePara, imgError, showScroller, useBuiltInFormatPara
-
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 AbstractReportDataTransform()
Class constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
createBlockEditorProperties()
Deprecated.protected void
createBlockEditorProperties(JsonGenerator boneProps)
This method adds all of the grid/graph Report Services properties to the client side properties collection.protected JsonGenerator
generatePageHistoryItems(boolean isBackList)
java.util.Map
getAttributesShellDiv()
Returns a Map with the list of attributes that the shell div must use.protected java.lang.String
getBeanPath()
Returns the path within the application of the WebBean being transformed.protected java.lang.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 pathprotected FrameBean
getFrameBean(WebComponent parent)
protected WebGridData
getGridData()
protected java.lang.String
getGridScriptClass()
return grid JS scriptClass name depending grid modeprotected WebGridWidths
getGridWidths()
java.lang.String
getID()
Returns the unique name of the component to be used as the ID for its shell.protected int
getMetricAxisName()
Returns the name (seeEnumDSSXMLAxisName
of the axis with the metrics in it.protected java.lang.String
getReportSetting(java.lang.String propertySetName, java.lang.String propertyName)
java.util.HashMap
getTransformContext()
Get the context object associated with the transform.protected ViewBean
getViewBean()
protected WebTemplate
getWebTemplate()
boolean
hasBottom()
Deprecated.This method has been deprecated and will be removed in future versions of the product.abstract boolean
hasCenter()
Deprecated.This method has been deprecated and will be removed in future versions of the product.boolean
hasLeft()
Deprecated.This method has been deprecated and will be removed in future versions of the product.boolean
hasRight()
Deprecated.This method has been deprecated and will be removed in future versions of the product.boolean
hasTop()
Deprecated.This method has been deprecated and will be removed in future versions of the product.void
initializeCss()
Initialize the css classes to be used by this transform.void
initializeImages()
initialize the images for the transform.void
initializeProperties()
ExtendsinitializeProperties
by invokinginitializeTranformContext
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 initializeWebComponent
being transformed.protected boolean
isCalledFromPrinting()
Deprecated.The logic of this method is no longer required at this level, print transforms such asReportGridPrintTransform
now handle it.protected abstract boolean
isGraphTransform()
boolean
isGridEmpty()
Returnstrue
if the grid contains no data.protected abstract boolean
isGridTransform()
protected boolean
isQuickSwitchEnabled()
boolean
isRWBean()
void
renderBottom(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product.void
renderContent(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product.void
renderIncreFetchOnColumnLeftPart(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product.void
renderIncreFetchOnColumnRightPart(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product.void
renderIncreFetchOnRow(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product.protected 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)
Deprecated.This method has been deprecated and will be removed in future versions of the product.void
renderRight(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product.void
renderRowsIncrementalFetch(MarkupOutput out)
Generates the rows incremental fetch portion.void
renderTop(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product.protected void
setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on theAbstractAppTransform.scriptClass
formal parameter)
Usually called byAbstractAppTransform.renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.protected boolean
shouldRenderGridInfo()
This method is used to determine if the bone's gridInfo structure needs to be included.protected boolean
showSubtitle()
Returns whether subtitles are enabled for this grid.protected boolean
showSubtitle(int subTitleCount)
Returns whether subtitles are enabled for this grid.protected boolean
showSubTitleOnly(int subTitleIndex)
Returns whether show only the subtitle for this grid.boolean
supports(Transformable data)
Extends support by supporting more than one type ofTransformable
.boolean
supports(java.lang.Class c)
Extends support by supporting more than oneClass
.void
transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful".-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractReportTransform
canTransform, generateAnchor, generateErrorForIframe, generateErrorForIframe, generateIncFetchAnchor, generateIncFetchOpenAnchor, getCancelEvent, getContinueEvent, getErrorMessage, getErrorTitle, getHistoryListEvent, getInboxSource, getJobExpiredMessage, getNextColumnsEvent, getPreviousColumnsEvent, getReexecuteButtonDescription, getReportBean, getReportStatus, getReportStatusDescriptorKey, getRepromptEvent, getSupportedBeanType, getViewDetailsEvent, getWebReexecuteEvent, isCubeReport, isDatamart, isDesignMode, isIFrameEnabled, isIncRefreshReport, isNonViewableReport, renderColumnsIncrementalFetch, renderColumnsIncrementalFetchNext, renderColumnsIncrementalFetchPrevious, renderContinueFormForRequestInError, renderErrorButtons, renderErrorInfo, renderHistoryListButton, renderImage, renderJobExpiredSection, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, renderViewDetailsButton, setWebReexecuteEventArguments, transformForRequestInError, transformForRequestNotInited, useBuiltInFormat
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
getReexcuteEventFromBean, getTaskProcessorBaseURL
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, 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, renderShell, renderSubBlock, renderUserHelpAnchor, 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, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated
-
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.LayoutTransform
getLayoutDefinition, setLayoutDefinition
-
Methods inherited from interface com.microstrategy.web.app.transforms.ReportDataTransform
renderCenter, renderData, renderEmptyCase, renderLayout
-
Methods inherited from interface com.microstrategy.web.transform.Transform
canTransform, getDescription, getFormalParams, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, transform
-
-
-
-
Field Detail
-
BLANK_SUBSET_REPORT_ID
public static final java.lang.String BLANK_SUBSET_REPORT_ID
- See Also:
- Constant Field Values
-
hasIncreFetchForColumnOnLeft
protected boolean hasIncreFetchForColumnOnLeft
Deprecated.This variable it's not used anymore.It is used in the transform to specify whether there are incremental fetch links for column on left side of the report data.
Allowed Values: TRUE/FALSE.
-
hasIncreFetchForColumnOnRight
protected boolean hasIncreFetchForColumnOnRight
Deprecated.This variable it's not used anymore.It is used in the transform to specify whether there are incremental fetch links for column on right side of the report data.
Allowed Values: TRUE/FALSE.
-
transformContext
protected java.util.HashMap transformContext
Deprecated.This instance variable should have been private. You may use getTransformContext() to access it.The tranform context object represented as a hashtable.
All the items' keys are listed as constants in ReportTransformHelper.
-
_cssTop
protected java.lang.String _cssTop
Deprecated.css formatting is now applied through the layout-xml.This is the css name for the top area.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
-
_cssBottom
protected java.lang.String _cssBottom
Deprecated.css formatting is now applied through the layout-xml.This is the css name for the bottom area.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
-
_cssLeft
protected java.lang.String _cssLeft
Deprecated.css formatting is now applied through the layout-xml.This is the css name for the left area.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
-
_cssRight
protected java.lang.String _cssRight
This is the css name for the right area.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
-
_cssCenter
protected java.lang.String _cssCenter
Deprecated.css formatting is now applied through the layout-xml.This is the css name for the center area.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
-
_blankImage
protected java.lang.String _blankImage
Deprecated.This is not used anymore. You can use _imgBlank as the source for a transparent image.This is the image name for blank space.
-
_ifLeftArrowImage
protected java.lang.String _ifLeftArrowImage
Deprecated.This instance variable should have been private.This is the image name for the left arrow image in incremental fetch.
-
_ifRightArrowImage
protected java.lang.String _ifRightArrowImage
Deprecated.This instance variable should have been private.This is the image name for the right arrow image in incremental fetch.
-
uniqueReportId
protected FormalParameter uniqueReportId
This is the name of the HTML DIV for the report. It's used as the unique identifier of the grid's bone.
Allowed Values: String values.
-
showIncreFetchForRowOnTop
protected FormalParameter showIncreFetchForRowOnTop
Deprecated.To show/hide the incremental fetch section you should modify the corresponding xml-layout definition of the transform.It is used in the transform to specify whether to show increfetch links for rows on top of the grid.
Allowed Values: TRUE/FALSE.
-
showIncreFetchForRowOnBottom
protected FormalParameter showIncreFetchForRowOnBottom
Deprecated.To show/hide the incremental fetch section you should modify the corresponding xml-layout definition of the transform.It is used in the transform to specify whether to show increfetch links for rows at the bottom of the grid.
Allowed Values: TRUE/FALSE.
-
showIncreFetchForColumn
protected FormalParameter showIncreFetchForColumn
Deprecated.To show/hide the incremental fetch section you should modify the corresponding xml-layout definition of the transform.It is used in the transform to specify whether to show increfetch links on column.
Allowed Values: TRUE/FALSE.
-
advancedDrillingContextMenuDisplay
protected FormalParameter advancedDrillingContextMenuDisplay
It is used in the transform to specify whether to show the advanced drilling options in the editor or context menu.
Allowed Values: PreferencesDrillTransform.ADVANCED_DRILLING_RMC_DISPLAY_DEFAULT = "1"
ADVANCED_DRILLING_RMC_DISPLAY_SUBMENU = "2"- Since:
- MicroStrategy Web 9.0.0
-
incrementalFetchStyleForRow
protected FormalParameter incrementalFetchStyleForRow
This is the name of the style used to show the incremental fetch for row.
Allowed Values: any report style name from StyelCatalog.xml file.
-
ifLeftArrowImage
protected FormalParameter ifLeftArrowImage
This is the name of the left arrow image to be used in this transform for incremental fetch.
Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
ifRightArrowImage
protected FormalParameter ifRightArrowImage
This is the name of the right arrow image to be used in this transform for incremental fetch.
Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
cssLeft
protected FormalParameter cssLeft
Deprecated.css formatting is now applied through the layout-xml.This is the css name for the left area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
-
cssRight
protected FormalParameter cssRight
Deprecated.css formatting is now applied through the layout-xml.This is the css name for the right area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
-
cssTop
protected FormalParameter cssTop
Deprecated.css formatting is now applied through the layout-xml.This is the css name for the top area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
-
cssBottom
protected FormalParameter cssBottom
Deprecated.css formatting is now applied through the layout-xml.This is the css name for the bottom area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
-
cssCenter
protected FormalParameter cssCenter
Deprecated.css formatting is now applied through the layout-xml.This is the css name for the center area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
-
showSubtitlePara
protected FormalParameter showSubtitlePara
Controls whether subtitles (attribute forms) are to be displayed for this grid. Allowed Values:EnumWebPreferences.PREFERENCE_NO
("0"): subtitles are off.EnumWebPreferences.PREFERENCE_YES
("1"): subtitles are on.EnumWebPreferences.PREFERENCE_VALUE_FROM_REPORT
("3"):the"LongNames"
report setting controls whether subtitles are on or off.
- Since:
- MicroStrategy Web 8.0.0
-
showDrillPathSetNamesSubMenuAtTopLevel
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).
Allowed Values: TRUE/FALSE.- Since:
- MicroStrategy Web 9.0.0
-
drillWithinBehavior
protected FormalParameter drillWithinBehavior
It is used in the transform to specify the drill within behavior. As of now this formal parameter is used only for grids in report writting documents.
Drill Within paths will typically be displayed twice on the drill context menu, once at the first submenu level, and once in the Drill Anywhere submenu(s). We can take advantage of this fact to allow the user to decide whether clicking on a path that can be resolved within the base report will in fact be resolved within the current document, or if it will generate a new report instance instead. Allowed Values: TRUE/FALSE.
Allowed Values:
EnumWebPreferences.DRILL_WITHIN_AUTOMATIC = "1" : If the path can be resolved with the base report, it will be performed as a manipulation on the current document instance; otherwise it will generate a new report instance. This option would be the default and would automatically choose what we think is the most optimized behavior.
EnumWebPreferences.DRILL_WITHIN_MENU_LOCATION = "2" : If the path is a within path and it is clicked on in the first submenu level, then it will be performed as a manipulation on the current document instance; otherwise it will generate a new report instance (within paths that are located in the drill anywhere submenu(s) will generate a new report instance). EnumWebPreferences.DRILL_WITHIN_ALWAYS_NEW_REPORT = "3" : All paths will generate a new report instance, including Within paths. This option could be selected to enforce consistent behavior on all drill paths, since non-within paths will always generate a new report instance, regardless of the user preference.- Since:
- MicroStrategy Web 9.0.0
-
rwbViewerID
protected FormalParameter rwbViewerID
This Formal Parameter is used to indicate the bone ID for the RWB viewer. Allowed Values: any String.- Since:
- MicroStrategy Web 8.0.0
-
drillRetainThresholds
protected FormalParameter drillRetainThresholds
This is the FP which tells whether to retain the thresholds while drilling. If a value is specified here, then the drill Preference on the preference page for the same is ignored. This value can be 1(to retain), 0(to not retain) or 2(to use the drill path for the value). If blank the drill preference is used. Allowed Values:
PreferencesDrillTransform.DRILL_OPTION_RETAIN_THRESHOLD_YES = "1";
PreferencesDrillTransform.DRILL_OPTION_RETAIN_THRESHOLD_NO = "2";
PreferencesDrillTransform.DRILL_OPTION_RETAIN_THRESHOLD_REPORT_DEFINITION = "3";- Since:
- MicroStrategy Web 7.5.4
-
quickSwitch
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. This will only apply to grids and graphs rendered inside Report Writing Documents. Allowed values:
True and False- Since:
- MicroStrategy Web 8.1.0
-
quickSwitchCurrent
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. This will only apply to grids and graphs rendered inside Report Writing Documents. Allowed values:
True and False- Since:
- MicroStrategy Web 8.1.0
-
gridGraphUnitKeyContext
protected FormalParameter gridGraphUnitKeyContext
This formal parameter indicates the unique Id of the RWGridGraphControl. This will only apply to grids and graphs rendered inside Report Writing Documents. Allowed values:
Any String- Since:
- MicroStrategy Web 8.1.0
-
sortSetNamesAndDrillPaths
protected FormalParameter sortSetNamesAndDrillPaths
It is used in the transform to specify whether to show the set names and drill paths names alphabetically sorted.
Allowed Values: TRUE/FALSE.- Since:
- MicroStrategy Web 9.0.0
-
groupContextMenuDrillPathsByType
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. The order will be up, down, across and to template. Default is false. Allowed Values: TRUE/FALSE.- Since:
- MicroStrategy Web 9.0.0
-
id
protected FormalParameter id
It is used to identify the outer shell for all report modes - grid, graph and gridgraph. (Firefox issue: 246019)- Since:
- MicroStrategy Web 9.0.0
-
customJavaScriptFeatures
protected FormalParameter customJavaScriptFeatures
name for the formal parameter "customJavaScriptFeatures".- Since:
- MicroStrategy Web 9.0.0
-
-
Method Detail
-
initializeWebComponent
public void initializeWebComponent(Transformable data)
This method initializeWebComponent
being transformed. This method enables the transform to support bothReportBean
andViewBean
.
Internally, when aReportBean
is passed, this Transform will get its ViewBean and callsuper
using theViewBean
. Starting with 8.0, ReportDataTransforms manipulates instances ofViewBean
's.- Specified by:
initializeWebComponent
in interfaceAppTransform
- Overrides:
initializeWebComponent
in classAbstractReportTransform
- Parameters:
data
- object being Transformed- Since:
- MicroStrategy Web 8.0.0
-
initializeCss
public void initializeCss()
Description copied from class:AbstractAppTransform
Initialize the css classes to be used by this transform.- Overrides:
initializeCss
in classAbstractAppTransform
-
initializeImages
public void initializeImages()
Description copied from class:AbstractReportTransform
initialize the images for the transform.- Overrides:
initializeImages
in classAbstractReportTransform
-
initializeProperties
public void initializeProperties()
ExtendsinitializeProperties
by invokinginitializeTranformContext
- Overrides:
initializeProperties
in classAbstractReportTransform
-
initializeTranformContext
public void initializeTranformContext()
Initialize the transform context object. This object is later passed to theReportGridDisplayCell
instances so they have information about the transform.
-
getTransformContext
public java.util.HashMap getTransformContext()
Get the context object associated with the transform.- Specified by:
getTransformContext
in interfaceReportDataTransform
- Returns:
- the transform context object
-
isRWBean
public boolean isRWBean()
- Since:
- MicroStrategy Web 8.0.0
-
showSubtitle
protected boolean showSubtitle()
Returns whether subtitles are enabled for this grid. It will check the value of theshowSubtitle
formal parameter. This could be:EnumWebPreferences.PREFERENCE_NO
: subtitles are off.EnumWebPreferences.PREFERENCE_YES
: subtitles are on.EnumWebPreferences.PREFERENCE_VALUE_FROM_REPORT
: the"LongNames"
report setting controls whether subtitles are on or off.
- Returns:
- true if the subtitles are enabled.
- Since:
- MicroStrategy Web 8.0.0
-
showSubtitle
protected boolean showSubtitle(int subTitleCount)
Returns whether subtitles are enabled for this grid. It will check the value of theshowSubtitle
formal parameter. This could be:EnumWebPreferences.PREFERENCE_NO
: subtitles are off.EnumWebPreferences.PREFERENCE_YES
: subtitles are on.EnumWebPreferences.PREFERENCE_VALUE_FROM_REPORT
: the"LongNames"
report setting controls whether subtitles are on or off.Value Behavior for Attributes with a single displayed form (subTitleCount = 1) Behavior for Attributes with multiple displayed forms (subTitleCount > 1) -1 Show Attribute name only Show Attribute name + form name on all forms 0 Show Attribute name only Show Attribute name on the first form only, show nothing on subsequent forms 1 Show Attribute name + form name Show Attribute name + form name on all forms 2 Show Attribute form name only Show attribute form name only for all forms 3 Show Attribute name + form name Show Attribute name + form name on first form; Form name only on subsequent forms 4 Show Attribute name only Show Attribute name + form name on all forms
- Parameters:
subTitleCount
- Count of sub titles.- Returns:
- true if the subtitles are enabled.
- Since:
- MicroStrategy Web 9.2.2
-
showSubTitleOnly
protected boolean showSubTitleOnly(int subTitleIndex)
Returns whether show only the subtitle for this grid.- Parameters:
subTitleIndex
- Index of the current subtitle (starting from 0).- Returns:
-
getBoneId
protected java.lang.String getBoneId()
Description copied from class:AbstractAppTransform
Returns the id to be used for the JavaScript bone.
This method is used by therenderRegisterBone
method to indicate the id of the bone html element.- Overrides:
getBoneId
in classAbstractAppTransform
- Returns:
- String
- Since:
- MicroStrategy Web 8.0.0
- See Also:
AbstractAppTransform.renderRegisterBone(com.microstrategy.web.beans.MarkupOutput)
-
getAttributesShellDiv
public java.util.Map getAttributesShellDiv()
Returns a Map with the list of attributes that the shell div must use. The shell is the main div surrounding the Transform's output.
This method is being overridden in this subclass to prevent the scriptclass from being rendered twice.- Overrides:
getAttributesShellDiv
in classAbstractAppTransform
- Since:
- MicroStrategy Web 9.0.0
- See Also:
AbstractAppTransform.renderShell(com.microstrategy.web.beans.MarkupOutput)
-
getViewBean
protected ViewBean getViewBean()
- Since:
- MicroStrategy Web 8.0.0
-
getGridData
protected WebGridData getGridData() throws WebBeanException, WebObjectsException
- Throws:
WebBeanException
WebObjectsException
- Since:
- MicroStrategy Web 8.0.0
-
getWebTemplate
protected WebTemplate getWebTemplate() throws WebBeanException, WebObjectsException
- Throws:
WebBeanException
WebObjectsException
- Since:
- MicroStrategy Web 8.0.0
-
getGridWidths
protected WebGridWidths getGridWidths() throws WebBeanException, WebObjectsException
- Throws:
WebBeanException
WebObjectsException
- Since:
- MicroStrategy Web 8.0.0
-
getReportSetting
protected java.lang.String getReportSetting(java.lang.String propertySetName, java.lang.String propertyName)
- Since:
- MicroStrategy Web 8.0.0
-
initializeTransform
public void initializeTransform(Transformable data)
Description copied from class:AbstractReportTransform
This method initialize the private and protected fields of the transform. After calling the initializeTransform on super, it calls initializeProperties if the XMLStatus of the reportBean is WebBeanRequestSuccessful- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractReportTransform
- Parameters:
data
- the bean to transform.
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful". This is the main entry point of the Transform. It will check if a layout-xml has been specified and use it, otherwise it callsrenderContent
.
After the content has been generated it callsrenderJavascript
to generate any necessary client-side information.- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
out
- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
renderJavascript
protected void renderJavascript(MarkupOutput out)
This method renders the javascript code that needs to be generated on the server side because its content is dynamic. In particular this method invokesrenderRegisterBone
which initializes and registers a grid's bone..- Parameters:
out
- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
isQuickSwitchEnabled
protected boolean isQuickSwitchEnabled()
-
getFrameBean
protected FrameBean getFrameBean(WebComponent parent)
- Since:
- MicroStrategy Web 8.1.0
-
getGridScriptClass
protected java.lang.String getGridScriptClass()
return grid JS scriptClass name depending grid mode- Returns:
- string scriptClass name
- Since:
- MicroStrategy Web 9.0.0
-
setBoneProperties
protected void setBoneProperties(JsonGenerator boneProps)
Description copied from class:AbstractAppTransform
Sets the necessary properties to the bone assigned to this transform (based on theAbstractAppTransform.scriptClass
formal parameter)
Usually called byAbstractAppTransform.renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.- Overrides:
setBoneProperties
in classAbstractAppTransform
- Parameters:
boneProps
- the JsonGenerator object that contains the collection of bone properties.
-
generatePageHistoryItems
protected JsonGenerator generatePageHistoryItems(boolean isBackList)
-
getBeanPath
protected java.lang.String getBeanPath()
Description copied from class:AbstractAppTransform
Returns the path within the application of the WebBean being transformed.
When submitting anWebEvent
, this path allows Microstrategy Web to uniquely identify the location of the bean that needs to handle the event.
This method is used by therenderRegisterBone
method to inform the javascript bone the bean to whom it should send its server-side requests.- Overrides:
getBeanPath
in classAbstractAppTransform
- Returns:
- String
- Since:
- MicroStrategy Web 9.0.0
- See Also:
WebComponent.getPath()
,AbstractAppTransform.renderRegisterBone(com.microstrategy.web.beans.MarkupOutput)
-
isGridTransform
protected abstract boolean isGridTransform()
- Since:
- MicroStrategy Web 8.1.0
-
isGraphTransform
protected abstract boolean isGraphTransform()
- Since:
- MicroStrategy Web 8.1.0
-
shouldRenderGridInfo
protected boolean shouldRenderGridInfo()
This method is used to determine if the bone's gridInfo structure needs to be included. As an optimization in the Document page, when executing a document, only the first bone registered for a given grid includes the gridInfo structure.- Returns:
true
if the grid bone properties should include the gridInfo.
-
renderContent
public void renderContent(MarkupOutput out, ReportBean rb)
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.Render content of the transform. It's only used when the report bean is in Successful status. We divide the whole content into 5 areas: TOP/LEFT/CENTER/RIGHT/BOTTOM.+-------------------------------+ | TOP | +-------------------------------+ | | | | | LEFT | |RIGHT | | | CENTER | | | | | | | | | | +-------------------------------+ | BOTTOM | +-------------------------------+
- Specified by:
renderContent
in interfaceReportDataTransform
- Parameters:
out
- MarkupOutput to generate the HTML.rb
- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransform
method).
-
renderTop
public void renderTop(MarkupOutput out, ReportBean rb)
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.Render top area of the transform.- Specified by:
renderTop
in interfaceReportDataTransform
- Parameters:
out
- MarkupOutput to generate the HTML.rb
- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransform
method).
-
renderBottom
public void renderBottom(MarkupOutput out, ReportBean rb)
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.Render bottom area of the transform.- Specified by:
renderBottom
in interfaceReportDataTransform
- Parameters:
out
- MarkupOutput to generate the HTML.rb
- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransform
method).
-
renderLeft
public void renderLeft(MarkupOutput out, ReportBean rb)
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.Render left area of the transform.- Specified by:
renderLeft
in interfaceReportDataTransform
- Parameters:
out
- MarkupOutput to generate the HTML.rb
- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransform
method).
-
renderRight
public void renderRight(MarkupOutput out, ReportBean rb)
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.Render right area of the transform.- Specified by:
renderRight
in interfaceReportDataTransform
- Parameters:
out
- MarkupOutput to generate the HTML.rb
- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransform
method).
-
hasLeft
public boolean hasLeft()
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.Whether the transform has the left area. Out of box, if the formal parameter indicates that we need to display incremental fetch links for column and there are data to the left of the current data, it returns true, or else, it returns false.- Returns:
- Whether the transform has the right area
-
hasRight
public boolean hasRight()
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.Whether the transform has the right area. Out of box, if the formal parameter indicates that we need to display incremental fetch links for column and there are data to the right of the current data, it returns true, or else, it returns false.- Returns:
- Whether the transform has the right area
-
hasTop
public boolean hasTop()
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.Whether the transform has the top area. Out of box, if the formal parameter indicates that we need to display incremental fetch links for row on the top of the data, it returns true, or else, it returns false.- Returns:
- Whether the transform has the top area
-
hasBottom
public boolean hasBottom()
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.Whether the transform has the bottom area. Out of box, if the formal parameter indicates that we need to display incremental fetch links for row on the bottom of the data, it returns true, or else, it returns false.- Returns:
- Whether the transform has the bottom area
-
hasCenter
public abstract boolean hasCenter()
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.Whether the transform has the center area. Out of box, it returns true.- Returns:
- Whether the transform has the center area
-
isCalledFromPrinting
protected boolean isCalledFromPrinting()
Deprecated.The logic of this method is no longer required at this level, print transforms such asReportGridPrintTransform
now handle it. This method now returnsfalse
by default.whether it's displaying for printing.- Returns:
- whether it's displaying for printing
-
renderIncreFetchOnColumnLeftPart
public void renderIncreFetchOnColumnLeftPart(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product. In its place, use/extend therenderColumnsIncrementalFetchPrevious
method.Generates the arrow for the previous set of columns.- Parameters:
out
- MarkupOutput to generate the HTML.rb
- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransform
method).
-
renderIncreFetchOnColumnRightPart
public void renderIncreFetchOnColumnRightPart(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product. In its place, use/extend therenderColumnsIncrementalFetchNext
method.Generates the arrow for the next set of columns.- Parameters:
out
- MarkupOutput to generate the HTML.rb
- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransform
method).
-
renderIncreFetchOnRow
public void renderIncreFetchOnRow(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product. In its place, use/extend therenderRowsIncrementalFetch
method.Generates the rows incremental fetch portion.- Parameters:
out
- MarkupOutput to generate the HTML.rb
- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransform
method).
-
renderRowsIncrementalFetch
public void renderRowsIncrementalFetch(MarkupOutput out)
Generates the rows incremental fetch portion. It just delegates this to another Transform, as specified by theincrementalFetchStyleForRow
formal parameter.- Parameters:
out
- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
supports
public boolean supports(Transformable data)
Extends support by supporting more than one type ofTransformable
.ReportDataTransforms
need to support bothViewBean
andReportBean
- Specified by:
supports
in interfaceTransform
- Overrides:
supports
in classAbstractTransform
- Parameters:
data
- the object to decide if the Transforms supports it- Returns:
- true if
data
is aViewBean
or aReportBean
- Since:
- MicroStrategy Web 8.0.0
- See Also:
Transform.canTransform(com.microstrategy.web.beans.Transformable)
-
supports
public boolean supports(java.lang.Class c)
Extends support by supporting more than oneClass
.ReportDataTransforms
need to support bothViewBean
andReportBean
- Specified by:
supports
in interfaceTransform
- Overrides:
supports
in classAbstractTransform
- Parameters:
c
- the Class to decide if the transforms supports it- Returns:
- true if
c
isViewBean
or aReportBean
- Since:
- MicroStrategy Web 8.0.0
-
isGridEmpty
public boolean isGridEmpty()
Returnstrue
if the grid contains no data.- Since:
- MicroStrategy Web 8.1.0
-
getMetricAxisName
protected int getMetricAxisName()
Returns the name (seeEnumDSSXMLAxisName
of the axis with the metrics in it. Will return -1 if the template contains no metrics, and -2 if there is an error.- Returns:
- int that maps to the values in
EnumDSSXMLAxisName
. - Since:
- MicroStrategy Web 9.0.0
-
getDisplayMode
public int getDisplayMode(WebDrillPath dp)
Returns the display mode when drilling via the given drill path- Parameters:
dp
- Drill Path- Since:
- MicroStrategy Web 9.0.0
-
getID
public java.lang.String getID()
Description copied from class:AbstractAppTransform
Returns the unique name of the component to be used as the ID for its shell. This id is used for updating the page using the iFrame technology, and as the id for the corresponding bone (if any).- Specified by:
getID
in interfaceTransform
- Overrides:
getID
in classAbstractAppTransform
- Returns:
- the component's unique id
- Since:
- MicroStrategy Web 9.0.0
-
createBlockEditorProperties
protected void createBlockEditorProperties()
Deprecated.This method adds all of the grid/graph Report Services properties to the client side properties collection.- Since:
- MicroStrategy Web 9.0.0
-
createBlockEditorProperties
protected void createBlockEditorProperties(JsonGenerator boneProps)
This method adds all of the grid/graph Report Services properties to the client side properties collection.
-
-