Package com.microstrategy.web.objects
Interface WebMDXCatalog
-
- All Superinterfaces:
KeyedObject
,WebDisplayUnit
,WebMDXDisplayUnit
public interface WebMDXCatalog extends WebMDXDisplayUnit
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 ofWebMDXCube
objects.- Since:
- MicroStrategy Web 8.0.2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebMDXCube
get(int i)
Returns theWebMDXCube
object in the child collection at the given index.WebDisplayUnits
getChildUnits()
Returns aWebDisplayUnits
collection which can be used to iterate through the cubes that are contained within the catalog.java.lang.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.java.lang.String
getName()
Returns the name of the catalog.WebMDXDisplayUnit
getParent()
Returns the parentWebMDXDisplayUnit
of this object.int
size()
Returns the number of cubes in the catalog.-
Methods inherited from interface com.microstrategy.utils.KeyedObject
_getObKey
-
Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit
addDetails, applyVisitor, canHighlight, getDisplayUnitType, getID, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected
-
Methods inherited from interface com.microstrategy.web.objects.WebMDXDisplayUnit
getPathComponent, getSourceObject, isContainer, isPrunable
-
-
-
-
Method Detail
-
getDisplayName
java.lang.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.- Specified by:
getDisplayName
in interfaceWebDisplayUnit
- Returns:
- The display name of the catalog.
- See Also:
WebDisplayUnit.setDisplayName(java.lang.String)
,WebObjectInfo.getName()
-
getName
java.lang.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.
-
get
WebMDXCube get(int i) throws WebObjectsException
Returns theWebMDXCube
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.
-
getChildUnits
WebDisplayUnits getChildUnits() throws WebObjectsException
Returns aWebDisplayUnits
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 bothWebMDXDisplayUnit
andWebMDXCube
.- Specified by:
getChildUnits
in interfaceWebDisplayUnit
- Returns:
- A
WebDisplayUnits
collection containing the cubes of the catalog. - Throws:
WebObjectsException
- Thrown if an error occurs when retrieving the children.
-
size
int size() throws WebObjectsException
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.
-
getParent
WebMDXDisplayUnit getParent()
Returns the parentWebMDXDisplayUnit
of this object. This will generally be castable into aWebMDXSource
.- Specified by:
getParent
in interfaceWebMDXDisplayUnit
- Returns:
- the parent
WebMDXDisplayUnit
.
-
-