public class

MWSHierarchyBrowser

extends Object
java.lang.Object
   ↳ com.microstrategy.webservices.MWSHierarchyBrowser

Class Overview

Provides MSTR Web Service Hierarchy Browser functionality. Attributes can be retrieved from hierarchy objects. Attribute parent/child logic is also supplied.

Summary

Public Constructors
MWSHierarchyBrowser()
Constructor
MWSHierarchyBrowser(MWSConnection connectObj)
Public Methods
ArrayOfMWSHierarchyAttributeInfo GetAttributeChildren(MWSConnectInfo cInfo, MWSHierarchyAttributeInfo attributeInfo, EnumMWSAttributeFormsSetting eForms)
Uses passed in attribute information to specify a hierarchy and attribute.
ArrayOfMWSHierarchyAttributeInfo GetAttributeParents(MWSConnectInfo cInfo, MWSHierarchyAttributeInfo attributeInfo, EnumMWSAttributeFormsSetting eForms)
Uses passed in attribute information to specify a hierarchy and attribute.
ArrayOfMWSHierarchyAttributeInfo GetHierarchyAttributes(MWSConnectInfo cInfo, String sHierarchyID, EnumMWSAttributeFormsSetting eForms)
Uses the passed in hierarchy ID to specify a hierarchy, and then returns all the attributes associated with that hierarchy.
MWSHierarchyAttributeInfo PopulateAttributeInfo(WebDimension dim, WebDimensionAttribute dimAttr, EnumMWSAttributeFormsSetting eForms)
Uses the passed in source dimension and attribute to populate an attribute information object to be returned to the client.
MWSHierarchyAttributeInfo PopulateAttributeInfo(WebAttribute attr, EnumMWSAttributeFormsSetting eForms)
Populates an MWSHierarchyAttributeInfo object without the benefit of hierarchy information.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public MWSHierarchyBrowser ()

Constructor

public MWSHierarchyBrowser (MWSConnection connectObj)

Public Methods

public ArrayOfMWSHierarchyAttributeInfo GetAttributeChildren (MWSConnectInfo cInfo, MWSHierarchyAttributeInfo attributeInfo, EnumMWSAttributeFormsSetting eForms)

Uses passed in attribute information to specify a hierarchy and attribute. The children of the specified attribute are returned.

Parameters
cInfo Session connection information
attributeInfo Identifies the attribute to get children of.
eForms Determines which form data is included.
Returns
  • An array of attribute information.
Throws
MWSException
MWSException

public ArrayOfMWSHierarchyAttributeInfo GetAttributeParents (MWSConnectInfo cInfo, MWSHierarchyAttributeInfo attributeInfo, EnumMWSAttributeFormsSetting eForms)

Uses passed in attribute information to specify a hierarchy and attribute. The parents of the specified attribute are returned.

Parameters
cInfo Session connection information
attributeInfo Identifies the attribute to get parents of.
eForms Determines which form data is included.
Returns
  • An array of attribute information.
Throws
MWSException
MWSException

public ArrayOfMWSHierarchyAttributeInfo GetHierarchyAttributes (MWSConnectInfo cInfo, String sHierarchyID, EnumMWSAttributeFormsSetting eForms)

Uses the passed in hierarchy ID to specify a hierarchy, and then returns all the attributes associated with that hierarchy.

Parameters
cInfo Session connection information
sHierarchyID DSSID of hierarchy to get attributes of.
eForms Determines which form data is included.
Returns
  • An array of attribute information.
Throws
MWSException
MWSException

public MWSHierarchyAttributeInfo PopulateAttributeInfo (WebDimension dim, WebDimensionAttribute dimAttr, EnumMWSAttributeFormsSetting eForms)

Uses the passed in source dimension and attribute to populate an attribute information object to be returned to the client.

Parameters
dim Dimension(hierarchy) of attribute to populate
dimAttr Source attribute to populate from.
eForms Type of attribute form array to include.
Returns
  • Populated attribute information.
Throws
MWSException
MWSException

public MWSHierarchyAttributeInfo PopulateAttributeInfo (WebAttribute attr, EnumMWSAttributeFormsSetting eForms)

Populates an MWSHierarchyAttributeInfo object without the benefit of hierarchy information. This is used when SAP/MDX attributes are involved.

Parameters
attr Attribute metadata information to use to populate.
eForms Type of attribute form array to include.
Throws
MWSException
MWSException