Package com.microstrategy.web.app.beans

Class DrillEditorBeanImpl

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

All Implemented Interfaces:

EnumWebPersistableState, Persistable, AppComponent, DrillEditorBean, FrameElement, ReportFrameElement, RequestPersistable, Transformable, WebComponent

public class DrillEditorBeanImpl
extends AbstractFrameEditorBean
implements DrillEditorBean

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

STATE_DELIMITOR, STATE_ITEM_SEPARATOR

Fields inherited from class com.microstrategy.web.beans.AbstractWebComponent

_features, _hasJustOpened

Fields inherited from class com.microstrategy.web.beans.AbstractTransformable

_beanContext

Fields inherited from class com.microstrategy.utils.serialization.AbstractPersistable

scriptEndTagEncoder

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent

COMPONENT_POSITION_NOT_INITIALIZED

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Constructor Summary

Constructors

Constructor	Description
DrillEditorBeanImpl()	Default constructor

Method Summary

Modifier and Type	Method	Description
protected void	doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)	Proceses the save/restore state opperation of the AppComponent
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.
java.lang.String	getDrillRetainParent()	Gets the value for retaining parent on drilling.
java.lang.String	getDrillRetainThresholds()	Gets the value for retaining thresholds on drilling.
protected boolean	getIsDHTML()
protected java.lang.String	getOnClickJS()
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.
java.lang.String	getSelectedDrillDimension()	Gets the Dimension in the Advanced Drill Editor
boolean	getShowUniqueDrillPaths()
protected TagsFactory	getTagsFactory()
java.lang.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.
protected WebEventHandler	newDefaultEventHandler()
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.
protected void	renderCell(ReportBean rb, WebTitle title, MarkupOutput out)	Renders one cell for the current WebTitle for the simple drill editor.
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(java.lang.String value)	Sets the value for retaining parent
void	setDrillRetainThresholds(java.lang.String value)	Sets the value for retaining thresholds
protected void	setHelpEventInformation(Editor editor)	Deprecated.
void	setPreselectDrillOptions(boolean value)	Sets the value for retaining parent
void	setSelectedDrillDimension(java.lang.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 void	showAdvancedDrillEditor(ReportBean rb, MarkupOutput out)	Renders the contents of the advanced drill editor.
protected void	showAdvancedDrillEditorTable(ReportBean rb, java.lang.String sTitleName, WebEvent changeDimEvent, java.lang.StringBuffer sScript, java.lang.StringBuffer sScriptValues, MarkupOutput out)	Renders the visible contents of the advanced drill editor.
protected void	showSimpledDrillEditor(ReportBean rb, MarkupOutput out)	Renders the contents of the simple drill editor.
protected void	showSimpledDrillEditorHiddenInput(MarkupOutput out)	Renders the hidden contents of the simple drill editor.
protected void	showSimpledDrillEditorTable(ReportBean rb, MarkupOutput out)	Renders the visible contents of the simple drill editor.
protected boolean	sortSetNamesAndDrillPaths()	Determines if we need to sort set names and drill paths based on a preference.

Methods inherited from class com.microstrategy.web.app.beans.AbstractFrameEditorBean

generateOutput, isEditor, renderFormEnd, renderFormStart

Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableFrameElement

doCollectData, getDocumentFrameBean, getFeaturesManager, getFrameBean, getReportFrameBean, getRWFrameBean, getUseIFrame, isIFrameEnabled, isOpen, setIsOpen, setUseIFrame

Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

addChildStateInfo, isCookieOpen, isSaveStateEnabled, saveState, saveState, saveState, saveState

Methods inherited from class com.microstrategy.web.app.beans.AbstractAppComponent

addChildStateInfo, collectData, collectMinimalData, compareChildsTargetWithCurrent, createTransformInstance, doCollectMinimalData, getAppContext, getContactInfo, getContainerServices, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getObjectSource, getResultFilterMode, getSession, getTargetBean, getTop, getType, getWebObjectsFactory, getWebObjectsFactory, getXMLStatus, hasChanged, hasTargetBeanChanged, haveChildrenChanged, initComponent, internalCollectData, isDialog, isForcedChildrenStateSaving, isIFrameRequest, isModal, isModalOpen, newDefaultBeanContext, newHiddenInputBuilder, newNamespaceEncoder, newStyleRequestContext, newURIBuilder, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setLeft, setOutputFormat, setTop

Methods inherited from class com.microstrategy.web.beans.AbstractWebComponent

addChild, addChildStateInfo, addChildStateInfo, addChildStateInfo, addStateInfo, childValues, clearChildren, clearStateCache, getCachedState, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, handleRequest, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isChangeComparisonFlagSet, isFeatureAvailable, prepareForReuse, removeChild, removeChild, restoreState, restoreStateFromRequest, restoreStateFromRequest, saveXMLState, saveXMLState, saveXMLState, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setParent, setPersistMode, setRenderingFilter, setStateCache, setTargetBean, setTargetBeanPath, setWebEventHandler

Methods inherited from class com.microstrategy.web.beans.AbstractTransformable

addTransform, addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, createTransformInstance, getBeanContext, getDefaultTransform, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, hasTransform, hasTransform, internalCollectData, internalCollectData, invalidateTransformCache, isTransformSuitable, transform, transform, transform, transform

Methods inherited from class com.microstrategy.utils.serialization.AbstractPersistable

doFlatState, getStateHandler, isXMLStateZipped, restoreState, restoreXMLState, saveXMLState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent

getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop

Methods inherited from interface com.microstrategy.web.app.beans.FrameElement

getFrameBean, getTargetBean, getTargetBeanPath, getUseIFrame, isEditor, setTargetBean, setTargetBeanPath, setUseIFrame

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.app.beans.ReportFrameElement

getReportFrameBean

Methods inherited from interface com.microstrategy.web.beans.RequestPersistable

restoreStateFromRequest, restoreStateFromRequest

Methods inherited from interface com.microstrategy.web.beans.Transformable

addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform

Methods inherited from interface com.microstrategy.web.beans.WebComponent

addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setWebEventHandler

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.

renderEditorContent

public void renderEditorContent(MarkupOutput out)

Renders the content of an editor.

Specified by:

renderEditorContent in class AbstractFrameEditorBean

Parameters:

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

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.

showSimpledDrillEditorTable

protected void showSimpledDrillEditorTable(ReportBean rb,
                                           MarkupOutput out)
                                    throws WebBeanException,
                                           WebObjectsException

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

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

doFlatState

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

Description copied from class: AbstractPersistableAppComponent

Proceses the save/restore state opperation of the AppComponent

Overrides:

doFlatState in class AbstractPersistableAppComponent

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

See Also:

AbstractPersistableAppComponent.doFlatState(com.microstrategy.utils.serialization.FlatStateSerializer, int, com.microstrategy.utils.serialization.FlatStateTokenizer)

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.

setHelpEventInformation

protected void setHelpEventInformation(Editor editor)

Deprecated.

Overrides:

setHelpEventInformation in class AbstractFrameEditorBean

See Also:

AbstractFrameEditorBean.setHelpEventInformation(com.microstrategy.web.app.gui.Editor)

newDefaultEventHandler

protected WebEventHandler newDefaultEventHandler()

Overrides:

newDefaultEventHandler in class AbstractWebComponent