Package mondrian.olap
Interface Schema
- All Superinterfaces:
Annotated
- All Known Implementing Classes:
RolapSchema
A
Schema
is a collection of cubes, shared dimensions, and roles.- Author:
- jhyde
-
Method Summary
Modifier and TypeMethodDescriptioncreateCube
(String xml) Creates a cube by parsing an XML string.createDimension
(Cube cube, String xml) Creates a dimension in the given cube by parsing an XML string.Cube[]
getCubes()
Returns a list of all cubes in this schema.Returns this schema's function table.getId()
Returns the uniquely generated id of this schema.getName()
Returns the name of this schema.Returns this schema's parameters.Returns when this schema was last loaded.Creates aSchemaReader
without any access control.Returns a list of shared dimensions in this schema.Returns a list of warnings and errors that occurred while loading this schema.lookupCube
(String cube, boolean failIfNotFound) Finds a cube calledcube
in this schema; if no cube exists,failIfNotFound
controls whether to raise an error or returnnull
.lookupRole
(String role) Finds a role with a given name in the current catalog, or returnsnull
if no such role exists.boolean
removeCube
(String cubeName) Removes a cube.Methods inherited from interface mondrian.olap.Annotated
getAnnotationMap
-
Method Details
-
getName
String getName()Returns the name of this schema. -
getId
String getId()Returns the uniquely generated id of this schema. -
lookupCube
Finds a cube calledcube
in this schema; if no cube exists,failIfNotFound
controls whether to raise an error or returnnull
. -
getCubes
Cube[] getCubes()Returns a list of all cubes in this schema. -
createDimension
Creates a dimension in the given cube by parsing an XML string. The XML string must be either a <Dimension> or a <DimensionUsage>. Returns the dimension created. -
createCube
Creates a cube by parsing an XML string. Returns the cube created. -
removeCube
Removes a cube.- Returns:
- Whether cube was removed
-
getSchemaReader
SchemaReader getSchemaReader()Creates aSchemaReader
without any access control. -
lookupRole
Finds a role with a given name in the current catalog, or returnsnull
if no such role exists. -
getFunTable
FunTable getFunTable()Returns this schema's function table. -
getParameters
Parameter[] getParameters()Returns this schema's parameters. -
getSchemaLoadDate
Date getSchemaLoadDate()Returns when this schema was last loaded.- Returns:
- Date and time when this schema was last loaded
-
getWarnings
Returns a list of warnings and errors that occurred while loading this schema.- Returns:
- list of warnings
-