Interface Catalog


public interface Catalog

Catalogs are the second element of the hierarchy of metadata objects. A Catalog contains one or more Schemas and has a parent Database.

Some OLAP servers may only have one Catalog. Mondrian is one such OLAP server; its sole catalog is called "LOCALDB".

To obtain the collection of catalogs in the current server, call the OlapConnection.getOlapCatalogs() method.

The hierarchy of metadata objects, rooted at the connection from which they are accessed, is as follows:

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

    • getSchemas

      NamedList<Schema> getSchemas() throws OlapException
      Returns a list of Schema objects which belong to this Catalog.

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

      Returns:
      List of Schema in this Catalog
      Throws:
      OlapException - if error occurs
      See Also:
    • getName

      String getName()
      Returns the name of this Catalog.
      Returns:
      name of this Catalog
    • getMetaData

      OlapDatabaseMetaData getMetaData()
      Retrieves the metadata describing the OLAP server that this Catalog belongs to.
      Returns:
      metadata describing the OLAP server
    • getDatabase

      Database getDatabase()
      Returns the parent database of this catalog.
      Returns:
      A Database object to which this catalog belongs.