Package com.microstrategy.web.beans

Interface DataExplorerBean

All Superinterfaces:

EnumWebPersistableState, ObjectBean, Persistable, RequestPersistable, Transformable, WebBean, WebComponent

public interface DataExplorerBean
extends ObjectBean

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 ObjectBean.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 WebBrowseHierarchyItem.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 ObjectBean.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.

Since:

MicroStrategy Web 9.0.0

Field Summary

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

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

Modifier and Type	Method	Description
WebBrowsePath	createWebBrowsePath()	Creates a new browse path instance.
WebDisplayUnits	elements()	returns the element collection corresponding to the traversal step (browsing to elements or drillable attributes).
java.lang.String	getAttributeID()	Returns the current dimension attribute set.
WebBrowsePath	getBrowsePath()
boolean	getSearchMatchCase()
java.lang.String	getSearchPattern()
void	set(WebBrowsePath newPath)	Sets the new path to browse to.
WebBrowseHierarchyItem	setAttributeID(java.lang.String attributeID)	Sets the next attribute to browse to.
void	setDataSources(java.lang.String dataSources)	Sets the data sources xml that will be used for subsequent operations.
void	setSearchMatchCase(boolean match)	Sets whether the search should be performed with case sensitive.
void	setSearchPattern(java.lang.String searchPattern)	sets the search pattern on the bean.

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

getBlockBegin, getBlockCount, getDisplayName, getFlags, getLevel, getObjectID, getObjectInfo, getObjectName, getObjectType, getParentFolderBean, getParentFolderBean, getParentID, setBlockBegin, setBlockCount, setFlags, setLevel, setObjectID, setObjectInfo, setObjectName, setObjectType

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

restoreState, restoreState, saveState, saveState, saveState, saveState

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.WebBean

getDocument, getErrorInfo, getSessionInfo, isStale, setSessionInfo, setStale

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, getTargetBean, getTargetBeanPath, 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, setTargetBean, setTargetBeanPath, setWebEventHandler

Method Detail

setAttributeID

WebBrowseHierarchyItem setAttributeID(java.lang.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.

Parameters:

attributeID -

Returns:

the corresponding WebBrowseHierarchyItem

getAttributeID

java.lang.String getAttributeID()

Returns the current dimension attribute set.

Returns:

the current attribute.

See Also:

setAttributeID(String)

setSearchPattern

void setSearchPattern(java.lang.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

getSearchPattern

java.lang.String getSearchPattern()

Returns:

the search pattern, if any.

See Also:

setSearchPattern(String)

setSearchMatchCase

void setSearchMatchCase(boolean match)

Sets whether the search should be performed with case sensitive.

Parameters:

match - true for case sensitive search.

getSearchMatchCase

boolean getSearchMatchCase()

Returns:

whether search will be performed as case sensitive or not.

See Also:

setSearchMatchCase(boolean)

elements

WebDisplayUnits elements()
                  throws WebBeanException

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.

Throws:

WebBeanException

setDataSources

void setDataSources(java.lang.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.

getBrowsePath

WebBrowsePath getBrowsePath()

Returns:

the current browse path.

set

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.

createWebBrowsePath

WebBrowsePath createWebBrowsePath()

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

Returns:

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