public
interface
WebBrowsePath
implements Persistable| com.microstrategy.web.objects.WebBrowsePath |
Class Overview
A browse path is a collection of WebBrowseHierarchyItem instances.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| interface | WebBrowsePath.WebBrowsePathObserver | ||||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From interface
com.microstrategy.utils.serialization.EnumWebPersistableState
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract WebBrowseHierarchyItem |
add(String attrID)
Appends attribute to the end of the browse path.
| ||||||||||
| abstract WebElement |
addElement(String elemID, String elemName, String attrID)
Adds an element to the browse path.
| ||||||||||
| abstract void | addObserver(WebBrowsePath.WebBrowsePathObserver observer) | ||||||||||
| abstract void | addToFilter(WebExpression exp) | ||||||||||
| abstract WebBrowseHierarchyItem |
browseToHierarchyItem(String attrID)
Adds an attribute to the browse path.
| ||||||||||
| abstract void |
clear()
Clears the current browse path.
| ||||||||||
| abstract void | clearObservers() | ||||||||||
| abstract WebBrowseHierarchyItem |
find(String attrID)
Does a search starting from the end of this browse path for the
WebBrowseHierarchyItem identified by the given attribute
ID parameter. | ||||||||||
| abstract List<WebBrowseHierarchyItem> |
getBrowseHierarchyItems()
Returns a collection of
WebBrowseHierarchyItem instances corresponding to the path browsed. | ||||||||||
| abstract WebDimension | getDimension() | ||||||||||
| abstract void | removeObserver(WebBrowsePath.WebBrowsePathObserver observer) | ||||||||||
| abstract void | setDimension(WebDimension dimension) | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.utils.serialization.Persistable
| |||||||||||
Public Methods
public abstract WebBrowseHierarchyItem add (String attrID)
Appends attribute to the end of the browse path.
Parameters
| attrID | the attribute ID. |
|---|
Returns
- the corresponding
WebBrowseHierarchyItem.
public abstract WebElement addElement (String elemID, String elemName, 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.
public abstract void addObserver (WebBrowsePath.WebBrowsePathObserver observer)
Parameters
| observer | object interested in changes to this WebBrowsePath
|
|---|
See Also
public abstract void addToFilter (WebExpression exp)
Parameters
| exp | adds this browse path to the expression filter. |
|---|
public abstract WebBrowseHierarchyItem browseToHierarchyItem (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.
public abstract void clear ()
Clears the current browse path.
public abstract void clearObservers ()
public abstract WebBrowseHierarchyItem find (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
WebBrowseHierarchyItemcorresponding to the attribute ID, null if not in the path.
public abstract List<WebBrowseHierarchyItem> getBrowseHierarchyItems ()
Returns a collection of WebBrowseHierarchyItem instances corresponding to the path browsed.
Returns
- collection of
WebBrowseHierarchyIteminstances.