mondrian.olap
Interface Schema

All Known Implementing Classes:

RolapSchema

public interface Schema

A Schema is a collection of cubes, shared dimensions, and roles.

Author:

jhyde

Method Summary

Cube	createCube(String xml) Creates a cube by parsing an XML string.
Dimension	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.
FunTable	getFunTable() Returns this schema's function table.
String	getName() Returns the name of this schema.
Parameter[]	getParameters() Returns this schema's parameters.
Date	getSchemaLoadDate() Returns when this schema was last loaded.
SchemaReader	getSchemaReader() Creates a SchemaReader without any access control.
Hierarchy[]	getSharedHierarchies() Returns a list of shared dimensions in this schema.
List<Exception>	getWarnings() Returns a list of warnings and errors that occurred while loading this schema.
Cube	lookupCube(String cube, boolean failIfNotFound) Finds a cube called cube in this schema; if no cube exists, failIfNotFound controls whether to raise an error or return null.
Role	lookupRole(String role) Finds a role with a given name in the current catalog, or returns null if no such role exists.
boolean	removeCube(String cubeName) Removes a cube.

Method Detail

getName

String getName()

Returns the name of this schema.

Post-condition:

return != null, return.length() > 0

lookupCube

Cube lookupCube(String cube,
                boolean failIfNotFound)

Finds a cube called cube in this schema; if no cube exists, failIfNotFound controls whether to raise an error or return null.

getCubes

Cube[] getCubes()

Returns a list of all cubes in this schema.

getSharedHierarchies

Hierarchy[] getSharedHierarchies()

Returns a list of shared dimensions in this schema.

createDimension

Dimension createDimension(Cube cube,
                          String xml)

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

Cube createCube(String xml)

Creates a cube by parsing an XML string. Returns the cube created.

removeCube

boolean removeCube(String cubeName)

Removes a cube.

Returns:

Whether cube was removed

getSchemaReader

SchemaReader getSchemaReader()

Creates a SchemaReader without any access control.

lookupRole

Role lookupRole(String role)

Finds a role with a given name in the current catalog, or returns null 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

List<Exception> getWarnings()

Returns a list of warnings and errors that occurred while loading this schema.

Returns:

list of warnings