public interface

XDADataExplorerBean

implements ObjectExplorerBean
com.microstrategy.web.app.beans.XDADataExplorerBean
Known Indirect Subclasses

Class Overview

This interface extends the ObjectExplorerBean by adding information specific to XDA elements

Summary

Constants
int BROWSE_LEVEL_CATALOGS
int BROWSE_LEVEL_CUBES
int BROWSE_LEVEL_DATA_SOURCES
int BROWSE_LEVEL_DIMENSIONS
int BROWSE_LEVEL_ELEMENTS
int BROWSE_LEVEL_HIERARCHIES
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract int getAncestorBrowseLevel(WebDisplayUnit du)
This method returns an integer representing browse level of the ancestor WebDisplayUnit provided.
abstract String getAncestorPath(WebMDXDisplayUnit du)
Returns the path for a unit that is an ancestor of the current unit
abstract int getCurrentBrowseLevel()
Returns the current browse level of the bean
abstract String getCurrentPath()
Returns current metric folder path or empty string if the current unit is not a metric folder
abstract boolean isTargetingFilter()
This method returns a boolean value indicating if the data explorer is targeting the filter.
abstract void setCurrentBrowseLevel(int browseLevel)
Set the current browse level of the bean
abstract void setCurrentUnitProperties(int browseLevel, String currentUnitId)
Sets the browse level and current unit id.
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.ObjectExplorerBean
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final int BROWSE_LEVEL_CATALOGS

Constant Value: 1 (0x00000001)

public static final int BROWSE_LEVEL_CUBES

Constant Value: 2 (0x00000002)

public static final int BROWSE_LEVEL_DATA_SOURCES

Constant Value: 0 (0x00000000)

public static final int BROWSE_LEVEL_DIMENSIONS

Constant Value: 3 (0x00000003)

public static final int BROWSE_LEVEL_ELEMENTS

Constant Value: 5 (0x00000005)

public static final int BROWSE_LEVEL_HIERARCHIES

Constant Value: 4 (0x00000004)

Public Methods

public abstract int getAncestorBrowseLevel (WebDisplayUnit du)

This method returns an integer representing browse level of the ancestor WebDisplayUnit provided.

Parameters
du WebDisplayUnit
Returns
  • int

public abstract String getAncestorPath (WebMDXDisplayUnit du)

Returns the path for a unit that is an ancestor of the current unit

Parameters
du ancestor unit
Returns
  • the unit path

public abstract int getCurrentBrowseLevel ()

Returns the current browse level of the bean

public abstract String getCurrentPath ()

Returns current metric folder path or empty string if the current unit is not a metric folder

Returns
  • current metric folder path

public abstract boolean isTargetingFilter ()

This method returns a boolean value indicating if the data explorer is targeting the filter.

Returns
  • boolean

public abstract void setCurrentBrowseLevel (int browseLevel)

Set the current browse level of the bean

public abstract void setCurrentUnitProperties (int browseLevel, String currentUnitId)

Sets the browse level and current unit id.

Parameters
browseLevel int
currentUnitId String