public interface

DrillEditorBean

implements ReportFrameElement
com.microstrategy.web.app.beans.DrillEditorBean
Known Indirect Subclasses

Class Overview

This is the editor which enables the end user to drill on a particular report. The advanced drill editor can also be opened from this editor for more advanced drilling functionality.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract boolean getAdvancedDrillEditor()
Gets the drill editor display flag to show the Advanced Drill Editor.
abstract int getAdvancedDrillTitleAxis()
Gets the Axis type of the Title that is shown in the Advanced Drill Editor
abstract int getAdvancedDrillTitlePosition()
Gets the Position of the Title to be shown in the Advanced Drill Editor.
abstract String getDrillRetainParent()
Gets the value for retaining parent on drilling.
abstract String getDrillRetainThresholds()
Gets the value for retaining thresholds on drilling.
abstract boolean getPreselectDrillOptions()
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.
abstract String getSelectedDrillDimension()
Gets the Dimension in the Advanced Drill Editor
abstract void setAdvancedDrillEditor(boolean flag)
Sets the drill editor display flag to show the Advanced Drill Editor.
abstract void setAdvancedDrillTitleAxis(int axis)
Set the Axis type of the Title to be shown in the Advanced Drill Editor
abstract void setAdvancedDrillTitlePosition(int position)
Set the Position of the Title to be shown in the Advanced Drill Editor.
abstract void setDrillRetainParent(String value)
Sets the value for retaining parent on drilling.
abstract void setDrillRetainThresholds(String value)
Sets the value for retaining thresholds on drilling.
abstract void setPreselectDrillOptions(boolean preselectDrillOptions)
Sets 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.
abstract void setSelectedDrillDimension(String drillDimension)
Sets the Dimension to be shown in the in the Advanced Drill Editor
abstract void setShowUniqueDrillPaths(boolean showUniqueDrillPaths)
Sets the value for the property of the editor that determines whether the unique drill paths be shown in the drill editor.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.FrameElement
From interface com.microstrategy.web.app.beans.ReportFrameElement
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract boolean getAdvancedDrillEditor ()

Gets the drill editor display flag to show the Advanced Drill Editor.

Returns
  • true if the advanced drill editor is on

public abstract int getAdvancedDrillTitleAxis ()

Gets the Axis type of the Title that is shown in the Advanced Drill Editor

Returns
  • The integer value of the axis type of the title for which the Advanced Drill Editor is shown.

public abstract int getAdvancedDrillTitlePosition ()

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.

Returns
  • The position of the Title for the Advanced Drill Editor.

public abstract String getDrillRetainParent ()

Gets the value for retaining parent on drilling.

Returns
  • The value set for retaining the parent on drilling.

public abstract String getDrillRetainThresholds ()

Gets the value for retaining thresholds on drilling.

Returns
  • The value set for retaining the thresholds on drilling.

public abstract boolean getPreselectDrillOptions ()

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

Returns
  • boolean value indicating if the options should be preselected or not.

public abstract String getSelectedDrillDimension ()

Gets the Dimension in the Advanced Drill Editor

Returns
  • The dimension to be shown in the Advanced Drill Editor

public abstract void setAdvancedDrillEditor (boolean flag)

Sets the drill editor display flag to show the Advanced Drill Editor.

Parameters
flag set to true for advanced drill

public abstract void setAdvancedDrillTitleAxis (int axis)

Set the Axis type of the Title to be shown in the Advanced Drill Editor

Parameters
axis The axis type of the title for which the Advanced Drill Editor is to be shown.

public abstract void setAdvancedDrillTitlePosition (int position)

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

Parameters
position The position of the Title for the Advanced Drill Editor.

public abstract void setDrillRetainParent (String value)

Sets the value for retaining parent on drilling.

Parameters
value The value for retaining the parent for drilling.

public abstract void setDrillRetainThresholds (String value)

Sets the value for retaining thresholds on drilling. This could be one of the values from DRILL_RETAIN_THRESHOLDS_NO or DRILL_RETAIN_THRESHOLDS_YES or DRILL_RETAIN_THRESHOLDS_USE_DRILL_PATH

Parameters
value The value for retaining the thresholds for drilling.

public abstract void setPreselectDrillOptions (boolean preselectDrillOptions)

Sets 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

Parameters
preselectDrillOptions boolean

public abstract void setSelectedDrillDimension (String drillDimension)

Sets the Dimension to be shown in the in the Advanced Drill Editor

Parameters
drillDimension The value of the dimension to be shown in the Advanced Drill Editor

public abstract void setShowUniqueDrillPaths (boolean showUniqueDrillPaths)

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

Parameters
showUniqueDrillPaths boolean