public class

XDADataExplorerBeanImpl

extends AbstractObjectExplorerBean
implements XDADataExplorerBean
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.AbstractObjectExplorerBean
                 ↳ com.microstrategy.web.app.beans.XDADataExplorerBeanImpl

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
From interface com.microstrategy.web.app.beans.XDADataExplorerBean
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
Public Constructors
XDADataExplorerBeanImpl()
Public Methods
void doCollectData()
Extends collectData to prune the current unit, if necessary.
int getAncestorBrowseLevel(WebDisplayUnit du)
This method returns an integer representing browse level of the ancestor WebDisplayUnit provided.
String getAncestorPath(WebMDXDisplayUnit du)
Returns the path for a unit that is an ancestor of the current unit
ArrayList getAncestors()
Returns a list of the current element's ancestors if the curretn element is a WebDisplayUnit
ArrayList getContents()
Returns a list with the WebMDXDisplayUnit children of the current element.
ArrayList getContents(boolean sortAscending)
Returns a sorted list with the WebMDXDisplayUnit children of the current element.
int getCurrentBrowseLevel()
Returns the current browse level of the bean
String getCurrentPath()
Returns current metric folder path or empty string if the current unit is not a metric folder
WebDisplayUnit getCurrentUnit()
Returns the element whose contents are displayed by the browser
ArrayList getLinks()
An instance of XDADataExplorerBeanImpl does not support shortcuts.
int getObjectCount()
String getSearchName()
Not supported.
int getTotalObjectCount()
Returns the total number children of the current element.
boolean isTargetingFilter()
This method returns a boolean value indicating if the data explorer is targeting the filter.
void setCurrentBrowseLevel(int browseLevel)
Set the current browse level of the bean
void setCurrentUnitProperties(int browseLevel, String currentUnitId)
Sets the browse level and current unit id.
Protected Methods
void doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)
Proceses the save/restore state opperation of the AppComponent
WebEventHandler newDefaultEventHandler()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.beans.AbstractObjectExplorerBean
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.ObjectExplorerBean
From interface com.microstrategy.web.app.beans.XDADataExplorerBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Constructors

public XDADataExplorerBeanImpl ()

Public Methods

public void doCollectData ()

Extends collectData to prune the current unit, if necessary.

public int getAncestorBrowseLevel (WebDisplayUnit du)

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

Parameters
du WebDisplayUnit
Returns
  • int

public 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 ArrayList getAncestors ()

Returns a list of the current element's ancestors if the curretn element is a WebDisplayUnit

Returns
  • ArrayList list of the current element's ancestors

public ArrayList getContents ()

Returns a list with the WebMDXDisplayUnit children of the current element. The current element is an instance of WebDisplayUnit

Returns
  • ArrayList list of the current element's contents

public ArrayList getContents (boolean sortAscending)

Returns a sorted list with the WebMDXDisplayUnit children of the current element. The current element is an instance of WebDisplayUnit

Parameters
sortAscending boolean that indicated the order of the sort method
ascending = true
descending = false
Returns
  • ArrayList list of the current element's contents

public int getCurrentBrowseLevel ()

Returns the current browse level of the bean

public 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 WebDisplayUnit getCurrentUnit ()

Returns the element whose contents are displayed by the browser

Returns
  • WebDisplayUnit

public ArrayList getLinks ()

An instance of XDADataExplorerBeanImpl does not support shortcuts.

Returns
  • null.

public int getObjectCount ()

public String getSearchName ()

Not supported.

Returns
  • null

public int getTotalObjectCount ()

Returns the total number children of the current element.

Returns
  • int number children of the current element

public boolean isTargetingFilter ()

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

Returns
  • boolean

public void setCurrentBrowseLevel (int browseLevel)

Set the current browse level of the bean

public void setCurrentUnitProperties (int browseLevel, String currentUnitId)

Sets the browse level and current unit id.

Parameters
browseLevel int
currentUnitId String

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 WebEventHandler newDefaultEventHandler ()