AbstractReportDataTransform

This is the image name for blank space.

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.

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.

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.

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.

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.

This is the image name for the left arrow image in incremental fetch.

This is the image name for the right arrow image in incremental fetch.

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"

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.

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.

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.

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.

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.

name for the formal parameter "customJavaScriptFeatures".

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";

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.

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

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.

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.

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.

It is used to identify the outer shell for all report modes - grid, graph and gridgraph. (Firefox issue: 246019)

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 the resourcesFolderImage application configuration parameter.

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 the resourcesFolderImage application configuration parameter.

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.

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

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

This Formal Parameter is used to indicate the bone ID for the RWB viewer. Allowed Values: any String.

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.

It is used in the transform to specify whether to show increfetch links on column.
Allowed Values: TRUE/FALSE.

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.

It is used in the transform to specify whether to show increfetch links for rows on top of the grid.
Allowed Values: TRUE/FALSE.

Controls whether subtitles (attribute forms) are to be displayed for this grid. Allowed Values:

• PREFERENCE_NO ("0"): subtitles are off.
• PREFERENCE_YES ("1"): subtitles are on.
• PREFERENCE_VALUE_FROM_REPORT ("3"):the "LongNames" report setting controls whether subtitles are on or off.

It is used in the transform to specify whether to show the set names and drill paths names alphabetically sorted.
Allowed Values: TRUE/FALSE.

The tranform context object represented as a hashtable.
All the items' keys are listed as constants in ReportTransformHelper.

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.

Class constructor.

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.

Returns the display mode when drilling via the given drill path

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

Get the context object associated with the transform.

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.

Whether the transform has the center area. Out of box, it returns true.

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.

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.

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.

Initialize the css classes to be used by this transform.

initialize the images for the transform.

Extends initializeProperties by invoking initializeTranformContext

Initialize the transform context object. This object is later passed to the ReportGridDisplayCell instances so they have information about the transform.

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

This method initialize WebComponent being transformed. This method enables the transform to support both ReportBean and ViewBean.
Internally, when a ReportBean is passed, this Transform will get its ViewBean and call super using the ViewBean. Starting with 8.0, ReportDataTransforms manipulates instances of ViewBean's.

Returns true if the grid contains no data.

Render bottom area of the transform.

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       	        |
 +-------------------------------+
 

Generates the arrow for the previous set of columns.

Generates the arrow for the next set of columns.

Generates the rows incremental fetch portion.

Render left area of the transform.

Render right area of the transform.

Generates the rows incremental fetch portion. It just delegates this to another Transform, as specified by the incrementalFetchStyleForRow formal parameter.

Render top area of the transform.

Extends support by supporting more than one type of Transformable. ReportDataTransforms need to support both ViewBean and ReportBean

Extends support by supporting more than one Class. ReportDataTransforms need to support both ViewBean and ReportBean

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 calls renderContent.
After the content has been generated it calls renderJavascript to generate any necessary client-side information.

This method adds all of the grid/graph Report Services properties to the client side properties collection.

This method adds all of the grid/graph Report Services properties to the client side properties collection.

Returns the path within the application of the WebBean being transformed.
When submitting an WebEvent, this path allows Microstrategy Web to uniquely identify the location of the bean that needs to handle the event.
This method is used by the renderRegisterBone method to inform the javascript bone the bean to whom it should send its server-side requests.

Returns the id to be used for the JavaScript bone.
This method is used by the renderRegisterBone method to indicate the id of the bone html element.

return grid JS scriptClass name depending grid mode

Returns the name (see EnumDSSXMLAxisName of the axis with the metrics in it. Will return -1 if the template contains no metrics, and -2 if there is an error.

whether it's displaying for printing.

This method renders the javascript code that needs to be generated on the server side because its content is dynamic. In particular this method invokes renderRegisterBone which initializes and registers a grid's bone..

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.

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 whether show only the subtitle for this grid.

Returns whether subtitles are enabled for this grid. It will check the value of the showSubtitle formal parameter. This could be:

• PREFERENCE_NO: subtitles are off.
• PREFERENCE_YES: subtitles are on.
• PREFERENCE_VALUE_FROM_REPORT: the "LongNames" report setting controls whether subtitles are on or off.

Returns whether subtitles are enabled for this grid. It will check the value of the showSubtitle formal parameter. This could be:

• PREFERENCE_NO: subtitles are off.
• PREFERENCE_YES: subtitles are on.
• 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