Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

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

abstract int	getBlockBegin() Returns the blockBegin property of the embedded `WebObjectSource`.
abstract int	getBlockCount() Returns the blockCount property of the embedded `WebObjectSource`.
abstract String	getDisplayName() Display name of the bean.
abstract int	getFlags() Returns the object flags from the embedded `WebObjectSource`.
abstract int	getLevel() Returns the level property of the embedded `WebObjectSource`.
abstract String	getObjectID() Returns the object's unique ID in the metadata.
abstract WebObjectInfo	getObjectInfo() Returns the the `WebObjectInfo` of the object.
abstract String	getObjectName() Returns the object's exact name in the metadata.
abstract int	getObjectType() Returns the type (`EnumDSSXMLObjectTypes`) of the object.
abstract FolderBean	getParentFolderBean(String name) Returns a `FolderBean` representing the parent folder of the current object.
abstract FolderBean	getParentFolderBean(String name, boolean populate) Returns a `FolderBean` representing the parent folder of the current object.
abstract String	getParentID() Returns the unique ID of the parent of the object.
abstract void	setBlockBegin(int blockBegin) Sets a new blockBegin property to the embedded `WebObjectSource`.
abstract void	setBlockCount(int blockCount) Sets the blockCount property of the embedded `WebObjectSource`.
abstract void	setFlags(int flags) Sets a new object flags on the embedded `WebObjectSource`.
abstract void	setLevel(int level) Sets the level property of the embedded `WebObjectSource`.
abstract void	setObjectID(String objectID) Sets the object's ID.
abstract void	setObjectInfo(WebObjectInfo oi) Sets the WebObjectInfo object that refers to the object.
abstract void	setObjectName(String objectName) Sets the object's name.
abstract void	setObjectType(int objectType) Sets the object' type (`EnumDSSXMLObjectTypes`).

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

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

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.

Throws

WebBeanException

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

Interfaces

Classes

Exceptions

DataExplorerBean

Class Overview

Summary

Public Methods

public abstract WebBrowsePath createWebBrowsePath ()

Returns

public abstract WebDisplayUnits elements ()

Returns

Throws

public abstract String getAttributeID ()

Returns

See Also

public abstract WebBrowsePath getBrowsePath ()

Returns

public abstract boolean getSearchMatchCase ()

Returns

See Also

public abstract String getSearchPattern ()

Returns

See Also

public abstract void set (WebBrowsePath newPath)

Parameters

public abstract WebBrowseHierarchyItem setAttributeID (String attributeID)

Returns

public abstract void setDataSources (String dataSources)

Parameters

public abstract void setSearchMatchCase (boolean match)

Parameters

public abstract void setSearchPattern (String searchPattern)

Parameters