public class

DrillEditorBeanImpl

extends AbstractFrameEditorBean
implements DrillEditorBean
java.lang.Object
   ↳ com.microstrategy.utils.serialization.AbstractPersistable
     ↳ com.microstrategy.web.beans.AbstractTransformable
       ↳ com.microstrategy.web.beans.AbstractWebComponent
         ↳ com.microstrategy.web.app.beans.AbstractAppComponent
           ↳ com.microstrategy.web.app.beans.AbstractPersistableAppComponent
             ↳ com.microstrategy.web.app.beans.AbstractPersistableFrameElement
               ↳ com.microstrategy.web.app.beans.AbstractFrameEditorBean
                 ↳ com.microstrategy.web.app.beans.DrillEditorBeanImpl

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
Public Constructors
DrillEditorBeanImpl()
Default constructor
Public Methods
boolean getAdvancedDrillEditor()
Gets the drill editor display flag to show the advanced drill editor.
int getAdvancedDrillTitleAxis()
Gets the Axis type of the Title that is shown in the Advanced Drill Editor
int getAdvancedDrillTitlePosition()
Gets the Position of the Title to be shown in the Advanced Drill Editor.
int getCountOptionsForSimpleDrill()
Returns the count for the number of drill paths in the simple drill editor.
String getDrillRetainParent()
Gets the value for retaining parent on drilling.
String getDrillRetainThresholds()
Gets the value for retaining thresholds on drilling.
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.
String getSelectedDrillDimension()
Gets the Dimension in the Advanced Drill Editor
boolean getShowUniqueDrillPaths()
String getTitle()
Returns the title of the editor "DRILL" or "DRILL - Advanced, depending on the mode"
void initEditor(Editor editor)
Extends initEditor by settings flags to display only Close and Help.
boolean isEnabled()
Checks if a bean is enabled
boolean isGridDataNecessary()
This method indicates the report frame that the element requires the grid for information.
void renderEditorContent(MarkupOutput out)
Renders the content of an editor.
void setAdvancedDrillEditor(boolean flag)
Sets the drill editor display flag to show the advanced drill editor.
void setAdvancedDrillTitleAxis(int axis)
Set the Axis of the Title to be shown in the Advanced Drill Editor
void setAdvancedDrillTitlePosition(int position)
Set the Position of the Title to be shown in the Advanced Drill Editor
void setDrillRetainParent(String value)
Sets the value for retaining parent
void setDrillRetainThresholds(String value)
Sets the value for retaining thresholds
void setPreselectDrillOptions(boolean value)
Sets the value for retaining parent
void setSelectedDrillDimension(String drillDimension)
Sets the SelectedDrillDimension in the Advanced Drill Editor
void setShowUniqueDrillPaths(boolean value)
Sets the value for the property of the editor that determines whether the unique drill paths be shown in the drill editor.
Protected Methods
void doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)
Proceses the save/restore state opperation of the AppComponent
boolean getIsDHTML()
String getOnClickJS()
TagsFactory getTagsFactory()
WebEventHandler newDefaultEventHandler()
void populateAttributeList(ReportBean rb, MarkupOutput out, WebTitle wt, String dimensionName)
Populates the list of drill paths for the selected drill dimension in the advanced drill editor.
void renderCell(ReportBean rb, WebTitle title, MarkupOutput out)
Renders one cell for the current WebTitle for the simple drill editor.
void setHelpEventInformation(Editor editor)
This method is deprecated. No replacement.
void showAdvancedDrillEditor(ReportBean rb, MarkupOutput out)
Renders the contents of the advanced drill editor.
void showAdvancedDrillEditorTable(ReportBean rb, String sTitleName, WebEvent changeDimEvent, StringBuffer sScript, StringBuffer sScriptValues, MarkupOutput out)
Renders the visible contents of the advanced drill editor.
void showSimpledDrillEditor(ReportBean rb, MarkupOutput out)
Renders the contents of the simple drill editor.
void showSimpledDrillEditorHiddenInput(MarkupOutput out)
Renders the hidden contents of the simple drill editor.
void showSimpledDrillEditorTable(ReportBean rb, MarkupOutput out)
Renders the visible contents of the simple drill editor.
boolean sortSetNamesAndDrillPaths()
Determines if we need to sort set names and drill paths based on a preference.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.beans.AbstractFrameEditorBean
From class com.microstrategy.web.app.beans.AbstractPersistableFrameElement
From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
From class com.microstrategy.web.app.beans.AbstractAppComponent
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.DrillEditorBean
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 Constructors

public DrillEditorBeanImpl ()

Default constructor

Public Methods

public boolean getAdvancedDrillEditor ()

Gets the drill editor display flag to show the advanced drill editor.

Returns
  • true if the advanced drill editor is on

public int getAdvancedDrillTitleAxis ()

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

Returns
  • the Axis of the Title to be shown in the Advanced Drill Editor

public 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 to be shown in the Advanced Drill Editor

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.

public String getDrillRetainParent ()

Gets the value for retaining parent on drilling.

Returns
  • the value for retaining parent

public String getDrillRetainThresholds ()

Gets the value for retaining thresholds on drilling.

Returns
  • the value for retaining thresholds

public 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
  • the value for retaining parent

public String getSelectedDrillDimension ()

Gets the Dimension in the Advanced Drill Editor

Returns
  • the SelectedDrillDimension in the Advanced Drill Editor

public boolean getShowUniqueDrillPaths ()

public String getTitle ()

Returns the title of the editor "DRILL" or "DRILL - Advanced, depending on the mode"

Returns
  • the title of the editor

public void initEditor (Editor editor)

Extends initEditor by settings flags to display only Close and Help.

Parameters
editor the Editor instance used to render.

public boolean isEnabled ()

Checks if a bean is enabled

Returns
  • True if the bean is enabled.

public boolean isGridDataNecessary ()

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.

Returns
  • True since this editor requires the grid data.

public void renderEditorContent (MarkupOutput out)

Renders the content of an editor.

Parameters
out MarkupOutput instance where to save the HTML content to output for this instance.

public 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 void setAdvancedDrillTitleAxis (int axis)

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

Parameters
axis the axis to be shown in the editor

public void setAdvancedDrillTitlePosition (int position)

Set the Position of the Title to be shown in the Advanced Drill Editor

Parameters
position the position ob the title to be shown

public void setDrillRetainParent (String value)

Sets the value for retaining parent

Parameters
value the retaining parent value

public void setDrillRetainThresholds (String value)

Sets the value for retaining thresholds

Parameters
value the retaining thresholds value

public void setPreselectDrillOptions (boolean value)

Sets the value for retaining parent

Parameters
value the retaining parent value

public void setSelectedDrillDimension (String drillDimension)

Sets the SelectedDrillDimension in the Advanced Drill Editor

Parameters
drillDimension the dimention selected

public void setShowUniqueDrillPaths (boolean value)

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
value boolean

Protected Methods

protected void doFlatState (FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)

Proceses the save/restore state opperation of the AppComponent

Parameters
serializer an instance of the FlatStateSerializer object to use
howMuchState defines how much information needs to be saved
tokenizer an instance of the FlatStateTokenizer object to use

protected boolean getIsDHTML ()

protected String getOnClickJS ()

protected TagsFactory getTagsFactory ()

protected WebEventHandler newDefaultEventHandler ()

protected void populateAttributeList (ReportBean rb, MarkupOutput out, WebTitle wt, 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.
out MarkupOutput instance where to save the HTML content to output for this instance.
wt The WebTitle for which the cell is rendering drill paths for.
dimensionName The name of the dimension for which we are rendering the drill paths.

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.

protected void setHelpEventInformation (Editor editor)

This method is deprecated.
No replacement.

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.

protected void showAdvancedDrillEditorTable (ReportBean rb, String sTitleName, WebEvent changeDimEvent, StringBuffer sScript, StringBuffer sScriptValues, MarkupOutput out)

Renders the visible 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.

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.

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.

protected void showSimpledDrillEditorTable (ReportBean rb, MarkupOutput out)

Renders the visible 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.
Throws
WebBeanException
WebObjectsException
WebBeanException

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.