Package com.microstrategy.web.objects
Interface WebMDXCubeSource
-
public interface WebMDXCubeSource
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.- Since:
- MicroStrategy Web 8.0.2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebMDXDisplayUnit
getCompoundMetrics(WebTable table)
This method will return the compound metrics display unit that is associated with the given cube.WebMDXCatalog
getMDXCatalog(WebDBRole role, java.lang.String name)
This method will return theWebMDXCatalog
object associated with the given role and catalog name.WebMDXCube
getMDXCube(WebTable table)
This method will return theWebMDXCube
object associated with the given cube.WebMDXDisplayUnit
getMDXDimension(WebTable table, WebDimension dimension)
This method will return the MDX dimension that corresponds to the givenWebDimension
and the cube identified by the givenWebTable
.WebMDXDisplayUnit
getMDXHierarchy(WebTable table, WebDimension hierarchy)
This method will return the MDX hierarchy that corresponds to the givenWebDimension
object that identifies the hierarchy.WebMDXSource
getMDXSource(WebDBRole role)
Returns theWebMDXSource
object corresponding to the given DBRole.WebMDXSources
getMDXSources()
This method will return a collection of sources of MDX cubes.WebMDXDisplayUnit
getMetricFolder(WebTable table, java.lang.String path)
Gets metric folder.WebMDXDisplayUnit
getMetrics(WebTable table)
This method will return the metrics dimension that is associated with the given cube.int
getTableExtraInformation()
void
populateObject(WebObjectInfo object, WebTable cube)
Populates the given object in the context of the given cube.void
populateObject(WebObjectInfo object, java.lang.String dataSourceXML)
Populates the given object in the context of the given data source xml.void
setTableExtraInformation(int i)
-
-
-
Method Detail
-
getMDXSources
WebMDXSources getMDXSources() throws WebObjectsException
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.
-
getMDXSource
WebMDXSource getMDXSource(WebDBRole role) throws WebObjectsException
Returns theWebMDXSource
object corresponding to the given DBRole. This source object will contain the catalogs within the given source.- Parameters:
role
- TheWebDBRole
object that identifies the MDX source.- Returns:
- The
WebMDXSource
object corresponding to the given DBRole. - Throws:
WebObjectsException
- Thrown if the source cannot be retrieved.
-
getMDXCatalog
WebMDXCatalog getMDXCatalog(WebDBRole role, java.lang.String name) throws WebObjectsException
This method will return theWebMDXCatalog
object associated with the given role and catalog name.- Parameters:
role
- TheWebDBRole
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.
-
getMDXCube
WebMDXCube getMDXCube(WebTable table) throws WebObjectsException
This method will return theWebMDXCube
object associated with the given cube. This object can be used to browse the cube's contents.- Parameters:
table
- TheWebTable
object identifying the cube to be retrieved.- Returns:
- A
WebMDXCube
object corresponding to the givenWebTable
object. - Throws:
WebObjectsException
- Thrown if the cube's contents cannot be retrieved.
-
getMDXDimension
WebMDXDisplayUnit getMDXDimension(WebTable table, WebDimension dimension) throws WebObjectsException
This method will return the MDX dimension that corresponds to the givenWebDimension
and the cube identified by the givenWebTable
. ThisWebMDXDisplayUnit
can be used to view the children of the dimension. If the dimension is null, then the metrics dimension will be returned.- Parameters:
table
- TheWebTable
object that identifies the cube.dimension
- TheWebDimension
object that identifies the MDX dimension.- Returns:
- A
WebMDXDisplayUnit
object corresponding to the dimension. - Throws:
WebObjectsException
- Thrown if the dimension's contents cannot be retrieved.
-
getMDXHierarchy
WebMDXDisplayUnit getMDXHierarchy(WebTable table, WebDimension hierarchy) throws WebObjectsException
This method will return the MDX hierarchy that corresponds to the givenWebDimension
object that identifies the hierarchy. Note that the MDX dimension is not required, since an MDX hierarchy is unique within its cube.- Parameters:
table
- TheWebTable
object that identifies the MDX cube.hierarchy
- TheWebDimension
object that identifies the MDX hierarchy.- Returns:
- A
WebMDXDisplayUnit
object corresponding to the MDX hierarchy. - Throws:
WebObjectsException
- Thrown if the hierarchy's contents cannot be retrieved.
-
getMetrics
WebMDXDisplayUnit getMetrics(WebTable table) throws WebObjectsException
This method will return the metrics dimension that is associated with the given cube.- Parameters:
table
- TheWebTable
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.
-
getCompoundMetrics
WebMDXDisplayUnit getCompoundMetrics(WebTable table) throws WebObjectsException
This method will return the compound metrics display unit that is associated with the given cube.- Parameters:
table
- TheWebTable
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.- Since:
- MicroStrategy Web 8.1.0
-
populateObject
void populateObject(WebObjectInfo object, WebTable cube) throws WebObjectsException, java.lang.IllegalArgumentException
Populates the given object in the context of the given cube.- Parameters:
object
- The object to populate.cube
- TheWebTable
object representing the cube being used to populate.- Throws:
WebObjectsException
- Thrown if an error occurs fetching the information.java.lang.IllegalArgumentException
-
populateObject
void populateObject(WebObjectInfo object, java.lang.String dataSourceXML) throws WebObjectsException, java.lang.IllegalArgumentException
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.java.lang.IllegalArgumentException
- Since:
- MicroStrategy Web 9.0.0
-
setTableExtraInformation
void setTableExtraInformation(int i)
- Parameters:
i
- SeeEnumDSSXMLTableExtraInformation
. Default isEnumDSSXMLTableExtraInformation.DssTableExtraInformationDefault
.
-
getTableExtraInformation
int getTableExtraInformation()
-
getMetricFolder
WebMDXDisplayUnit getMetricFolder(WebTable table, java.lang.String path) throws WebObjectsException
Gets metric folder.- Parameters:
table
- TheWebTable
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:
- A
WebMDXDisplayUnit
object corresponding to the metric folder. - Throws:
WebObjectsException
-
-