public interface

WebMDXCatalog

implements WebMDXDisplayUnit
com.microstrategy.web.objects.WebMDXCatalog

Class Overview

The WebMDXCatalog interface represents a catalog of a MDX source. A catalog is identified uniquely by its name and the DBRole of its source. It contains a collection of WebMDXCube objects.

Summary

Public Methods
abstract WebMDXCube get(int i)
Returns the WebMDXCube object in the child collection at the given index.
abstract WebDisplayUnits getChildUnits()
Returns a WebDisplayUnits collection which can be used to iterate through the cubes that are contained within the catalog.
abstract String getDisplayName()
Returns the display name of the catalog - this is the name that is meant for display purposes, but cannot be used for identification purposes.
abstract String getName()
Returns the name of the catalog.
abstract WebMDXDisplayUnit getParent()
Returns the parent WebMDXDisplayUnit of this object.
abstract int size()
Returns the number of cubes in the catalog.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebMDXDisplayUnit

Public Methods

public abstract WebMDXCube get (int i)

Returns the WebMDXCube object in the child collection at the given index.

Returns
  • The WebMDXCube object in the child collection at the given index.
Throws
WebObjectsException Thrown if an error occurs when retrieving the children.

public abstract WebDisplayUnits getChildUnits ()

Returns a WebDisplayUnits collection which can be used to iterate through the cubes that are contained within the catalog. The objects returned from here will be castable to both WebMDXDisplayUnit and WebMDXCube.

Returns
Throws
WebObjectsException Thrown if an error occurs when retrieving the children.

public abstract String getDisplayName ()

Returns the display name of the catalog - this is the name that is meant for display purposes, but cannot be used for identification purposes.

Returns
  • The display name of the catalog.

public abstract String getName ()

Returns the name of the catalog. This is also known as the technical name. This name will generally be unsuitable for display purposes, but it is the main thing used to identify the catalog.

Returns
  • The name, or technical name, of the catalog.

public abstract WebMDXDisplayUnit getParent ()

Returns the parent WebMDXDisplayUnit of this object. This will generally be castable into a WebMDXSource.

Returns

public abstract int size ()

Returns the number of cubes in the catalog.

Returns
  • The number of cubes in the catalog.
Throws
WebObjectsException Thrown if an error occurs when retrieving the children.