Package com.microstrategy.web.app.transforms

Class AbstractReportDataVisualizationTransform

    • Field Detail

      • reportXMLStyle

        public FormalParameter reportXMLStyle
        The name of the style to use to generate the custom report XML Allowed values: String value that corresponds to a style on the styleCatalog.

      • reportXMLPageName

        public FormalParameter reportXMLPageName
        The name of the page on the pageConfig that returns the custom report XML.
        Used to generate the URL for the custom report XML. Allowed values: String value that corresponds to a page name on the pageConfig.

      • useAbsoluteURLs

        public FormalParameter useAbsoluteURLs
        Whether to use an absolute path on the CustomURL FlashVar
        Since:
        MicroStrategy Web 8.1.0

      • documentStyle

        public FormalParameter documentStyle
        The RWBean transform's style that will transform the view bean for obtaining the custom report XML for grids in documents Allowed values: String value that corresponds to a style on the styleCatalog.
        Since:
        MicroStrategy Web 8.1.1

      • rwPageName

        public FormalParameter rwPageName
        The name of the page on the pageConfig that returns the custom report XML for grids in documents.
        Used to generate the URL for the custom report XML for grids in documents Allowed values: String value that corresponds to a page name on the pageConfig.
        Since:
        MicroStrategy Web 8.1.1

      • renderShell

        public FormalParameter renderShell
        Whether to render the shell (DIV tag) that allows the visualization to have a grid bone.
        This is not necessary when the visualization is displayed inside an Iframe
        Since:
        MicroStrategy Web 8.1.2

      • renderElementListOnSelectionDataJson

        public FormalParameter renderElementListOnSelectionDataJson
        Whether to add a list of the elements to the selectionData JSON object. This list can be used to map names to element IDs and obtain metric values (used for the US Map Visualization sample).

      • containerWidth

        protected FormalParameter containerWidth
        Specifies the width (in any measure accepted by the web-browser) of the element rendered by this transform. Its value can be specified on the request as "containerWidth" and this will overwrite the existing value.

      • containerHeight

        protected FormalParameter containerHeight
        Specifies the height (in any measure accepted by the web-browser) of the element rendered by this transform. Its value can be specified on the request as "containerHeight" and this will overwrite the existing value.

      • mojoWidgetId

        protected java.lang.String mojoWidgetId

    • Constructor Detail

      • AbstractReportDataVisualizationTransform

        public AbstractReportDataVisualizationTransform()

    • Method Detail

      • isDesignMode

        protected boolean isDesignMode()
        Description copied from class: AbstractReportTransform
        This methods allows the transform to identify if concrete subclasses are designed to work in design mode, or in execute mode.
        Overrides:
        isDesignMode in class AbstractReportTransform
        Returns:
        false by default. Any inherting class should override to implement its own version.

      • renderEmptyCase

        public void renderEmptyCase​(MarkupOutput out,
                            ReportBean rb)
        Description copied from interface: ReportDataTransform
        Render when the report grid/graph is empty.
        Usually some information message is displayed.
        Parameters:
        out - output by this transform
        rb - this report bean

      • renderLayout

        public void renderLayout​(MarkupOutput out,
                         ReportBean rb)
        Description copied from interface: ReportDataTransform
        Render the layout for the report grid.
        The CENTER area of the transform has layout on top and data on bottom.
        Parameters:
        out - output by this transform
        rb - this report bean

      • renderData

        public void renderData​(MarkupOutput out,
                       ReportBean rb)
        Description copied from interface: ReportDataTransform
        Render the report data area.
        The CENTER area of the transform has layout on top and data on bottom.
        Parameters:
        out - output by this transform
        rb - this report bean

      • renderCenter

        public void renderCenter​(MarkupOutput out,
                         ReportBean rb)
        Description copied from interface: ReportDataTransform
        Render center area of the transform.
        Parameters:
        out - output by this transform
        rb - this report bean

      • renderVisualization

        public abstract void renderVisualization​(MarkupOutput out)
        Renders the visualization's content (i.e. the embedded flash object)
        Parameters:
        out - The Markup output

      • getAttributesBone

        public java.util.Map getAttributesBone()

      • getCustomReportXML

        protected java.lang.String getCustomReportXML()
        Returns:
        the report XML specified by the formal parameter "reportXMLStyle"

      • getURLForCustomReportXML

        protected java.lang.String getURLForCustomReportXML()
        Returns a URL that can be used to obtain the report XML of the current report being transformed.
        To generate the XML it uses the style specified by "reportXMLStyle"
        Returns:
        a URL that can be used to obtain the report XML of the current report being transformed.

      • getBaseURL

        protected ParameterBuilder getBaseURL​(boolean useAbsoluteURL)
        Returns a ParameterBuilder object that contains a base URL.
        This object is initialized with the TargetBase, TargetPrefix and contains the session manager state which is used in URLs as argument EnumWebParameters.WebSessionManagerState to restore the session.
        Parameters:
        useAbsoluteURL - whether to use an absolute URL
        Returns:
        a ParameterBuilder object that contains a base URL.
        Since:
        MicroStrategy Web 8.1.0

      • getTaskURLForCustomReportXML

        protected java.lang.String getTaskURLForCustomReportXML()
        Returns a URL that can be used to obtain the report XML of the current report being transformed.
        The URL uses the Tasks infrastructure
        Returns:
        a URL that can be used to obtain the report XML of the current report being transformed.
        Since:
        MicroStrategy Web 8.1.0

      • getTaskURLForReportContent

        protected java.lang.String getTaskURLForReportContent​(java.lang.String contentType)
        Returns a URL that can be used to obtain the report data of the current report being transformed.
        The URL uses the Tasks infrastructure
        Parameters:
        contentType - the type of data expected (xml, json, html)
        Returns:
        a URL that can be used to obtain the report data of the current report being transformed.

      • getTaskURLForReportData

        protected ParameterBuilder getTaskURLForReportData​(java.lang.String contentType)
        Returns a URL that can be used to obtain the report data of the current report being transformed.
        The URL uses the Tasks infrastructure
        Parameters:
        contentType - the type of data expected (xml, json, html)
        Returns:
        a URL that can be used to obtain the report data of the current report being transformed.

      • getResultFlags

        protected java.lang.String getResultFlags​(int viewMode)

      • getTaskBaseURL

        protected ParameterBuilder getTaskBaseURL()
        Returns a ParameterBuilder object that contains a base URL which can be used to invoke a Task on the Tasks infrastructure to get XML content.
        This object is initialized with the TargetBase, TargetPrefix and contains the session manager state which is used in URLs as argument EnumWebParameters.WebSessionManagerState to restore the session.
        Returns:
        a ParameterBuilder object that contains a base URL which can be used to invoke a Task on the Tasks infrastructure.
        Since:
        MicroStrategy Web 8.1.0

      • getTaskBaseURL

        protected ParameterBuilder getTaskBaseURL​(java.lang.String contentType)
        Returns a ParameterBuilder object that contains a base URL which can be used to invoke a Task on the Tasks infrastructure.
        This object is initialized with the TargetBase, TargetPrefix and contains the session manager state which is used in URLs as argument EnumWebParameters.WebSessionManagerState to restore the session.
        Parameters:
        contentType - the type of data expected (xml, json, html)
        Returns:
        a ParameterBuilder object that contains a base URL which can be used to invoke a Task on the Tasks infrastructure.
        Since:
        MicroStrategy Web 8.1.0

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: Transform
        Returns a textual description of the transform.
        Returns:
        The textual description of the transform.

      • getGridKeys

        protected java.lang.String getGridKeys()

      • setBoneProperties

        protected void setBoneProperties​(JsonGenerator boneProps)
        Add the "selectionData" property on the grid bone.
        Overrides:
        setBoneProperties in class AbstractReportDataTransform
        Parameters:
        boneProps - the JsonGenerator object that contains the collection of bone properties.

      • getSelectionDataJSON

        protected JsonGenerator getSelectionDataJSON()
        Returns:
        a JSON object that contains a list of the row headers on the grid, it has the following format:
        { "Region": { "South": { "code": "microstrategy.bone..." "metrics": "$ 3,075,727" } "Central":... } "Year": {...} } This JSON object only contains information about the first row header and first metric on the report.

      • getControlLinksJson

        protected JsonGenerator getControlLinksJson()

      • getRWBean

        protected RWBean getRWBean()
        Since:
        MicroStrategy Web 8.1.1

      • getWebReportGrid

        protected WebReportGrid getWebReportGrid()
        Since:
        MicroStrategy Web 8.1.2

      • getMojoWidgetId

        public java.lang.String getMojoWidgetId()

      • setMojoWidgetId

        public void setMojoWidgetId​(java.lang.String mojoWidgetId)