org.pentaho.platform.plugin.action.mondrian.catalog
Interface IMondrianCatalogService

All Known Implementing Classes:

MondrianCatalogHelper

public interface IMondrianCatalogService

A service registering/enumerating registered Mondrian catalogs (schemas).

Author:

mlowery

Method Summary

void	addCatalog(MondrianCatalog catalog, boolean overwrite, IPentahoSession pentahoSession) Adds to the global catalog list and possibly persists this information.
MondrianCatalog	getCatalog(String name, IPentahoSession pentahoSession) Returns the catalog with the given name or null if name not recognized.
List<MondrianCatalog>	listCatalogs(IPentahoSession pentahoSession, boolean jndiOnly) Lists all catalogs (filtered according to access control rules).
MondrianSchema	loadMondrianSchema(String solutionLocation, IPentahoSession pentahoSession) this method loads a Mondrian schema

Method Detail

listCatalogs

List<MondrianCatalog> listCatalogs(IPentahoSession pentahoSession,
                                   boolean jndiOnly)

Lists all catalogs (filtered according to access control rules).

Parameters:

jndiOnly - return only JNDI-based catalogs

addCatalog

void addCatalog(MondrianCatalog catalog,
                boolean overwrite,
                IPentahoSession pentahoSession)
                throws MondrianCatalogServiceException

Adds to the global catalog list and possibly persists this information.

Parameters:

overwrite - true to overwrite existing catalog (based on match with definition and effectiveDataSourceInfo

Throws:

MondrianCatalogServiceException

getCatalog

MondrianCatalog getCatalog(String name,
                           IPentahoSession pentahoSession)

Returns the catalog with the given name or null if name not recognized.

Parameters:

name - of the catalog to fetch

loadMondrianSchema

MondrianSchema loadMondrianSchema(String solutionLocation,
                                  IPentahoSession pentahoSession)

this method loads a Mondrian schema

Parameters:

solutionLocation - location of the schema

pentahoSession - current session object

Returns:

Mondrian Schema object