Package com.microstrategy.web.app.beans

Class DrillEditorBeanImpl

    • Constructor Detail

      • DrillEditorBeanImpl

        public DrillEditorBeanImpl()
        Default constructor

    • Method Detail

      • getIsDHTML

        protected boolean getIsDHTML()

      • getTagsFactory

        protected TagsFactory getTagsFactory()

      • isEnabled

        public boolean isEnabled()
        Checks if a bean is enabled
        Specified by:
        isEnabled in interface FrameElement
        Returns:
        True if the bean is enabled.

      • isGridDataNecessary

        public boolean isGridDataNecessary()
        Description copied from class: AbstractPersistableFrameElement
        This method indicates the report frame that the element requires the grid for information. Editors that requires to grid data for their input should override this method, since by default it returns false. This method is implemented for the ReportFrameElement interface.
        Specified by:
        isGridDataNecessary in interface ReportFrameElement
        Overrides:
        isGridDataNecessary in class AbstractPersistableFrameElement
        Returns:
        True since this editor requires the grid data.

      • getTitle

        public java.lang.String getTitle()
        Returns the title of the editor "DRILL" or "DRILL - Advanced, depending on the mode"
        Specified by:
        getTitle in class AbstractFrameEditorBean
        Returns:
        the title of the editor

      • initEditor

        public void initEditor​(Editor editor)
        Extends initEditor by settings flags to display only Close and Help.
        Overrides:
        initEditor in class AbstractFrameEditorBean
        Parameters:
        editor - the Editor instance used to render.

      • showSimpledDrillEditor

        protected void showSimpledDrillEditor​(ReportBean rb,
                                      MarkupOutput out)
        Renders the contents of the simple drill editor.
        Parameters:
        rb - The report bean for which we are rendering the drill information
        out - MarkupOutput instance where to save the HTML content to output for this instance.

      • showSimpledDrillEditorHiddenInput

        protected void showSimpledDrillEditorHiddenInput​(MarkupOutput out)
        Renders the hidden contents of the simple drill editor.
        Parameters:
        out - MarkupOutput instance where to save the HTML content to output for this instance.

      • sortSetNamesAndDrillPaths

        protected boolean sortSetNamesAndDrillPaths()
        Determines if we need to sort set names and drill paths based on a preference.
        Returns:
        true if we need to sort set names and drill paths based on a preference.
        Since:
        MicroStrategy Web 8.0.0

      • renderCell

        protected void renderCell​(ReportBean rb,
                          WebTitle title,
                          MarkupOutput out)
        Renders one cell for the current WebTitle for the simple drill editor. Thsi will render all the drill paths which a user can drill from the current WebTitle.
        Parameters:
        rb - The report bean for which we are rendering the drill information.
        title - The WebTitle for which the cell is rendering drill paths for
        out - MarkupOutput instance where to save the HTML content to output for this instance.

      • getOnClickJS

        protected java.lang.String getOnClickJS()

      • showAdvancedDrillEditor

        protected void showAdvancedDrillEditor​(ReportBean rb,
                                       MarkupOutput out)
        Renders the contents of the advanced drill editor.
        Parameters:
        rb - The report bean for which we are rendering the drill information
        out - MarkupOutput instance where to save the HTML content to output for this instance.

      • showAdvancedDrillEditorTable

        protected void showAdvancedDrillEditorTable​(ReportBean rb,
                                            java.lang.String sTitleName,
                                            WebEvent changeDimEvent,
                                            java.lang.StringBuffer sScript,
                                            java.lang.StringBuffer sScriptValues,
                                            MarkupOutput out)
                                     throws WebBeanException
        Renders the visible contents of the advanced drill editor.
        Parameters:
        rb - The report bean for which we are rendering the drill information
        sTitleName -
        changeDimEvent -
        sScript -
        sScriptValues -
        out - MarkupOutput instance where to save the HTML content to output for this instance.
        Throws:
        WebBeanException

      • setAdvancedDrillEditor

        public void setAdvancedDrillEditor​(boolean flag)
        Sets the drill editor display flag to show the advanced drill editor.
        Specified by:
        setAdvancedDrillEditor in interface DrillEditorBean
        Parameters:
        flag - set to true for advanced drill

      • getAdvancedDrillEditor

        public boolean getAdvancedDrillEditor()
        Gets the drill editor display flag to show the advanced drill editor.
        Specified by:
        getAdvancedDrillEditor in interface DrillEditorBean
        Returns:
        true if the advanced drill editor is on

      • setAdvancedDrillTitleAxis

        public void setAdvancedDrillTitleAxis​(int axis)
        Set the Axis of the Title to be shown in the Advanced Drill Editor
        Specified by:
        setAdvancedDrillTitleAxis in interface DrillEditorBean
        Parameters:
        axis - the axis to be shown in the editor

      • getAdvancedDrillTitleAxis

        public int getAdvancedDrillTitleAxis()
        Description copied from interface: DrillEditorBean
        Gets the Axis type of the Title that is shown in the Advanced Drill Editor
        Specified by:
        getAdvancedDrillTitleAxis in interface DrillEditorBean
        Returns:
        the Axis of the Title to be shown in the Advanced Drill Editor

      • setAdvancedDrillTitlePosition

        public void setAdvancedDrillTitlePosition​(int position)
        Set the Position of the Title to be shown in the Advanced Drill Editor
        Specified by:
        setAdvancedDrillTitlePosition in interface DrillEditorBean
        Parameters:
        position - the position ob the title to be shown

      • getSelectedDrillDimension

        public java.lang.String getSelectedDrillDimension()
        Description copied from interface: DrillEditorBean
        Gets the Dimension in the Advanced Drill Editor
        Specified by:
        getSelectedDrillDimension in interface DrillEditorBean
        Returns:
        the SelectedDrillDimension in the Advanced Drill Editor

      • setSelectedDrillDimension

        public void setSelectedDrillDimension​(java.lang.String drillDimension)
        Sets the SelectedDrillDimension in the Advanced Drill Editor
        Specified by:
        setSelectedDrillDimension in interface DrillEditorBean
        Parameters:
        drillDimension - the dimention selected

      • getAdvancedDrillTitlePosition

        public int getAdvancedDrillTitlePosition()
        Description copied from interface: DrillEditorBean
        Gets the Position of the Title to be shown in the Advanced Drill Editor. This is the position of the title with respect to the position of other titles on the same axis.
        Specified by:
        getAdvancedDrillTitlePosition in interface DrillEditorBean
        Returns:
        the Position of the Title to be shown in the Advanced Drill Editor

      • setDrillRetainThresholds

        public void setDrillRetainThresholds​(java.lang.String value)
        Sets the value for retaining thresholds
        Specified by:
        setDrillRetainThresholds in interface DrillEditorBean
        Parameters:
        value - the retaining thresholds value

      • getDrillRetainThresholds

        public java.lang.String getDrillRetainThresholds()
        Description copied from interface: DrillEditorBean
        Gets the value for retaining thresholds on drilling.
        Specified by:
        getDrillRetainThresholds in interface DrillEditorBean
        Returns:
        the value for retaining thresholds

      • setDrillRetainParent

        public void setDrillRetainParent​(java.lang.String value)
        Sets the value for retaining parent
        Specified by:
        setDrillRetainParent in interface DrillEditorBean
        Parameters:
        value - the retaining parent value

      • getDrillRetainParent

        public java.lang.String getDrillRetainParent()
        Description copied from interface: DrillEditorBean
        Gets the value for retaining parent on drilling.
        Specified by:
        getDrillRetainParent in interface DrillEditorBean
        Returns:
        the value for retaining parent

      • setPreselectDrillOptions

        public void setPreselectDrillOptions​(boolean value)
        Sets the value for retaining parent
        Specified by:
        setPreselectDrillOptions in interface DrillEditorBean
        Parameters:
        value - the retaining parent value
        Since:
        MicroStrategy Web 8.0.0

      • getPreselectDrillOptions

        public boolean getPreselectDrillOptions()
        Description copied from interface: DrillEditorBean
        Gets the value for the property of the editor that determines whether the options in the drill editor will be pre-selected with the drill path of high importance. The default behavior will not preselect any option in the editor. To change this, add an init-property to the drill editor bean in the pageConfig.xml
        Specified by:
        getPreselectDrillOptions in interface DrillEditorBean
        Returns:
        the value for retaining parent
        Since:
        MicroStrategy Web 8.0.0

      • getShowUniqueDrillPaths

        public boolean getShowUniqueDrillPaths()

      • setShowUniqueDrillPaths

        public void setShowUniqueDrillPaths​(boolean value)
        Description copied from interface: DrillEditorBean
        Sets the value for the property of the editor that determines whether the unique drill paths be shown in the drill editor. The default behavior will retain duplicate drill paths in the editor. To change this, change/add an init-property "showUniqueDrillPaths" to the drill editor bean in the pageConfig.xml
        Specified by:
        setShowUniqueDrillPaths in interface DrillEditorBean
        Parameters:
        value - boolean

      • populateAttributeList

        protected void populateAttributeList​(ReportBean rb,
                                     MarkupOutput out,
                                     WebTitle wt,
                                     java.lang.String dimensionName)
        Populates the list of drill paths for the selected drill dimension in the advanced drill editor.
        Parameters:
        rb - The report bean for which we are rendering the drill information.
        wt - The WebTitle for which the cell is rendering drill paths for.
        out - MarkupOutput instance where to save the HTML content to output for this instance.
        dimensionName - The name of the dimension for which we are rendering the drill paths.

      • getCountOptionsForSimpleDrill

        public int getCountOptionsForSimpleDrill()
        Returns the count for the number of drill paths in the simple drill editor. This is used in the unit test for validation purposes.
        Returns:
        The count for the number of drill paths in the simple drill editor.