Package com.microstrategy.web.objects

Interface WebBrowsePath

All Superinterfaces:

EnumWebPersistableState, Persistable

public interface WebBrowsePath
extends Persistable

A browse path is a collection of WebBrowseHierarchyItem instances.

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	WebBrowsePath.WebBrowsePathObserver

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
WebBrowseHierarchyItem	add(java.lang.String attrID)	Appends attribute to the end of the browse path.
WebElement	addElement(java.lang.String elemID, java.lang.String elemName, java.lang.String attrID)	Adds an element to the browse path.
void	addObserver(WebBrowsePath.WebBrowsePathObserver observer)
void	addToFilter(WebExpression exp)
WebBrowseHierarchyItem	browseToHierarchyItem(java.lang.String attrID)	Adds an attribute to the browse path.
void	clear()	Clears the current browse path.
void	clearObservers()
WebBrowseHierarchyItem	find(java.lang.String attrID)	Does a search starting from the end of this browse path for the WebBrowseHierarchyItem identified by the given attribute ID parameter.
java.util.List<WebBrowseHierarchyItem>	getBrowseHierarchyItems()	Returns a collection of WebBrowseHierarchyItem instances corresponding to the path browsed.
WebDimension	getDimension()
void	removeObserver(WebBrowsePath.WebBrowsePathObserver observer)
void	setDimension(WebDimension dimension)

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

restoreState, restoreState, saveState, saveState, saveState, saveState

Method Detail

setDimension

void setDimension(WebDimension dimension)

getDimension

WebDimension getDimension()

getBrowseHierarchyItems

java.util.List<WebBrowseHierarchyItem> getBrowseHierarchyItems()

Returns a collection of WebBrowseHierarchyItem instances corresponding to the path browsed.

Returns:

collection of WebBrowseHierarchyItem instances.

clear

void clear()

Clears the current browse path.

addElement

WebElement addElement(java.lang.String elemID,
                      java.lang.String elemName,
                      java.lang.String attrID)

Adds an element to the browse path. Null is returned if no matching attribute is found on the path.

Parameters:

elemID - the element ID.

elemName - element name.

attrID - attribute associated with element.

Returns:

the associated browse element instance.

browseToHierarchyItem

WebBrowseHierarchyItem browseToHierarchyItem(java.lang.String attrID)

Adds an attribute to the browse path. If the attribute already exists in getBrowseHierarchyItems() then an existing one is returned.

Parameters:

attrID - the attribute ID.

Returns:

the associated browse attribute instance.

add

WebBrowseHierarchyItem add(java.lang.String attrID)

Appends attribute to the end of the browse path.

Parameters:

attrID - the attribute ID.

Returns:

the corresponding WebBrowseHierarchyItem.

find

WebBrowseHierarchyItem find(java.lang.String attrID)

Does a search starting from the end of this browse path for the WebBrowseHierarchyItem identified by the given attribute ID parameter.

Parameters:

attrID - attribute ID

Returns:

WebBrowseHierarchyItem corresponding to the attribute ID, null if not in the path.

addToFilter

void addToFilter(WebExpression exp)

Parameters:

exp - adds this browse path to the expression filter.

addObserver

void addObserver(WebBrowsePath.WebBrowsePathObserver observer)

Parameters:

observer - object interested in changes to this WebBrowsePath

See Also:

WebBrowsePath.WebBrowsePathObserver.update(WebBrowsePath)

removeObserver

void removeObserver(WebBrowsePath.WebBrowsePathObserver observer)

clearObservers

void clearObservers()