Interface Schema


public interface Schema
A collection of database objects that contain structural information, or metadata, about a database.

A Schema belongs to a Catalog and contains a number of Cubes and shared Dimensions.

Since:
Oct 13, 2006
Author:
jhyde
  • Method Details

    • getCatalog

      Catalog getCatalog()
      Returns the Catalog this Schema belongs to.
      Returns:
      catalog this schema belongs to
    • getName

      String getName()
      Returns the name of this Schema.
      Returns:
      name of this Schema
    • getCubes

      NamedList<Cube> getCubes() throws OlapException
      Returns a list of cubes in this Schema.

      The caller should assume that the list is immutable; if the caller modifies the list, behavior is undefined.

      Returns:
      List of cubes in this Schema
      Throws:
      OlapException - if database error occurs
      See Also:
    • getSharedDimensions

      NamedList<Dimension> getSharedDimensions() throws OlapException
      Returns a list of shared Dimension objects in this Schema.

      The caller should assume that the list is immutable; if the caller modifies the list, behavior is undefined.

      Returns:
      list of shared dimensions
      Throws:
      OlapException - if database error occurs
      See Also:
    • getSupportedLocales

      Collection<Locale> getSupportedLocales() throws OlapException
      Returns a collection of 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.

      Returns:
      List of locales for which this Schema has been localized
      Throws:
      OlapException - if database error occurs
      See Also: