public interface

WebMDXCubeSource

com.microstrategy.web.objects.WebMDXCubeSource

Class Overview

The WebMDXCubeSource interface is the entry point interface to the cube and cube object browsing functionality. The methods on this interface can be used to browse specific parts of the cube or cube object hierarchy and the whole hierarchy.

Summary

Public Methods
abstract WebMDXDisplayUnit getCompoundMetrics(WebTable table)
This method will return the compound metrics display unit that is associated with the given cube.
abstract WebMDXCatalog getMDXCatalog(WebDBRole role, String name)
This method will return the WebMDXCatalog object associated with the given role and catalog name.
abstract WebMDXCube getMDXCube(WebTable table)
This method will return the WebMDXCube object associated with the given cube.
abstract WebMDXDisplayUnit getMDXDimension(WebTable table, WebDimension dimension)
This method will return the MDX dimension that corresponds to the given WebDimension and the cube identified by the given WebTable.
abstract WebMDXDisplayUnit getMDXHierarchy(WebTable table, WebDimension hierarchy)
This method will return the MDX hierarchy that corresponds to the given WebDimension object that identifies the hierarchy.
abstract WebMDXSource getMDXSource(WebDBRole role)
Returns the WebMDXSource object corresponding to the given DBRole.
abstract WebMDXSources getMDXSources()
This method will return a collection of sources of MDX cubes.
abstract WebMDXDisplayUnit getMetricFolder(WebTable table, String path)
Gets metric folder.
abstract WebMDXDisplayUnit getMetrics(WebTable table)
This method will return the metrics dimension that is associated with the given cube.
abstract int getTableExtraInformation()
See EnumDSSXMLTableExtraInformation.
abstract void populateObject(WebObjectInfo object, WebTable cube)
Populates the given object in the context of the given cube.
abstract void populateObject(WebObjectInfo object, String dataSourceXML)
Populates the given object in the context of the given data source xml.
abstract void setTableExtraInformation(int i)

Public Methods

public abstract WebMDXDisplayUnit getCompoundMetrics (WebTable table)

This method will return the compound metrics display unit that is associated with the given cube.

Parameters
table The WebTable object that identifies the cube.
Returns
  • A WebMDXDisplayUnit object corresponding to the user metrics collection. This will be a MDX Display Unit and its children will be metrics.
Throws
WebObjectsException Thrown if the metrics dimension's contents cannot be retrieved.

public abstract WebMDXCatalog getMDXCatalog (WebDBRole role, String name)

This method will return the WebMDXCatalog object associated with the given role and catalog name.

Parameters
role The WebDBRole object that identifies the MDX source.
name The name of the catalog.
Returns
  • The WebMDXCatalog object corresponding to the given role and catalog name.
Throws
WebObjectsException Thrown if the catalog cannot be retrieved.

public abstract WebMDXCube getMDXCube (WebTable table)

This method will return the WebMDXCube object associated with the given cube. This object can be used to browse the cube's contents.

Parameters
table The WebTable object identifying the cube to be retrieved.
Returns
Throws
WebObjectsException Thrown if the cube's contents cannot be retrieved.

public abstract WebMDXDisplayUnit getMDXDimension (WebTable table, WebDimension dimension)

This method will return the MDX dimension that corresponds to the given WebDimension and the cube identified by the given WebTable. This WebMDXDisplayUnit can be used to view the children of the dimension. If the dimension is null, then the metrics dimension will be returned.

Parameters
table The WebTable object that identifies the cube.
dimension The WebDimension object that identifies the MDX dimension.
Returns
Throws
WebObjectsException Thrown if the dimension's contents cannot be retrieved.

public abstract WebMDXDisplayUnit getMDXHierarchy (WebTable table, WebDimension hierarchy)

This method will return the MDX hierarchy that corresponds to the given WebDimension object that identifies the hierarchy. Note that the MDX dimension is not required, since an MDX hierarchy is unique within its cube.

Parameters
table The WebTable object that identifies the MDX cube.
hierarchy The WebDimension object that identifies the MDX hierarchy.
Returns
Throws
WebObjectsException Thrown if the hierarchy's contents cannot be retrieved.

public abstract WebMDXSource getMDXSource (WebDBRole role)

Returns the WebMDXSource object corresponding to the given DBRole. This source object will contain the catalogs within the given source.

Parameters
role The WebDBRole object that identifies the MDX source.
Returns
Throws
WebObjectsException Thrown if the source cannot be retrieved.

public abstract WebMDXSources getMDXSources ()

This method will return a collection of sources of MDX cubes. This is the top-level entry point into browsing for cubes.

Returns
  • A list of all MDX sources available on the project, as a WebMDXSources object.
Throws
WebObjectsException Thrown if the list of sources cannot be retrieved.

public abstract WebMDXDisplayUnit getMetricFolder (WebTable table, String path)

Gets metric folder.

Parameters
table The WebTable object that identifies the cube.
path The unit path. Conventions for the path:
  • If empty string, it means: get Compound Metrics.
  • If present it should start with a backslash char if the first node is a Display Folder; and it should start with a double backslash if the fist node is a Metric Group.
  • The separator used in the path is the backslash.
Returns
Throws
WebObjectsException

public abstract WebMDXDisplayUnit getMetrics (WebTable table)

This method will return the metrics dimension that is associated with the given cube.

Parameters
table The WebTable object that identifies the cube.
Returns
  • A WebMDXDisplayUnit object corresponding to the metrics dimension. This will be a MDX dimension with no WebDimension object associated with it and its children will be metrics and the compound metric collection.
Throws
WebObjectsException Thrown if the metrics dimension's contents cannot be retrieved.

public abstract int getTableExtraInformation ()

See EnumDSSXMLTableExtraInformation. Default is DssTableExtraInformationDefault.

public abstract void populateObject (WebObjectInfo object, WebTable cube)

Populates the given object in the context of the given cube.

Parameters
object The object to populate.
cube The WebTable object representing the cube being used to populate.
Throws
WebObjectsException Thrown if an error occurs fetching the information.
IllegalArgumentException

public abstract void populateObject (WebObjectInfo object, String dataSourceXML)

Populates the given object in the context of the given data source xml.

Parameters
object The object to populate.
dataSourceXML The data sources xml.
Throws
WebObjectsException Thrown if an error occurs fetching the information.
IllegalArgumentException

public abstract void setTableExtraInformation (int i)

Parameters
i See EnumDSSXMLTableExtraInformation. Default is DssTableExtraInformationDefault.