public interface

DataExplorerBean

implements ObjectBean
com.microstrategy.web.beans.DataExplorerBean

Class Overview

The DataExplorerBean is intended to support data explorer browsing. The object ID of the bean should correspond to the dimension to browse within the hierarchy. There are several ways of utilizing this bean.

Incremental browsing with setAttributeID(String)
First, a dimension needs to be set via setObjectID(String). Once a dimension is set, elements() will return a WebDisplayUnits collection of available top level WebBrowseHierarchyItem attributes. Once an attribute is selected, invoking elements() attribute will return available WebElements. Setting a WebElement via add(String, String) allows the next elements() invocation to return the next collection of WebBrowseHierarchyItem instances if any, and so on. The browse path taken using the bean can be read using getBrowsePath(). Incremental browsing is limited to drilling up or down a hierarchy, but does not work when drilling across or elsewhere in the hierarchy.
Path Based Browsing
This approach allows for ad-hoc traversal of the hierarchy. Path based browsing also requires this bean to be set with the dimension object (via setObjectID(String)). The browse destination is specified by set(WebBrowsePath).

Both incremental and path based browsing may be used interchangeably depending on what is convenient. Incremental browsing can be more efficient since only an element or attribute needs to be specified if drilling down or up, whereas path based browsing requires a browse path to be specified. If in doubt, use path based browsing.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract WebBrowsePath createWebBrowsePath()
Creates a new browse path instance.
abstract WebDisplayUnits elements()
returns the element collection corresponding to the traversal step (browsing to elements or drillable attributes).
abstract String getAttributeID()
Returns the current dimension attribute set.
abstract WebBrowsePath getBrowsePath()
abstract boolean getSearchMatchCase()
abstract String getSearchPattern()
abstract void set(WebBrowsePath newPath)
Sets the new path to browse to.
abstract WebBrowseHierarchyItem setAttributeID(String attributeID)
Sets the next attribute to browse to.
abstract void setDataSources(String dataSources)
Sets the data sources xml that will be used for subsequent operations.
abstract void setSearchMatchCase(boolean match)
Sets whether the search should be performed with case sensitive.
abstract void setSearchPattern(String searchPattern)
sets the search pattern on the bean.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.beans.ObjectBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebBean
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract WebBrowsePath createWebBrowsePath ()

Creates a new browse path instance. Please ensure that the dimension already configured on this bean (e.g. via setObjectID(String)) before invoking this method.

Returns
  • a new browse path (not bound to this bean).

public abstract WebDisplayUnits elements ()

returns the element collection corresponding to the traversal step (browsing to elements or drillable attributes). Use the javadocs for the class for more details on traversal steps.

Returns
  • display unit collection that would either hold WebElement objects or WebDimensionAttribute objects.

public abstract String getAttributeID ()

Returns the current dimension attribute set.

Returns
  • the current attribute.

public abstract WebBrowsePath getBrowsePath ()

Returns
  • the current browse path.

public abstract boolean getSearchMatchCase ()

Returns
  • whether search will be performed as case sensitive or not.

public abstract String getSearchPattern ()

Returns
  • the search pattern, if any.

public abstract void set (WebBrowsePath newPath)

Sets the new path to browse to. If an existing path already exists, the selected elements of the existing path will be merged into the new path. To create a browse path, see createWebBrowsePath().

Parameters
newPath a new path to browse to.

public abstract WebBrowseHierarchyItem setAttributeID (String attributeID)

Sets the next attribute to browse to. The attribute must either be a child attribute of the current attribute (in the hierarchy that the bean corresponds to) or one of the attributes already traversed. If no attribute has been traversed, the attribute should be the root attribute in the dimension. If the attribute set is one of the traversed attributes in the hierarchy the bean rolls back itself to the attribute i.e. it sets itself up as if this was the first time the attribute was visited. Among other things, that implies clearing the previous browse path. Used for incremental browsing, but limited to drill up or down actions.

Returns
  • the corresponding WebBrowseHierarchyItem

public abstract void setDataSources (String dataSources)

Sets the data sources xml that will be used for subsequent operations. Ensure this is configured before setting the dimension or browsing.

Parameters
dataSources data sources xml.

public abstract void setSearchMatchCase (boolean match)

Sets whether the search should be performed with case sensitive.

Parameters
match true for case sensitive search.

public abstract void setSearchPattern (String searchPattern)

sets the search pattern on the bean. This is relevant only when filter element for the current attribute has'nt been set in the browse path.

Parameters
searchPattern search pattern