org.olap4j.metadata
Interface Catalog

public interface Catalog

Highest level element in the hierarchy of metadata objects.

A Catalog contains one or more Schemas.

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.getCatalogs() method.

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

• OlapConnection
  • Catalog
    • Schema
      • Cube
        • Dimension
          • Hierarchy
            • Level
              • Member
              • Property
        • NamedSet
      • Dimension (shared)

Since:

Oct 24, 2006

Author:

jhyde

Method Summary

OlapDatabaseMetaData	getMetaData() Retrieves the metadata describing the OLAP server that this Catalog belongs to.
String	getName() Returns the name of this Catalog.
NamedList<Schema>	getSchemas() Returns a list of Schema objects which belong to this Catalog.

Method Detail

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.

Throws:

OlapException - if error occurs

Returns:

List of Schema in this Catalog

See Also:

DatabaseMetaData.getSchemas()

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