org.olap4j.metadata
public interface Schema
A Schema belongs to a Catalog
and contains a number of
Cube
s and shared Dimension
s.
Modifier and Type | Method and Description |
---|---|
Catalog |
getCatalog()
Returns the
Catalog this Schema belongs to. |
NamedList<Cube> |
getCubes()
Returns a list of cubes in this
Schema . |
String |
getName()
Returns the name of this Schema.
|
NamedList<Dimension> |
getSharedDimensions()
Returns a list of shared
Dimension objects in this
Schema . |
Collection<Locale> |
getSupportedLocales()
Returns a collection of
Locale objects for which this
Schema has been localized. |
Catalog getCatalog()
Catalog
this Schema
belongs to.NamedList<Cube> getCubes() throws OlapException
Schema
.
The caller should assume that the list is immutable; if the caller modifies the list, behavior is undefined.
OlapException
- if database error occursOlapDatabaseMetaData.getCubes(java.lang.String, java.lang.String, java.lang.String)
NamedList<Dimension> getSharedDimensions() throws OlapException
Dimension
objects in this
Schema
.
The caller should assume that the list is immutable; if the caller modifies the list, behavior is undefined.
OlapException
- if database error occursOlapDatabaseMetaData.getDimensions(String,String,String,String)
Collection<Locale> getSupportedLocales() throws OlapException
Locale
objects for which this
Schema
has been localized.
Consider the following use case. Suppose one cube is available in English and French, and in French and Spanish, and both are shown in same portal. Clients typically say that seeing reports in a mixture of languages is confusing; the portal would figure out the best common language, in this case French. This method allows the client to choose the most appropriate locale.
The list is advisory: a client is free to choose another locale, in which case, the server will probably revert to the base locale for locale-specific behavior such as captions and formatting.
Schema
has been
localizedOlapException
- if database error occursCube.getSupportedLocales()